Felo API PlatformFelo API Platform
Tous les endpoints Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Obtenir les éléments d'un document SEC

Serveur:https://openapi.felo.ai
Bibliothèques clientes

Financial Data

​

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

Financial Data Opérations

Obtenir les éléments d'un document SEC

​

Le texte intégral des éléments numérotés d'un document SEC. ticker, filing_type (10-K, 10-Q ou 8-K) et year sont tous obligatoires ; affinez avec quarter, item, accession_number ou include_exhibits. Renvoie items — chacun avec number, title et le text complet —, plus filing_url et accession_number. Attention à la taille : un 10-K revient sous la forme d'environ 19 éléments de prose complète, donc demandez un item précis plutôt que tout extraire, sauf si vous avez vraiment besoin du document entier. Pour trouver quel document ouvrir, utilisez get_financial_filings.

Référence tarifaire

  • Mesure : base de coût fixe par requête réussie.
  • Estimation de référence par requête : USD 0.02.
  • Multiplicateur client de référence : 1.0. Ne pas l'appliquer à nouveau à un montant client déjà réglé.

Métadonnées de référence uniquement, et non un devis de compte, un prix garanti ou un plafond de dépenses. Les crédits de ressources ne sont pas des crédits Felo. Les débits définitifs suivent les enregistrements de facturation Felo.

Paramètres de requête
  • accession_number
    Type: string

    Le numéro d'accès du dépôt s'il s'agit d'un 8-K.

  • filing_type
    Type: string enum
    obligatoire

    Le type de dépôt.

    valeurs
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Type: boolean

    Indique si le texte brut des pièces jointes liées doit être inclus. Applicable uniquement aux dépôts 8-K. Lorsque la valeur est true, les objets de pièce jointe incluront le champ 'text' contenant le contenu complet de la pièce jointe.

  • item
    Type: string enum

    L'élément à récupérer.

    valeurs
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Type: integer

    Le trimestre du dépôt s'il s'agit d'un 10-Q.

  • ticker
    Type: string
    obligatoire

    Le symbole boursier.

  • year
    Type: integer
    obligatoire

    L'année du dépôt.

Réponses
  • 200
    Type: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Réponse d'éléments de document SEC

    • accession_number
      Type: string

      Le numéro d'accession du document.

    • cik
      Type: string

      La Central Index Key (CIK) de la société.

    • filing_type
      Type: string

      Le type de dépôt.

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

        Un tableau d'annexes liées à cet élément. Présent uniquement pour les documents 8-K lorsque des annexes existent.

        • description
          Type: string

          La description de l'annexe.

        • number
          Type: string

          Le numéro de l'annexe (par exemple '99.1').

        • text
          Type: string

          Le contenu textuel brut de l'annexe. Inclus uniquement lorsque le paramètre 'include_exhibits' est défini sur true.

        • url
          Type: string Format: uri

          L'URL du document de l'annexe sur le site de la SEC.

      • name
        Type: string

        Le nom de l'élément.

      • number
        Type: string

        Le numéro de l'élément.

      • text
        Type: string

        Le texte de l'élément.

    • quarter
      Type: integer

      Le trimestre du document.

    • resource
      Type: string

      L'identifiant du type de ressource.

    • ticker
      Type: string

      Le symbole ticker de la société.

    • year
      Type: integer

      L'année du dépôt.

    application/json
  • 202
    Type: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Le document est encore en préparation. Interrogez le result_url du corps de la réponse pour récupérer le résultat. Cette réponse ne vous est pas facturée.

    • accession_number
      Type: string

      Le numéro d'accession du document en cours de préparation.

    • estimated_ready_at
      Type: string Format: date-time

      Quand le document devrait être prêt.

    • message
      Type: string

      Description lisible de la prochaine étape à suivre.

    • request_id
      Type: string Format: uuid

      Identifiant de cette requête ; utile lors d'un contact avec le support.

    • result_url
      Type: string

      L'URL à interroger pour obtenir le résultat.

    • status
      enum
      constante:  
      processing

      Toujours 'processing' dans une réponse 202.

      valeurs
      • processing
    application/json
  • 400

    La requête n'a pas pu être traitée. Vérifiez les paramètres de la requête.

  • 401

    Une clé API Felo valide est requise.

  • 402

    La requête ne peut pas aboutir car une condition de facturation n'est pas remplie.

  • 403

    Le compte n'est pas autorisé à effectuer cette opération.

  • 429

    Une limite de requêtes ou de dépenses a été atteinte.

  • 502

    Le service n'a pas pu terminer la requête.

  • 503

    L'API ou le service de facturation est temporairement indisponible.

  • 504

    Le service a expiré lors du traitement de la requête.

  • default

    Réponse d'erreur ; les réponses transmises depuis l'upstream peuvent utiliser les formats du fournisseur

    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