Data API / Financial Data / Financials

Search financial statements

Find tickers that match numeric conditions. Body takes filters — each a field, an operator and a value — plus limit. Returns results with ticker, currency, sector, industry and whichever filtered field was matched. This is the only tool here that works without knowing a ticker in advance; everything else takes one as input. Filterable fields are the metric names get_financial_financial_metrics returns. Use it to build a candidate list, then pull detail on each name with the statement or metric tools.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

periodstringНеобязательный
Допустимые значения: annual · quarterly · ttm
The time period for the financial data.
limitintegerНеобязательный
The maximum number of results to return.
order_bystringНеобязательный
Допустимые значения: ticker · -ticker · report_period · -report_period
The field to order the results by. Use -field to order in descending order.
currencystringНеобязательный
Допустимые значения: USD · EUR · GBP · JPY · CHF · AUD · CAD · SEK
The currency of the financial data.
historicalbooleanНеобязательный
Whether to return historical financial data.
filtersobject[]Обязательный
An array of filter objects to apply to the search.
fieldstringОбязательный
The criteria to filter on. For financial metric fields, use 'gt', 'lt', 'gte', 'lte', 'eq' operators. For 'ticker' and 'cik' fields, use the 'in' operator to filter against multiple values.
operatorstringОбязательный
Допустимые значения: gt · lt · gte · lte · eq · in
The comparison operator. The 'in' operator can only be used with a field value of 'ticker' or 'cik' and lets you filter against multiple values.
valueОбязательный

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/financial/financials/search/screener" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "filters": [
    {}
  ],
  "period": "<string>",
  "limit": 0,
  "order_by": "<string>",
  "currency": "<string>",
  "historical": false
}'

Ответ

Поля ответа

resultsobject[]Необязательный
Stocks matching the requested screener filters.
tickerstringНеобязательный
The ticker symbol of the company.
report_periodstringНеобязательный
The reporting period of the financial data.
periodstringНеобязательный
Допустимые значения: annual · quarterly · ttm
The time period of the financial data.
currencystringНеобязательный
The currency of the financial data.