Felo API PlatformFelo API Platform
Усі endpoint Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Отримання пунктів документа SEC

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клієнтські бібліотеки
Shell Curl

Financial Data

​

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

Financial Data Операції

Отримання пунктів документа SEC

​

Повний текст пронумерованих пунктів одного документа SEC. ticker, filing_type (10-K, 10-Q або 8-K) і year обов'язкові; додатково звужуйте через quarter, item, accession_number або include_exhibits. Повертає items — кожен з number, title і повним text — плюс filing_url і accession_number. Зважайте на розмір: 10-K повертається приблизно як 19 пунктів повного тексту, тому запитуйте конкретний item, а не все одразу, якщо вам справді не потрібен увесь документ. Щоб спершу знайти, який документ відкрити, використовуйте get_financial_filings.

Довідкові ціни

  • Тарифікація: фіксована базова вартість успішного запиту.
  • Довідкова оцінка запиту: USD 0.02.
  • Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Лише довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Параметри запиту
  • accession_number
    Тип: string

    Номер документа (accession number), якщо це 8-K.

  • filing_type
    Тип: string перелік
    обов'язкове

    Тип документа.

    значення
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Тип: boolean

    Чи включати вихідний текст пов'язаних вкладень. Застосовується лише до документів 8-K. Якщо true, об'єкти вкладень міститимуть поле 'text' із повним вмістом вкладення.

  • item
    Тип: string перелік

    Елемент, який потрібно отримати.

    значення
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Тип: integer

    Квартал документа, якщо це 10-Q.

  • ticker
    Тип: string
    обов'язкове

    Тікер-символ.

  • year
    Тип: integer
    обов'язкове

    Рік документа.

Відповіді
  • 200
    Тип: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Відповідь з пунктами документа SEC

    • accession_number
      Тип: string

      Номер документа.

    • cik
      Тип: string

      Central Index Key (CIK) компанії.

    • filing_type
      Тип: string

      Тип документа.

    • items
      Тип: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        Тип: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        Масив вкладень, пов'язаних із цим елементом. Присутній лише для документів 8-K, коли вкладення існують.

        • description
          Тип: string

          Опис вкладення.

        • number
          Тип: string

          Номер вкладення (наприклад, '99.1').

        • text
          Тип: string

          Вихідний текстовий вміст вкладення. Включається, лише якщо параметр 'include_exhibits' має значення true.

        • url
          Тип: string Формат: uri

          URL документа вкладення на сайті SEC.

      • name
        Тип: string

        Назва елемента.

      • number
        Тип: string

        Номер елемента.

      • text
        Тип: string

        Текст елемента.

    • quarter
      Тип: integer

      Квартал документа.

    • resource
      Тип: string

      Ідентифікатор типу ресурсу.

    • ticker
      Тип: string

      Тікер-символ компанії.

    • year
      Тип: integer

      Рік документа.

    application/json
  • 202
    Тип: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Документ ще готується. Опитуйте result_url з тіла відповіді, щоб отримати результат. З вас не стягується плата за цю відповідь.

    • accession_number
      Тип: string

      Номер документа, який готується.

    • estimated_ready_at
      Тип: string Формат: date-time

      Коли документ, як очікується, буде готовий.

    • message
      Тип: string

      Зрозумілий людині опис подальших дій.

    • request_id
      Тип: string Формат: uuid

      Ідентифікатор цього запиту; корисний під час звернення до підтримки.

    • result_url
      Тип: string

      URL для опитування результату.

    • status
      перелік
      константа:  
      processing

      Завжди 'processing' у відповіді 202.

      значення
      • processing
    application/json
  • 400

    Не вдалося обробити запит. Перевірте параметри запиту.

  • 401

    Потрібен дійсний API-ключ Felo.

  • 402

    Запит неможливо виконати: умови білінгу не виконано.

  • 403

    Обліковий запис не має дозволу на цю операцію.

  • 429

    Досягнуто ліміту запитів або витрат.

  • 502

    Служба не змогла виконати запит.

  • 503

    API або служба білінгу тимчасово недоступні.

  • 504

    Час очікування обробки запиту вичерпано.

  • default

    Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

    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

Get SEC filing items