Felo API PlatformFelo API Platform
Tüm Financial Data endpoint'leri
v0.2.0-beta
OpenAPI 3.1.0

SEC bildirim maddelerini al

Felo API Support
MIT
Sunucu:https://openapi.felo.ai
İstemci Kitaplıkları
Shell Curl

Financial Data

​

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

Financial Data İşlemler

SEC bildirim maddelerini al

​

Bir SEC bildirimi içindeki numaralı maddelerin tam metni. ticker, filing_type (10-K, 10-Q veya 8-K) ve year zorunludur; quarter, item, accession_number veya include_exhibits ile daha da daraltın. items döndürür — her biri number, title ve tam text içerir — ayrıca filing_url ve accession_number. Boyuta dikkat edin: bir 10-K yaklaşık 19 tam düzyazı maddesi olarak döner; bu yüzden tüm belgeye gerçekten ihtiyacınız yoksa her şeyi çekmek yerine belirli bir item isteyin. Önce hangi bildirimin açılacağını bulmak için get_financial_filings kullanın.

Fiyatlandırma referansı

  • Ölçümlendirme: başarılı istek başına sabit maliyet esası.
  • Referans istek tahmini: USD 0.02.
  • Referans müşteri çarpanı: 1.0. Kesinleşmiş müşteri tutarına yeniden uygulamayın.

Yalnızca referans üst verisidir; hesap teklifi, garantili fiyat veya harcama üst sınırı değildir. Kaynak kredileri Felo kredisi değildir. Nihai ücretler Felo faturalandırma kayıtlarını izler.

Sorgu Parametreleri
  • accession_number
    Tür: string

    8-K ise bildirimin accession numarası.

  • filing_type
    Tür: string enum
    gerekli

    Bildirim türü.

    değerler
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Tür: boolean

    Bağlantılı eklerdeki ham metnin dahil edilip edilmeyeceği. Yalnızca 8-K bildirimleri için geçerlidir. true olduğunda ek nesneleri, ekin tam içeriğini barındıran 'text' alanını içerir.

  • item
    Tür: string enum

    Alınacak madde.

    değerler
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Tür: integer

    10-Q ise bildirimin çeyreği.

  • ticker
    Tür: string
    gerekli

    Ticker sembolü.

  • year
    Tür: integer
    gerekli

    Bildirimin yılı.

Yanıtlar
  • 200
    Tür: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    SEC bildirim maddeleri yanıtı

    • accession_number
      Tür: string

      Bildirimin accession numarası.

    • cik
      Tür: string

      Şirketin Central Index Key (CIK) değeri.

    • filing_type
      Tür: string

      Bildirim türü.

    • items
      Tür: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        Tür: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        Bu öğeye bağlı ekler dizisi. Yalnızca ekler varsa 8-K bildirimlerinde bulunur.

        • description
          Tür: string

          Ekli belgenin açıklaması.

        • number
          Tür: string

          Ek numarası (ör. '99.1').

        • text
          Tür: string

          Ekli belgenin ham metin içeriği. Yalnızca 'include_exhibits' parametresi true olarak ayarlandığında eklenir.

        • url
          Tür: string Biçim: uri

          SEC web sitesindeki ek belgenin URL'si.

      • name
        Tür: string

        Öğe adı.

      • number
        Tür: string

        Öğe numarası.

      • text
        Tür: string

        Öğe metni.

    • quarter
      Tür: integer

      Bildirimin çeyreği.

    • resource
      Tür: string

      Kaynak türü tanımlayıcısı.

    • ticker
      Tür: string

      Şirketin ticker sembolü.

    • year
      Tür: integer

      Bildirimin yılı.

    application/json
  • 202
    Tür: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Bildirim hâlâ hazırlanıyor. Sonucu almak için yanıt gövdesindeki result_url adresini yoklayın. Bu yanıt için ücret alınmaz.

    • accession_number
      Tür: string

      Hazırlanan bildirimin accession numarası.

    • estimated_ready_at
      Tür: string Biçim: date-time

      Bildirimin ne zaman hazır olması beklendiği.

    • message
      Tür: string

      Sırada ne yapılacağının insan tarafından okunabilir açıklaması.

    • request_id
      Tür: string Biçim: uuid

      Bu istek için tanımlayıcı; destekle iletişime geçerken kullanışlıdır.

    • result_url
      Tür: string

      Sonucu yoklamak için URL.

    • status
      enum
      sabit:  
      processing

      202 yanıtında her zaman 'processing'.

      değerler
      • processing
    application/json
  • 400

    İstek işlenemedi. İstek parametrelerini kontrol edin.

  • 401

    Geçerli bir Felo API anahtarı gerekir.

  • 402

    Faturalandırma koşulu karşılanmadığı için istek devam edemiyor.

  • 403

    Hesabın bu işlemi gerçekleştirme izni yok.

  • 429

    İstek veya harcama sınırına ulaşıldı.

  • 502

    Hizmet isteği tamamlayamadı.

  • 503

    API veya faturalandırma hizmeti geçici olarak kullanılamıyor.

  • 504

    İstek işlenirken hizmet zaman aşımına uğradı.

  • default

    Hata yanıtı; upstream sağlayıcıdan doğrudan aktarılan yanıtlar sağlayıcı biçimlerini kullanabilir

    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"
        }
      ]
    }
  ]
}

SEC bildirim maddeleri yanıtı

Get SEC filing items