# Appendix B Metainfo

## Market:

market: \[\
{ value: "0-1000000000", label: "Less than 1B" },\
{ value: "1000000000-100000000000", label: "1B - 100B" },\
{ value: "100000000000-500000000000", label: "100B - 500B" },\
{ value: "500000000000-9999999999999", label: "More than 500B" },\
]

***

## **Exchange:**

{% file src="/files/5s9oqT6F2UKQGggasq6K" %}

***

## **Country:**

{% file src="/files/u0y1s8qLhzXRJUZ5Z4wf" %}

***

## Sector:

{% file src="/files/2QO9jmQbqvzsu1NjuLEE" %}

***

## Report Type Classification

### Endpoint

```
GET /v1/constant/report_type_list
```

### Description

Retrieves the complete hierarchical classification system for report types used in Orbitfin. The classification uses a three-level taxonomy (Level 1 → Level 2 → Level 3) to categorize various corporate reports, filings, and announcements.

### Request

#### Headers

| Name           | Type   | Required | Description        |
| -------------- | ------ | -------- | ------------------ |
| `Content-Type` | string | Yes      | `application/json` |
| `X-API-KEY`    | string | Yes      | api-key            |

#### Example Request

```bash
curl -X 'GET' \
  'https://api.orbitfin.ai/v1/constant/report_type_list' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: <your-api-key>'
```

### Response

#### Response Fields

**Top-Level Fields**

| Field         | Type        | Description                                                        |
| ------------- | ----------- | ------------------------------------------------------------------ |
| `status_code` | integer     | HTTP status code (200 for success)                                 |
| `data`        | object      | Container object with version info and report type classifications |
| `detail`      | string/null | Additional error details (null on success)                         |
| `message`     | string      | Response status message                                            |

**Data Object**

| Field              | Type   | Description                                                   |
| ------------------ | ------ | ------------------------------------------------------------- |
| `version`          | string | Version number of the report type classification system       |
| `report_type_list` | array  | Array of report type objects with hierarchical classification |

**Report Type Object (`data.report_type_list[]`)**

| Field      | Type   | Description                                         |
| ---------- | ------ | --------------------------------------------------- |
| `lv3_id`   | string | Level 3 (most specific) report type identifier      |
| `lv3_name` | string | Level 3 report type name (specific report category) |
| `lv2_id`   | string | Level 2 (intermediate) category identifier          |
| `lv2_name` | string | Level 2 category name (report subcategory)          |
| `lv1_id`   | string | Level 1 (top-level) category identifier             |
| `lv1_name` | string | Level 1 category name (broad report classification) |

#### Example Response

```json
{
  "status_code": 200,
  "data": {
    "version": "0.2.6",
    "report_type_list": [
      {
        "lv3_id": "10000",
        "lv3_name": "Copy of Newspaper Publication",
        "lv2_id": "1001",
        "lv2_name": "Announcement Publication",
        "lv1_id": "101",
        "lv1_name": "Market and Trading Information"
      },
      {
        "lv3_id": "10001",
        "lv3_name": "Press Release",
        "lv2_id": "1001",
        "lv2_name": "Announcement Publication",
        "lv1_id": "101",
        "lv1_name": "Market and Trading Information"
      }
    ]
  },
  "detail": null,
  "message": "success"
}
```

#### Classification Hierarchy

The report types follow a three-level hierarchical structure:

```
Level 1 (lv1): Broad Category
  └── Level 2 (lv2): Subcategory
      └── Level 3 (lv3): Specific Report Type
```

**Example:**

```
Market and Trading Information (101)
  └── Announcement Publication (1001)
      └── Copy of Newspaper Publication (10000)
      └── Press Release (10001)
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.orbitfin.ai/orbit-api-reference/api/appendix-b-metainfo.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.