Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Search financial statements

服务器:https://openapi.felo.ai
客户端库

Financial Data

​

Company fundamentals, financial statements, market prices and economic data.

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.

请求体·SearchFiltersRequest
必填
application/json
  • filters
    类型: array object[] 1…
    必填

    An array of filter objects to apply to the search.

    • field
      类型: string
      必填

      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.

    • operator
      类型: string 枚举
      必填

      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.

      值
      • gt
      • lt
      • gte
      • lte
      • eq
      • in
    • value
      必填
      • 类型: number

        The value to compare against for single-value operators (gt, lt, gte, lte, eq)

  • currency
    类型: string 枚举

    The currency of the financial data.

    值
    • USD
    • EUR
    • GBP
    • JPY
    • CHF
    • AUD
    • CAD
    • SEK
  • historical
    类型: boolean

    Whether to return historical financial data.

  • limit
    类型: integer
    最小值:  
    1
    最大值:  
    100

    The maximum number of results to return.

  • order_by
    类型: string 枚举

    The field to order the results by. Use -field to order in descending order.

    值
    • ticker
    • -ticker
    • report_period
    • -report_period
  • period
    类型: string 枚举

    The time period for the financial data.

    值
    • annual
    • quarterly
    • ttm
响应
  • 200
    类型: object · FinancialsScreenerResponse

    Successful search response

    • results
      类型: array object[]

      Stocks matching the requested screener filters.

      • currency
        类型: string

        The currency of the financial data.

      • period
        类型: string 枚举

        The time period of the financial data.

        值
        • annual
        • quarterly
        • ttm
      • report_period
        类型: string 格式: date

        The reporting period of the financial data.

      • ticker
        类型: string

        The ticker symbol of the company.

      • propertyName
        类型: string

        Additional financial metrics based on the search criteria.

    application/json
  • 400
    类型: object · ErrorResponse

    Bad request

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 401
    类型: object · ErrorResponse

    Unauthorized

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 402
    类型: object · ErrorResponse

    The request requires a paid subscription

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 403

    The account is not permitted to perform this operation.

  • 404
    类型: object · ErrorResponse

    The specified resource was not found

    • error
      类型: string

      A short error message.

    • message
      类型: string

      A more detailed error message.

    application/json
  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/financial/financials/search/screener
curl https://openapi.felo.ai/v1/beta/financial/financials/search/screener \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "period": "ttm",
  "limit": 100,
  "order_by": "ticker",
  "currency": "USD",
  "historical": false,
  "filters": [
    {
      "field": "",
      "operator": "gt",
      "value": 1
    }
  ]
}'
{
  "results": [
    {
      "ticker": "string",
      "report_period": "2026-09-30",
      "period": "annual",
      "currency": "string",
      "additionalProperty": "string"
    }
  ]
}
Search financial statements