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

Obter itens de documento da SEC

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

Financial Data

​

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

Financial Data Operações

Obter itens de documento da SEC

​

O texto completo dos itens numerados dentro de um documento da SEC. ticker, filing_type (10-K, 10-Q ou 8-K) e year são todos obrigatórios; restrinja mais com quarter, item, accession_number ou include_exhibits. Retorna items — cada um com number, title e o text completo —, além de filing_url e accession_number. Atenção ao tamanho: um 10-K volta como cerca de 19 itens de prosa completa, então peça um item específico em vez de puxar tudo, a menos que você realmente precise do documento inteiro. Para descobrir qual documento abrir, use get_financial_filings.

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.

Parâmetros de Consulta
  • accession_number
    Tipo: string

    O número de acesso do documento protocolado, se 8-K.

  • filing_type
    Tipo: string enum
    obrigatório

    O tipo de documento protocolado.

    valores
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Tipo: boolean

    Se deve incluir o texto bruto dos anexos vinculados. Aplicável apenas a documentos 8-K. Quando true, os objetos de anexo incluirão o campo 'text' com o conteúdo completo do anexo.

  • item
    Tipo: string enum

    O item a obter.

    valores
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Tipo: integer

    O trimestre do documento protocolado, se 10-Q.

  • ticker
    Tipo: string
    obrigatório

    O símbolo do ticker.

  • year
    Tipo: integer
    obrigatório

    O ano do documento protocolado.

Respostas
  • 200
    Tipo: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Resposta de itens do documento da SEC

    • accession_number
      Tipo: string

      O número de acesso do documento.

    • cik
      Tipo: string

      A Central Index Key (CIK) da empresa.

    • filing_type
      Tipo: string

      O tipo de documento protocolado.

    • items
      Tipo: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        Tipo: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        Uma matriz de anexos vinculados a este item. Presente apenas em documentos 8-K quando existem anexos.

        • description
          Tipo: string

          A descrição do anexo.

        • number
          Tipo: string

          O número do anexo (por exemplo, '99.1').

        • text
          Tipo: string

          O conteúdo de texto bruto do anexo. Incluído apenas quando o parâmetro 'include_exhibits' é definido como true.

        • url
          Tipo: string Formato: uri

          A URL do documento do anexo no site da SEC.

      • name
        Tipo: string

        O nome do item.

      • number
        Tipo: string

        O número do item.

      • text
        Tipo: string

        O texto do item.

    • quarter
      Tipo: integer

      O trimestre do documento.

    • resource
      Tipo: string

      O identificador do tipo de recurso.

    • ticker
      Tipo: string

      O símbolo do ticker da empresa.

    • year
      Tipo: integer

      O ano do documento protocolado.

    application/json
  • 202
    Tipo: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    O documento ainda está sendo preparado. Consulte o result_url do corpo da resposta para obter o resultado. Você não é cobrado por esta resposta.

    • accession_number
      Tipo: string

      O número de acesso do documento em preparação.

    • estimated_ready_at
      Tipo: string Formato: date-time

      Quando o documento deve estar pronto.

    • message
      Tipo: string

      Descrição legível do que fazer em seguida.

    • request_id
      Tipo: string Formato: uuid

      Identificador desta requisição; útil ao contatar o suporte.

    • result_url
      Tipo: string

      A URL para consultar o resultado.

    • status
      enum
      const:  
      processing

      Sempre 'processing' em uma resposta 202.

      valores
      • processing
    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 get/v1/beta/financial/filings/items
curl 'https://openapi.felo.ai/v1/beta/financial/filings/items?filing_type=10-K&ticker=&year=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "resource": "string",
  "ticker": "string",
  "cik": "string",
  "filing_type": "string",
  "accession_number": "string",
  "year": 1,
  "quarter": 1,
  "items": [
    {
      "number": "string",
      "name": "string",
      "text": "string",
      "exhibits": [
        {
          "number": "string",
          "description": "string",
          "url": "https://example.com",
          "text": "string"
        }
      ]
    }
  ]
}
Get SEC filing items