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

Search specific financial metrics

Сервер:https://openapi.felo.ai
Клиентские библиотеки

Financial Data

​

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

Search specific financial metrics

​

Pull named financial line items across one or more companies in a single call. Body takes tickers and line_items (both required, both arrays), plus period (annual, quarterly or ttm) and limit. Returns search_results with one row per ticker and period carrying only the fields you asked for, alongside report_period, period and currency. Use it to build a comparison table without pulling three full statements per company. The item names are the same field names the statement tools return, so look one up there first if unsure. For everything about a single company use get_financial_financials.

Тело·SearchLineItemsRequest
обязательно
application/json
  • line_items
    Тип: array string[] 1…
    обязательно

    An array of line items to apply to the search.

  • tickers
    Тип: array string[] 1…
    обязательно

    An array of tickers to apply to the search.

  • limit
    Тип: integer
    мин.:  
    1

    The maximum number of results to return.

  • period
    Тип: string enum

    The time period for the financial data.

    значения
    • annual
    • quarterly
    • ttm
Ответы
  • 200
    Тип: object · FinancialsSearchResponse

    Successful search response

    • search_results
      Тип: array object[]
      • currency
        Тип: string

        The currency of the financial data.

      • period
        Тип: string enum

        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/line-items
curl https://openapi.felo.ai/v1/beta/financial/financials/search/line-items \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "line_items": [
    ""
  ],
  "tickers": [
    ""
  ],
  "period": "ttm",
  "limit": 1
}'
{
  "search_results": [
    {
      "ticker": "string",
      "report_period": "2026-09-30",
      "period": "annual",
      "currency": "string",
      "additionalProperty": "string"
    }
  ]
}
Search specific financial metrics