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

Obtener elementos de un documento de la SEC

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

Financial Data

​

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

Financial Data Operaciones

Obtener elementos de un documento de la SEC

​

El texto completo de los elementos numerados dentro de un documento de la SEC. ticker, filing_type (10-K, 10-Q u 8-K) y year son obligatorios; restringe más con quarter, item, accession_number o include_exhibits. Devuelve items — cada uno con number, title y el text completo —, además de filing_url y accession_number. Cuidado con el tamaño: un 10-K llega como unos 19 elementos de prosa completa, así que solicita un item concreto en lugar de traerlo todo, salvo que realmente necesites el documento entero. Para encontrar qué documento abrir, usa get_financial_filings.

Referencia de precios

  • Medición: base de costo fija por solicitud exitosa.
  • Estimación de referencia por solicitud: USD 0.02.
  • Multiplicador de referencia del cliente: 1.0. No lo apliques de nuevo a un importe de cliente ya liquidado.

Solo metadatos de referencia, no una cotización de la cuenta, un precio garantizado ni un límite de gasto. Los créditos de recursos no son créditos de Felo. Los cargos finales se rigen por los registros de facturación de Felo.

Parámetros de consulta
  • accession_number
    Tipo: string

    El número de acceso de la presentación, si es 8-K.

  • filing_type
    Tipo: string enum
    obligatorio

    El tipo de presentación.

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

    Si se incluye el texto sin formato de los anexos vinculados. Solo se aplica a las presentaciones 8-K. Cuando es true, los objetos de anexo incluirán el campo 'text' con el contenido completo del anexo.

  • item
    Tipo: string enum

    El elemento que se va a obtener.

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

    El trimestre de la presentación, si es 10-Q.

  • ticker
    Tipo: string
    obligatorio

    El símbolo del ticker.

  • year
    Tipo: integer
    obligatorio

    El año de la presentación.

Respuestas
  • 200
    Tipo: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Respuesta de elementos del documento de la SEC

    • accession_number
      Tipo: string

      El número de acceso del documento.

    • cik
      Tipo: string

      La Central Index Key (CIK) de la empresa.

    • filing_type
      Tipo: string

      El tipo de presentación.

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

        Un array de anexos vinculados a este elemento. Solo está presente en documentos 8-K cuando existen anexos.

        • description
          Tipo: string

          La descripción del anexo.

        • number
          Tipo: string

          El número del anexo (por ejemplo, '99.1').

        • text
          Tipo: string

          El contenido de texto sin procesar del anexo. Se incluye solo cuando el parámetro 'include_exhibits' se establece en true.

        • url
          Tipo: string Formato: uri

          La URL del documento del anexo en el sitio web de la SEC.

      • name
        Tipo: string

        El nombre del elemento.

      • number
        Tipo: string

        El número del elemento.

      • text
        Tipo: string

        El texto del elemento.

    • quarter
      Tipo: integer

      El trimestre del documento.

    • resource
      Tipo: string

      El identificador del tipo de recurso.

    • ticker
      Tipo: string

      El símbolo de ticker de la empresa.

    • year
      Tipo: integer

      El año de la presentación.

    application/json
  • 202
    Tipo: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    El documento aún se está preparando. Consulta el result_url del cuerpo de la respuesta para obtener el resultado. No se te cobra por esta respuesta.

    • accession_number
      Tipo: string

      El número de acceso del documento en preparación.

    • estimated_ready_at
      Tipo: string Formato: date-time

      Cuándo se espera que el documento esté listo.

    • message
      Tipo: string

      Descripción legible de qué hacer a continuación.

    • request_id
      Tipo: string Formato: uuid

      Identificador de esta solicitud; útil al contactar con el soporte.

    • result_url
      Tipo: string

      La URL para consultar el resultado.

    • status
      enum
      constante:  
      processing

      Siempre 'processing' en una respuesta 202.

      valores
      • processing
    application/json
  • 400

    No se pudo procesar la solicitud. Comprueba los parámetros de la solicitud.

  • 401

    Se requiere una clave de API de Felo válida.

  • 402

    La solicitud no puede continuar porque no se cumple un requisito de facturación.

  • 403

    La cuenta no tiene permiso para realizar esta operación.

  • 429

    Se ha alcanzado un límite de solicitudes o de gasto.

  • 502

    El servicio no pudo completar la solicitud.

  • 503

    La API o el servicio de facturación no están disponibles temporalmente.

  • 504

    El servicio agotó el tiempo de espera al procesar la solicitud.

  • default

    Respuesta de error; las respuestas de paso del upstream pueden usar formatos del proveedor

    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