Felo API PlatformFelo API Platform

데이터 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.