Felo API PlatformFelo API Platform
Все эндпоинты 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.

Query-параметры
  • accession_number
    Тип: string

    Номер документа (accession number), если это 8-K.

  • filing_type
    Тип: string enum
    обязательно

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

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

    Включать ли исходный текст связанных приложений. Применяется только к документам 8-K. Если true, объекты приложений будут содержать поле 'text' с полным содержимым приложения.

  • item
    Тип: string enum

    Элемент, который нужно получить.

    значения
    • 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
      enum
      константа:  
      processing

      Всегда 'processing' при ответе 202.

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

    Запрос не удалось обработать. Проверьте параметры запроса.

  • 401

    Требуется действительный API-ключ Felo.

  • 402

    Запрос не может быть выполнен: не выполнено требование биллинга.

  • 403

    Аккаунту не разрешено выполнять эту операцию.

  • 429

    Достигнут лимит запросов или расходов.

  • 502

    Сервис не смог выполнить запрос.

  • 503

    API или сервис биллинга временно недоступны.

  • 504

    Истекло время ожидания обработки запроса.

  • default

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    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

Нужна помощь?