Orbit Platform Documentation
DocsAPI ReferenceHomepageSign In
API Reference
API Reference
  • Reference
    • Introduction
    • Authentication
  • ENDPOINTS
    • Equity Lookup
    • Retrive Report List
    • Chat with a report
    • Metainfo - Report Type Classification
Powered by GitBook
On this page
  1. ENDPOINTS

Retrive Report List

Get company report

GET /v1/instruments/get_company_reports

POST {{baseUrl}}/{{version}}/instruments/get_company_reports
Content-Type: application/json
X-API-KEY: <token>

{
  "perm_id": "1-4295905573",
  "start_date": "2024-02-15",
  "end_date": "2025-02-14",
  "lv3_type_id_list": [
    "10002"
  ],
  "page": 1,
  "size": 10
}

Search all company report by company perm_id.

Headers

Name
Value

Content-Type

application/json

X-API-KEY

<token>

Body

Name
Type
Description

perm_id

string

Perm_id of the company

start_date

string

Isin code of the company's equity

end_date

string

Ticker of the company's equity

lv3_type_id_list

string[]

List of report types

page

integer

Which page

size

integer

Page size

Response

{
  "status_code": 200,
  "data": {
    "reports": [
      {
        "report_id": "f_8cpwBjXjmmql5CM2FwprgR",
        "report_title": "10-K",
        "language": "en",
        "type_id_list": [
          "10002"
        ],
        "reported_at": "2024-11-01",
        "can_be_questioned": true,
        "attachments_pdf": [
          {
            "attachment_id": "pVzPFulH",
            "file_title": "Form 10-K",
            "file_title_en": "Form 10-K",
            "language": "en",
            "page_count": 60,
            "preview_link": "https://filing-reports.s3.amazonaws.com/reports-data/stock_us/2024/11/01/edgar-data-320193-000032019324000123-aapl-20240928.htm.pdf?AWSAccessKeyId=AKIAZ2SDT5DU46K54RGA&Signature=rigWmpZ2ujEhFDq0effSJH5UmK8%3D&Expires=1740644555"
          },
          {
            "attachment_id": "nh5tYfGl",
            "file_title": "10-K",
            "file_title_en": "10-K",
            "language": "en",
            "page_count": 14,
            "preview_link": "https://filing-reports.s3.amazonaws.com/reports-data/stock_us/2024/11/01/edgar-data-320193-000032019324000123-a10-kexhibit4109282024.htm.pdf?AWSAccessKeyId=AKIAZ2SDT5DU46K54RGA&Signature=UYNVnCC9%2BYtapUuPMqFl%2FePITmM%3D&Expires=1740644555"
          },
          {
            "attachment_id": "YYLRd39V",
            "file_title": "APPLE INC. 2022 EMPLOYEE STOCK PLAN RESTRICTED STOCK UNIT AWARD AGREEMENT",
            "file_title_en": "APPLE INC. 2022 EMPLOYEE STOCK PLAN RESTRICTED STOCK UNIT AWARD AGREEMENT",
            "language": "en",
            "page_count": 7,
            "preview_link": "https://filing-reports.s3.amazonaws.com/reports-data/stock_us/2024/11/01/edgar-data-320193-000032019324000123-a10-kexhibit10199282024.htm.pdf?AWSAccessKeyId=AKIAZ2SDT5DU46K54RGA&Signature=SdC1QT6U5ye64jPiUIhoFWoLpjw%3D&Expires=1740644555"
          },
          ...
        ]
      },
      {
        "report_id": "o_6EHx3VwgfFt4VnhQYKRgH6",
        "report_title": "Apple Inc. CONDENSED CONSOLIDATED STATEMENTS OF OPERATIONS (Unaudited)",
        "language": "en",
        "type_id_list": [
          "10002",
          "10085",
          "10089"
        ],
        "reported_at": "2024-05-02",
        "can_be_questioned": true,
        "attachments_pdf": [
          {
            "attachment_id": "LmD1CkuH",
            "file_title": "FY24_Q2_Consolidated_Financial_Statements",
            "file_title_en": null,
            "language": "en",
            "page_count": null,
            "preview_link": "https://official-reports.s3.amazonaws.com/data-system/B42E5804738080206BF4A3B215BEDED1.pdf?AWSAccessKeyId=AKIAZ2SDT5DU46K54RGA&Signature=DJB81l9Ua1VFUmlb8L4Wm32TsCc%3D&Expires=1740644555"
          }
        ]
      }
    ],
    "page": 1,
    "size": 10,
    "total": 2
  },
  "detail": null,
  "message": "success"
}
{
  "error": "Invalid request"
}

PreviousEquity LookupNextChat with a report

Last updated 3 months ago