7.1 Overview of Available APIs

Authentication

All API requests require authentication using an orbit_key. This key should be included in the query string of every request. Example: orbit_key=[Your_Orbit_Key]

API Endpoints

1. Retrieve Entity Information by ISIN

Endpoint:https://insight-staging.orbitfin.ai/prod-api/openapi/from_isin_get_entity?isin=FR001400EBA9&orbit_key=xxxx Method: GET Request Parameters:

  • isin: The International Securities Identification Number (ISIN) of the entity.

  • orbit_key: Your Orbit authentication key.

Response:

{
    "code": 20000,
    "state": "",
    "message": "success",
    "detail": "success",
    "data": [
        {
            "id_isin": "FR001400EBA9",
            "name": "EUROFINS SCIENTIFIC SE",
            "ticker": null,
            "entity_id": "1-5037433929",
            "website": "https://www.eurofins.com/"
        }
    ],
    "total": 1
}

2. Get Report List by Entity ID

Endpoint:https://insight-staging.orbitfin.ai/prod-api/openapi/from_entity_get_report_list?entity_id=1-5037433929&orbit_key=xxxxxx Method: GET Request Parameters:

  • entity_id: The unique identifier for the entity.

  • orbit_key: Your Orbit authentication key.

Response:

{
    "code": 20000,
    "state": "",
    "message": "success",
    "detail": "success",
    "data": [
        {
            "id": 25745,
            "title": "2022 the Presentation",
            "reported_at": "2022-12-30",
            "report_type": "Earnings Release"
        },
        {
            "id": 25755,
            "title": "2021 Full Year Results Presentation",
            "reported_at": "2021-12-30",
            "report_type": "Earnings Release"
        }
    ],
    "total": 2
}

3. Retrieve Report Detail

Endpoint:https://insight-staging.orbitfin.ai/prod-api/openapi/report_detail?report_id=f_bDTJ2Jps__m9sP2bjR&orbit_key=xxxxxx Method: GET Request Parameters:

  • report_id: The unique identifier for the financial report.

  • orbit_key: Your Orbit authentication key.

Response:

{
    "code": 20000,
    "state": "",
    "message": "success",
    "detail": "success",
    "data": [
        {
            "id": "f_bDTJ2Jps__m9sP2bjR",
            "title": "Annual Financial Report",
            "reported_at": "2022-03-18",
            "name": "Annual Financial Report",
            "report_type": "Annual Reports",
            "presigned_url_pdf": "...",
            "presigned_url_page": "...",
            "presigned_url_page_vector": "...",
            "presigned_url_block": "...",
            "presigned_url_block_vector": "..."
        }
    ],
    "total": 1
}

4. Search against documents

Endpoint:https://insight-staging.orbitfin.ai/prod-api/openapi/general_question_search_report_list?entity_id=1-4295905573&start_time=2024-03-25&end_time=2024-04-25&orbit_key=xxxxxxRequest:

start_date: "2024-03-25" //
end_date: "2024-04-25" //
entity_id: '1-4295905573'

Response:

{
    "code": 20000,
    "state": "success",
    "message": "",
    "detail": "",
    "data": [
        {
            "id": "f_dSMDpkferezOHX82l2BBOE__75pa4HQi",
            "meta": {
                "score": 98,
                "report_text": "SEC Form 4 FORM 4 UNITED STATES SECURITIES AND EXCHANGE COMMISSION OMB APPROVAL Washington, D.C. 20549 OMB Number: 3235-0287 Estimated average burden Check this box if no longer subject to STATEMENT O...",
                "pages": [
                    1,
                    2
                ],
                "report_id": "f_dSMDpkferezOHX82l2BBOE",
                "attachment_id": "f_dSMDpkferezOHX82l2BBOE__75pa4HQi",
                "entity_id": [
                    "1-4295905573"
                ],
                "organization_info_list": [
                    {
                        "perm_id": "1-4295905573",
                        "organization_name": "Apple Inc"
                    }
                ],
                "report_title": "4",
                "report_type_id": "4",
                "report_type_name": "Filing",
                "reported_at": "2024-04-17",
                "sentence": "",
                "store_path": "s3://filing-reports/reports-data/stock_us/2024/04/17/edgar-data-320193-000032019324000058-xslF345X05-wk-form4_1713393040.xml.html.pdf"
            }
        },
        {
            "id": "f_9MxbaaGlVTQd7B5d3hyRNQ__NFfkYtqj",
            "meta": {
                "score": 93,
                "report_text": "SEC Form 4 FORM 4 UNITED STATES SECURITIES AND EXCHANGE COMMISSION OMB APPROVAL Washington, D.C. 20549 OMB Number: 3235-0287 Estimated average burden Check this box if no longer subject to STATEMENT O...",
                "pages": [
                    1
                ],
                "report_id": "f_9MxbaaGlVTQd7B5d3hyRNQ",
                "attachment_id": "f_9MxbaaGlVTQd7B5d3hyRNQ__NFfkYtqj",
                "entity_id": [
                    "1-4295905573"
                ],
                "organization_info_list": [
                    {
                        "perm_id": "1-4295905573",
                        "organization_name": "Apple Inc"
                    }
                ],
                "report_title": "4",
                "report_type_id": "4",
                "report_type_name": "Filing",
                "reported_at": "2024-04-15",
                "sentence": "",
                "store_path": "s3://filing-reports/reports-data/stock_us/2024/04/15/edgar-data-320193-000032019324000055-xslF345X05-wk-form4_1713220215.xml.html.pdf"
            }
        }
    ]
}

5. Chat against documents

Endpoint:https://insight-staging.orbitfin.ai/prod-api/openapi/general_current_pdf_chat?report_id=f_9MxbaaGlVTQd7B5d3hyRNQ&question=please%20summary%20the%20annual%20report&orbit_key=xxxxxxRequest:

repot_id:"f_9MxbaaGlVTQd7B5d3hyRNQ"，
question:"please summary the annual report"

Response:

{
    "code": 20000,
    "state": "success",
    "message": "success",
    "detail": "",
    "data": {
        "answer": "The report is an opinion from the independent registered public accounting firm regarding the financial statements of Apple Inc. for the period ended September 30, 2023. The firm states that, in their opinion, the financial statements present fairly the financial position of Apple Inc. and the results of its operations and cash flows in conformity with U.S. generally accepted accounting principles.\n\nThe report also includes a discussion of a critical audit matter relating to uncertain tax positions, which involves significant judgment and complexity in interpretation of tax laws and legal rulings.\n\nIn addition, the report includes the company's financial statements and supplementary data for the year ended September 30, 2023.",
        "page_obj_list": [
            {
                "attachment_id": "f_LmGtOlyj__Ef6RutgH",
                "id": "p_nhWNgASb",
                "page": 52,
                "question": "please summary the annual report"
            },
            {
                "attachment_id": "f_LmGtOlyj__Ef6RutgH",
                "id": "p_CeOmjUEP",
                "page": 3,
                "question": "please summary the annual report"
            },
            {
                "attachment_id": "f_LmGtOlyj__Ef6RutgH",
                "id": "p_HvBjaHNU",
                "page": 30,
                "question": "please summary the annual report"
            },
            {
                "attachment_id": "f_LmGtOlyj__Ef6RutgH",
                "id": "p_VcI5GHHE",
                "page": 60,
                "question": "please summary the annual report"
            }
        ]
    }
}

Note: URLs in the response have been abbreviated for readability.

Previous6.4 Integration with Existing SystemsNext7.2 Jupyter Notebook Examples

Last updated