Felo API PlatformFelo API Platform
Todos os endpoints de Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Pesquisar demonstrações financeiras

Servidor:https://openapi.felo.ai
Bibliotecas Cliente

Financial Data

​

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

Pesquisar demonstrações financeiras

​

Encontra tickers que correspondem a condições numéricas. O corpo recebe filters — cada um com field, operator e value —, além de limit. Retorna results com ticker, currency, sector, industry e o campo filtrado que correspondeu. Esta é a única ferramenta aqui que funciona sem saber um ticker de antemão; todas as outras recebem um como entrada. Os campos filtráveis são os nomes de métrica que get_financial_financial_metrics retorna. Use para montar uma lista de candidatos e depois detalhar cada nome com as ferramentas de demonstração ou de métricas.

Referência de preços

  • Medição: base de custo fixa por requisição bem-sucedida.
  • Estimativa de referência por requisição: USD 0.02.
  • Multiplicador de referência do cliente: 1.0. Não o aplique novamente a um valor de cliente já liquidado.

Apenas metadados de referência, não uma cotação da conta, um preço garantido ou um limite de gastos. Créditos de recursos não são créditos Felo. As cobranças finais seguem os registros de cobrança da Felo.

Corpo
obrigatório
application/json
  • filters
    Tipo: array object[] 1…
    obrigatório

    Um array de objetos de filtro a aplicar à pesquisa.

    • field
      Tipo: string
      obrigatório

      Os critérios para filtrar. Para campos de métrica financeira, use os operadores 'gt', 'lt', 'gte', 'lte' e 'eq'. Para campos 'ticker' e 'cik', use o operador 'in' para filtrar por vários valores.

    • operator
      Tipo: string enum
      obrigatório

      O operador de comparação. O operador 'in' só pode ser usado com um valor de campo 'ticker' ou 'cik' e permite filtrar por vários valores.

      valores
      • gt
      • lt
      • gte
      • lte
      • eq
      • in
    • value
      obrigatório
      • Tipo: number

        O valor de comparação para operadores de valor único (gt, lt, gte, lte, eq)

  • limit
    Tipo: integer
    mín:  
    1

    O número máximo de resultados a retornar.

Respostas
  • 200
    Tipo: object · ResponseE40Feb4D3D6B_FinancialsSearchResponse

    Resposta de pesquisa bem-sucedida

    • search_results
      Tipo: array object[]
      • currency
        Tipo: string

        A moeda dos dados financeiros.

      • period
        Tipo: string enum

        O período dos dados financeiros.

        valores
        • annual
        • quarterly
        • ttm
      • report_period
        Tipo: string Formato: date

        O período de referência dos dados financeiros.

      • ticker
        Tipo: string

        O símbolo do ticker da empresa.

      • propertyName
        Tipo: string

        Métricas financeiras adicionais com base nos critérios de pesquisa.

    application/json
  • 400

    Não foi possível processar a requisição. Verifique os parâmetros da requisição.

  • 401

    É necessária uma chave de API da Felo válida.

  • 402

    A requisição não pode prosseguir porque um requisito de cobrança não foi atendido.

  • 403

    A conta não tem permissão para realizar esta operação.

  • 429

    Um limite de requisições ou de gastos foi atingido.

  • 502

    O serviço não pôde concluir a requisição.

  • 503

    A API ou o serviço de cobrança está temporariamente indisponível.

  • 504

    O serviço atingiu o tempo limite ao processar a requisição.

  • default

    Resposta de erro; respostas repassadas do upstream podem usar formatos do provedor

    application/json
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 '{
  "limit": 10,
  "filters": [
    {
      "field": "",
      "operator": "gt",
      "value": 1
    }
  ]
}'
{
  "search_results": [
    {
      "ticker": "string",
      "report_period": "2026-10-26",
      "period": "annual",
      "currency": "string",
      "additionalProperty": "string"
    }
  ]
}
Search financial statements