資料 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.