Reference

Stock Screener

POST/v2/reference/screener

Filter securities by financial metrics, profile attributes, valuation multiples, stability ratios, ESG scores, and more. All query conditions are combined with AND. Results include the requested metric values alongside each security's symbol, name, and ISIN.

Included in: Growth.

Authentication

Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key · Authentication guide

Parameters

This route takes no path or query parameters.

Try it

JSON body

POST /v2/reference/screener

API key

Sent only to api.bavest.co for this request; not stored.

Sign in to send Get an API keySends with the key above, or sign in to use your account's key. Each request counts as one API call.

curl -X POST 'https://api.bavest.co/v2/reference/screener' \
  -H "x-api-key: $BAVEST_API_KEY" \
  -H 'content-type: application/json' \
  --data '{"query":[{"metric":"returnOnEquity","operator":"gte","value":10},{"metric":"sector","operator":"eq","value":"Technology"},{"metric":"marketCapitalization","operator":"gte","value":1000000000}],"sort":[{"metric":"marketCapitalization","order":"desc"}],"offset":0,"limit":10}'

Samples read your key from BAVEST_API_KEY and follow the form.

Example response 200

{
  "data": [
    {
      "symbol": "ASAN",
      "name": "Asana, Inc.",
      "isin": "US04342Y1047",
      "marketCapitalization": 2083961217,
      "returnOnEquity": 16.5541,
      "sector": "Technology"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalCount": 1,
    "parameters": {
      "query": [
        {
          "metric": "returnOnEquity",
          "operator": "gte",
          "value": 10
        },
        {
          "metric": "sector",
          "operator": "eq",
          "value": "Technology"
        }
      ],
      "sort": [
        {
          "metric": "marketCapitalization",
          "order": "desc"
        }
      ],
      "offset": 0,
      "limit": 10
    },
    "time": 447
  }
}

From the docs, not your data. Long lists are cut to 3 items.

Request body

queryarray of ScreenerFilterItemrequired
List of filter conditions. All conditions are combined with AND logic. Each item specifies a metric, comparison operator, and threshold value.
- metricstringrequired
  Short name for a screener metric. Resolved internally to an Elasticsearch field path. Alternatively, pass a raw dot-notation ES path directly (e.g., profile.marketCapitalization).
  
  | Metric | Category | ES Path | Description | |---|---|---|---| | name | Profile | profile.name | Company name | | symbol | Profile | profile.symbol | Ticker symbol | | isin | Profile | profile.isin | ISIN identifier | | stockExchange | Profile | profile.exchangeShortName | Primary listing exchange | | employeeTotal | Profile | profile.employeeTotal | Total number of employees | | marketCapitalization | Profile | profile.marketCapitalization | Market cap (value x1 transform) | | country | Profile | profile.country | Country of domicile | | beta | Profile | profile.beta | Beta coefficient | | industry | Profile | profile.industry | Industry classification | | sector | Profile | profile.sector | GICS sector | | price | Profile | profile.price | Current stock price | | isReit | Profile | profile.isReit | REIT flag (boolean): FMP industry starts with "REIT", e.g. "REIT - Retail" | | retainedEarnings | Balance | balance.retainedEarnings | Accumulated retained earnings | | totalAssets | Balance | balance.totalAssets | Total assets | | currentAssets | Balance | balance.currentAssets | Current assets | | fixedAssets | Balance | balance.fixedAssets | Fixed (non-current) assets | | totalCurrentLiabilities | Balance | balance.totalCurrentLiabilities | Total current liabilities | | totalNonCurrentLiabilities | Balance | balance.totalNonCurrentLiabilities | Total non-current liabilities | | longTermDebt | Balance | balance.longTermDebt | Long-term debt | | totalLiabilities | Balance | balance.totalLiabilities | Total liabilities | | totalEquity | Balance | balance.totalEquity | Total shareholders' equity | | liabilitiesAndEquity | Balance | balance.liabilitiesAndEquity | Liabilities plus equity | | operatingCashFlow | Cash flow | cashflow.operatingCashFlow | Operating cash flow | | investingCashFlow | Cash flow | cashflow.investingCashFlow | Investing cash flow | | financingCashFlow | Cash flow | cashflow.financingCashFlow | Financing cash flow | | capitalExpenditure | Cash flow | cashflow.capitalExpenditure | Capital expenditure | | freeCashFlow | Cash flow | cashflow.freeCashFlow | Free cash flow | | netIncomeAfterTaxes | Income | income.netIncomeAfterTaxes | Net income after taxes | | totalRevenue | Income | income.totalRevenue | Total revenue | | grossIncome | Income | income.grossIncome | Gross income | | ebit | Income | income.ebit | Earnings before interest and taxes | | pretaxIncome | Income | income.pretaxIncome | Pre-tax income | | ebitda | Income | income.ebitda | EBITDA | | eps | Income | income.eps | Earnings per share | | stockPrice | Quote | quote.stockPrice | Current stock price (quote) | | shareOutstanding | Quote | quote.shareOutstanding | Shares outstanding | | c | Quote | quote.c | Current price | | dp | Quote | quote.dp | Daily price change (%) | | environmentScore | ESG | esg.environmentScore | Environmental ESG score | | governanceScore | ESG | esg.governanceScore | Governance ESG score | | socialScore | ESG | esg.socialScore | Social ESG score | | totalESGScore | ESG | esg.totalESGScore | Combined ESG score | | dividendPerShare | Metrics | metric.dividendPerShare | Dividend per share | | dividendPerShareAnnual | Metrics | metric.dividendPerShare | Dividend per share (annual, alias) | | 5DayPriceReturnDaily | Metrics | metric.5DayPriceReturnDaily | 5-day price return | | 13WeekPriceReturnDaily | Metrics | metric.13WeekPriceReturnDaily | 13-week price return | | 26WeekPriceReturnDaily | Metrics | metric.26WeekPriceReturnDaily | 26-week price return | | 52WeekPriceReturnDaily | Metrics | metric.1yearPriceReturnDaily | 52-week price return | | roaRfy | Metrics | metric.roaRfy | Return on assets (RFY) | | bookValuePerShareAnnual | Metrics | metric.bookValuePerShareAnnual | Book value per share (annual) | | cashFlowPerShareAnnual | Metrics | metric.cashFlowPerShareAnnual | Cash flow per share (annual) | | dividendYield5Y | Metrics | metric.dividendYield5Y | 5-year average dividend yield | | dividendGrowthRate5Y | Metrics | metric.dividendGrowthRate5Y | 5-year dividend growth rate | | epsGrowth3Y | Metrics | metric.epsGrowth3Y | 3-year EPS growth | | epsGrowth5Y | Metrics | metric.epsGrowth5Y | 5-year EPS growth | | capitalSpendingGrowth5Y | Metrics | metric.capitalSpendingGrowth5Y | 5-year capex growth | | currentEv/freeCashFlowAnnual | Metrics | metric.currentEv/freeCashFlowAnnual | EV / FCF (annual) | | currentEv/freeCashFlowTTM | Metrics | metric.currentEv/freeCashFlowTTM | EV / FCF (TTM) | | revenueEmployeeAnnual | Metrics | metric.revenueEmployeeAnnual | Revenue per employee (annual) | | revenueEmployeeTTM | Metrics | metric.revenueEmployeeTTM | Revenue per employee (TTM) | | revenueGrowth3Y | Metrics | metric.revenueGrowth3Y | 3-year revenue growth | | revenuePerShareAnnual | Metrics | metric.revenuePerShareAnnual | Revenue per share (annual) | | revenuePerShareTTM | Metrics | metric.revenuePerShareTTM | Revenue per share (TTM) | | revenueShareGrowth5Y | Metrics | metric.revenueShareGrowth5Y | 5-year revenue share growth | | payoutRatioAnnual | Metrics | metric.payoutRatioAnnual | Payout ratio (annual) | | payoutRatioTTM | Metrics | metric.payoutRatioTTM | Payout ratio (TTM) | | performance | Metrics | metric.performance | Overall performance score | | priceEarningsRatio | Multiples | fundamentals.multiples.priceEarningsRatio | P/E ratio | | priceBookRatio | Multiples | fundamentals.multiples.priceBookRatio | P/B ratio | | priceCashflowRatio | Multiples | fundamentals.multiples.priceCashflowRatio | P/CF ratio | | priceSalesRatio | Multiples | fundamentals.multiples.priceSalesRatio | P/S ratio | | ev/ebitda | Multiples | fundamentals.multiples.ev/ebitda | EV / EBITDA | | ev/ebit | Multiples | fundamentals.multiples.ev/ebit | EV / EBIT | | ev/fcf | Multiples | fundamentals.multiples.ev/fcf | EV / Free Cash Flow | | ev | Multiples | fundamentals.multiples.ev | Enterprise value | | ev/revenue | Multiples | fundamentals.multiples.ev/revenue | EV / Revenue | | propertyPlantEquipment | Multiples | fundamentals.multiples.fixedAssetsIntensity | Fixed assets intensity (PP&E proxy) | | ev/sales | Multiples | fundamentals.multiples.ev/sales | EV / Sales | | equityRatio | Stability | fundamentals.stability.equityRatio | Equity ratio | | debtRatio | Stability | fundamentals.stability.debtRatio | Total liabilities / total assets. Not total debt: debt_to_assets in financials.metrics is total debt / total assets | | debtToEquityRatio | Stability | fundamentals.stability.debtToEquityRatio | Total liabilities / total equity. Not total debt: debt_to_equity in financials.metrics is total debt / total equity. Negative for negative equity, where debt_to_equity is null | | dynamicLeverage | Stability | fundamentals.stability.dynamicLeverage | Dynamic leverage ratio | | cataRatio | Stability | fundamentals.stability.cataRatio | Current assets to total assets | | currentRatio | Stability | fundamentals.stability.currentRatio | Current ratio | | fixedAssetIntensity | Stability | fundamentals.stability.fixedAssetIntensity | Fixed asset intensity | | ppeRatio | Stability | fundamentals.stability.ppeRatio | PP&E ratio | | assetCoverage1 | Stability | fundamentals.stability.assetCoverage1 | Asset coverage ratio (tier 1) | | assetCoverage2 | Stability | fundamentals.stability.assetCoverage2 | Asset coverage ratio (tier 2) | | cashRatio | Stability | fundamentals.stability.cashRatio | Cash ratio | | quickRatio | Stability | fundamentals.stability.quickRatio | Quick ratio | | returnOnEquity | Profitability | fundamentals.revenue.equityReturn | Return on equity (ROE) | | salesReturn | Profitability | fundamentals.revenue.salesReturn | Return on sales | | ebitMargin | Profitability | fundamentals.revenue.ebitMargin | EBIT margin | | ebitdaMargin | Profitability | fundamentals.revenue.ebitdaMargin | EBITDA margin | | capitalTurnover | Profitability | fundamentals.revenue.capitalTurnover | Capital turnover | | assetsReturn | Profitability | fundamentals.revenue.assetsReturn | Return on assets | | fundamentalScore | Scores | score.fundamentalScore | Fundamental analysis score | | totalScore | Scores | score.totalScore | Composite total score | | sentimentScore | Scores | score.sentimentScore | Market sentiment score |
  One of name symbol isin stockExchange employeeTotal marketCapitalization country beta industry sector price isReit retainedEarnings totalAssets currentAssets fixedAssets totalCurrentLiabilities totalNonCurrentLiabilities longTermDebt totalLiabilities totalEquity liabilitiesAndEquity operatingCashFlow investingCashFlow financingCashFlow capitalExpenditure freeCashFlow netIncomeAfterTaxes totalRevenue grossIncome ebit pretaxIncome ebitda eps stockPrice shareOutstanding c dp environmentScore governanceScore socialScore totalESGScore dividendPerShare dividendPerShareAnnual 5DayPriceReturnDaily 13WeekPriceReturnDaily 26WeekPriceReturnDaily 52WeekPriceReturnDaily roaRfy bookValuePerShareAnnual cashFlowPerShareAnnual dividendYield5Y dividendGrowthRate5Y epsGrowth3Y epsGrowth5Y capitalSpendingGrowth5Y currentEv/freeCashFlowAnnual currentEv/freeCashFlowTTM revenueEmployeeAnnual revenueEmployeeTTM revenueGrowth3Y revenuePerShareAnnual revenuePerShareTTM revenueShareGrowth5Y payoutRatioAnnual payoutRatioTTM performance priceEarningsRatio priceBookRatio priceCashflowRatio priceSalesRatio ev/ebitda ev/ebit ev/fcf ev ev/revenue propertyPlantEquipment ev/sales equityRatio debtRatio debtToEquityRatio dynamicLeverage cataRatio currentRatio fixedAssetIntensity ppeRatio assetCoverage1 assetCoverage2 cashRatio quickRatio returnOnEquity salesReturn ebitMargin ebitdaMargin capitalTurnover assetsReturn fundamentalScore totalScore sentimentScore
  Example returnOnEquity
- operatorstringrequired
  Comparison operator. Use eq for exact string matches (e.g., sector, country). Numeric operators (lt, gt, gte, lte) for numeric fields.
  One of lt gt gte lte eq
  Example gte
- valuenumber | string | booleanrequired
  The value to compare against. Use a number for numeric metrics, a string for text fields (sector, country, industry, name, symbol) and a boolean for flags (isReit, with operator eq).
  Example 10
sortarray of ScreenerSortItem
Optional list of sort criteria applied in order. When omitted results are returned in default Elasticsearch relevance order.
- metricstringrequired
  Short name for a screener metric. Resolved internally to an Elasticsearch field path. Alternatively, pass a raw dot-notation ES path directly (e.g., profile.marketCapitalization).
  
  | Metric | Category | ES Path | Description | |---|---|---|---| | name | Profile | profile.name | Company name | | symbol | Profile | profile.symbol | Ticker symbol | | isin | Profile | profile.isin | ISIN identifier | | stockExchange | Profile | profile.exchangeShortName | Primary listing exchange | | employeeTotal | Profile | profile.employeeTotal | Total number of employees | | marketCapitalization | Profile | profile.marketCapitalization | Market cap (value x1 transform) | | country | Profile | profile.country | Country of domicile | | beta | Profile | profile.beta | Beta coefficient | | industry | Profile | profile.industry | Industry classification | | sector | Profile | profile.sector | GICS sector | | price | Profile | profile.price | Current stock price | | isReit | Profile | profile.isReit | REIT flag (boolean): FMP industry starts with "REIT", e.g. "REIT - Retail" | | retainedEarnings | Balance | balance.retainedEarnings | Accumulated retained earnings | | totalAssets | Balance | balance.totalAssets | Total assets | | currentAssets | Balance | balance.currentAssets | Current assets | | fixedAssets | Balance | balance.fixedAssets | Fixed (non-current) assets | | totalCurrentLiabilities | Balance | balance.totalCurrentLiabilities | Total current liabilities | | totalNonCurrentLiabilities | Balance | balance.totalNonCurrentLiabilities | Total non-current liabilities | | longTermDebt | Balance | balance.longTermDebt | Long-term debt | | totalLiabilities | Balance | balance.totalLiabilities | Total liabilities | | totalEquity | Balance | balance.totalEquity | Total shareholders' equity | | liabilitiesAndEquity | Balance | balance.liabilitiesAndEquity | Liabilities plus equity | | operatingCashFlow | Cash flow | cashflow.operatingCashFlow | Operating cash flow | | investingCashFlow | Cash flow | cashflow.investingCashFlow | Investing cash flow | | financingCashFlow | Cash flow | cashflow.financingCashFlow | Financing cash flow | | capitalExpenditure | Cash flow | cashflow.capitalExpenditure | Capital expenditure | | freeCashFlow | Cash flow | cashflow.freeCashFlow | Free cash flow | | netIncomeAfterTaxes | Income | income.netIncomeAfterTaxes | Net income after taxes | | totalRevenue | Income | income.totalRevenue | Total revenue | | grossIncome | Income | income.grossIncome | Gross income | | ebit | Income | income.ebit | Earnings before interest and taxes | | pretaxIncome | Income | income.pretaxIncome | Pre-tax income | | ebitda | Income | income.ebitda | EBITDA | | eps | Income | income.eps | Earnings per share | | stockPrice | Quote | quote.stockPrice | Current stock price (quote) | | shareOutstanding | Quote | quote.shareOutstanding | Shares outstanding | | c | Quote | quote.c | Current price | | dp | Quote | quote.dp | Daily price change (%) | | environmentScore | ESG | esg.environmentScore | Environmental ESG score | | governanceScore | ESG | esg.governanceScore | Governance ESG score | | socialScore | ESG | esg.socialScore | Social ESG score | | totalESGScore | ESG | esg.totalESGScore | Combined ESG score | | dividendPerShare | Metrics | metric.dividendPerShare | Dividend per share | | dividendPerShareAnnual | Metrics | metric.dividendPerShare | Dividend per share (annual, alias) | | 5DayPriceReturnDaily | Metrics | metric.5DayPriceReturnDaily | 5-day price return | | 13WeekPriceReturnDaily | Metrics | metric.13WeekPriceReturnDaily | 13-week price return | | 26WeekPriceReturnDaily | Metrics | metric.26WeekPriceReturnDaily | 26-week price return | | 52WeekPriceReturnDaily | Metrics | metric.1yearPriceReturnDaily | 52-week price return | | roaRfy | Metrics | metric.roaRfy | Return on assets (RFY) | | bookValuePerShareAnnual | Metrics | metric.bookValuePerShareAnnual | Book value per share (annual) | | cashFlowPerShareAnnual | Metrics | metric.cashFlowPerShareAnnual | Cash flow per share (annual) | | dividendYield5Y | Metrics | metric.dividendYield5Y | 5-year average dividend yield | | dividendGrowthRate5Y | Metrics | metric.dividendGrowthRate5Y | 5-year dividend growth rate | | epsGrowth3Y | Metrics | metric.epsGrowth3Y | 3-year EPS growth | | epsGrowth5Y | Metrics | metric.epsGrowth5Y | 5-year EPS growth | | capitalSpendingGrowth5Y | Metrics | metric.capitalSpendingGrowth5Y | 5-year capex growth | | currentEv/freeCashFlowAnnual | Metrics | metric.currentEv/freeCashFlowAnnual | EV / FCF (annual) | | currentEv/freeCashFlowTTM | Metrics | metric.currentEv/freeCashFlowTTM | EV / FCF (TTM) | | revenueEmployeeAnnual | Metrics | metric.revenueEmployeeAnnual | Revenue per employee (annual) | | revenueEmployeeTTM | Metrics | metric.revenueEmployeeTTM | Revenue per employee (TTM) | | revenueGrowth3Y | Metrics | metric.revenueGrowth3Y | 3-year revenue growth | | revenuePerShareAnnual | Metrics | metric.revenuePerShareAnnual | Revenue per share (annual) | | revenuePerShareTTM | Metrics | metric.revenuePerShareTTM | Revenue per share (TTM) | | revenueShareGrowth5Y | Metrics | metric.revenueShareGrowth5Y | 5-year revenue share growth | | payoutRatioAnnual | Metrics | metric.payoutRatioAnnual | Payout ratio (annual) | | payoutRatioTTM | Metrics | metric.payoutRatioTTM | Payout ratio (TTM) | | performance | Metrics | metric.performance | Overall performance score | | priceEarningsRatio | Multiples | fundamentals.multiples.priceEarningsRatio | P/E ratio | | priceBookRatio | Multiples | fundamentals.multiples.priceBookRatio | P/B ratio | | priceCashflowRatio | Multiples | fundamentals.multiples.priceCashflowRatio | P/CF ratio | | priceSalesRatio | Multiples | fundamentals.multiples.priceSalesRatio | P/S ratio | | ev/ebitda | Multiples | fundamentals.multiples.ev/ebitda | EV / EBITDA | | ev/ebit | Multiples | fundamentals.multiples.ev/ebit | EV / EBIT | | ev/fcf | Multiples | fundamentals.multiples.ev/fcf | EV / Free Cash Flow | | ev | Multiples | fundamentals.multiples.ev | Enterprise value | | ev/revenue | Multiples | fundamentals.multiples.ev/revenue | EV / Revenue | | propertyPlantEquipment | Multiples | fundamentals.multiples.fixedAssetsIntensity | Fixed assets intensity (PP&E proxy) | | ev/sales | Multiples | fundamentals.multiples.ev/sales | EV / Sales | | equityRatio | Stability | fundamentals.stability.equityRatio | Equity ratio | | debtRatio | Stability | fundamentals.stability.debtRatio | Total liabilities / total assets. Not total debt: debt_to_assets in financials.metrics is total debt / total assets | | debtToEquityRatio | Stability | fundamentals.stability.debtToEquityRatio | Total liabilities / total equity. Not total debt: debt_to_equity in financials.metrics is total debt / total equity. Negative for negative equity, where debt_to_equity is null | | dynamicLeverage | Stability | fundamentals.stability.dynamicLeverage | Dynamic leverage ratio | | cataRatio | Stability | fundamentals.stability.cataRatio | Current assets to total assets | | currentRatio | Stability | fundamentals.stability.currentRatio | Current ratio | | fixedAssetIntensity | Stability | fundamentals.stability.fixedAssetIntensity | Fixed asset intensity | | ppeRatio | Stability | fundamentals.stability.ppeRatio | PP&E ratio | | assetCoverage1 | Stability | fundamentals.stability.assetCoverage1 | Asset coverage ratio (tier 1) | | assetCoverage2 | Stability | fundamentals.stability.assetCoverage2 | Asset coverage ratio (tier 2) | | cashRatio | Stability | fundamentals.stability.cashRatio | Cash ratio | | quickRatio | Stability | fundamentals.stability.quickRatio | Quick ratio | | returnOnEquity | Profitability | fundamentals.revenue.equityReturn | Return on equity (ROE) | | salesReturn | Profitability | fundamentals.revenue.salesReturn | Return on sales | | ebitMargin | Profitability | fundamentals.revenue.ebitMargin | EBIT margin | | ebitdaMargin | Profitability | fundamentals.revenue.ebitdaMargin | EBITDA margin | | capitalTurnover | Profitability | fundamentals.revenue.capitalTurnover | Capital turnover | | assetsReturn | Profitability | fundamentals.revenue.assetsReturn | Return on assets | | fundamentalScore | Scores | score.fundamentalScore | Fundamental analysis score | | totalScore | Scores | score.totalScore | Composite total score | | sentimentScore | Scores | score.sentimentScore | Market sentiment score |
  One of name symbol isin stockExchange employeeTotal marketCapitalization country beta industry sector price isReit retainedEarnings totalAssets currentAssets fixedAssets totalCurrentLiabilities totalNonCurrentLiabilities longTermDebt totalLiabilities totalEquity liabilitiesAndEquity operatingCashFlow investingCashFlow financingCashFlow capitalExpenditure freeCashFlow netIncomeAfterTaxes totalRevenue grossIncome ebit pretaxIncome ebitda eps stockPrice shareOutstanding c dp environmentScore governanceScore socialScore totalESGScore dividendPerShare dividendPerShareAnnual 5DayPriceReturnDaily 13WeekPriceReturnDaily 26WeekPriceReturnDaily 52WeekPriceReturnDaily roaRfy bookValuePerShareAnnual cashFlowPerShareAnnual dividendYield5Y dividendGrowthRate5Y epsGrowth3Y epsGrowth5Y capitalSpendingGrowth5Y currentEv/freeCashFlowAnnual currentEv/freeCashFlowTTM revenueEmployeeAnnual revenueEmployeeTTM revenueGrowth3Y revenuePerShareAnnual revenuePerShareTTM revenueShareGrowth5Y payoutRatioAnnual payoutRatioTTM performance priceEarningsRatio priceBookRatio priceCashflowRatio priceSalesRatio ev/ebitda ev/ebit ev/fcf ev ev/revenue propertyPlantEquipment ev/sales equityRatio debtRatio debtToEquityRatio dynamicLeverage cataRatio currentRatio fixedAssetIntensity ppeRatio assetCoverage1 assetCoverage2 cashRatio quickRatio returnOnEquity salesReturn ebitMargin ebitdaMargin capitalTurnover assetsReturn fundamentalScore totalScore sentimentScore
  Example returnOnEquity
- orderstringrequired
  Sort direction.
  One of asc desc
  Example desc
offsetinteger
Pagination offset (number of results to skip).
Example 0
limitinteger
Maximum number of results to return.
Example 10
currencystring
Target currency for value conversion. When set, monetary metric values are converted to this currency.
Example EUR

Response 200

Successful response · application/json

dataarray of ScreenerResult
- symbolstringrequired
  Ticker symbol.
  Example AAPL
- namestringrequired
  Company name.
  Example Apple Inc
- isinstringrequired
  ISIN identifier.
  Example US0378331005
metaResponseMeta
Response metadata for paginated endpoints. Offset pagination returns page/pageSize/totalPages/totalCount; cursor pagination returns pageSize/hasMore/nextCursor and totalCount only when known.
- timeinteger
  Server-side processing time in milliseconds
  Example 17
- parametersobject
  Echo of the request parameters the endpoint resolved
- pageinteger
  Current page number (offset pagination)
  Example 1
- pageSizeinteger
  Number of results per page
  Example 50
- totalPagesinteger
  Total number of pages (offset pagination)
  Example 2
- totalCountinteger
  Total number of results across all pages
  Example 100
- hasMoreboolean
  Whether more results follow (cursor pagination)
- nextCursorstring | null
  Cursor for the next page (cursor pagination), null on the last page

Errors

400Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
401Missing or invalid API key.
404Resource not found.
429Rate limit exceeded. Retry after the `Retry-After` header interval.
500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.