Equity Lookup
Search companies
GET
/v1/instruments/get_companies
Search companies by company name, perm_id, isin or ticker.
Headers
Name
Value
Content-Type
application/json
X-API-KEY
<token>
Body
Name
Type
Description
name
string
Name of the company
perm_id
string
Perm_id of the company
isin
string
ISIN code of the company's equity
ticker
string
Ticker of the company's equity
Response
{
"status_code": 200,
"data": [
{
"orbit_entity_id": "1-4295905573",
"perm_id": "1-4295905573",
"company_name": "APPLE INC",
"equities": [
{
"name": "APPLE",
"isin": "US0378331005",
"ticker": "-"
},
{
"name": "APPLE",
"isin": "US0378331005",
"ticker": "037833100"
},
{
"name": "APPLE",
"isin": "US0378331005",
"ticker": "B0YQ5W0"
},
...
]
}
],
"detail": null,
"message": "success"
}
Search equity
GET
/v1/instruments/get_instruments
Search entities or companies by name, perm_id, isin or ticker.
Headers
Name
Value
Content-Type
application/json
X-API-KEY
<token>
Body
Name
Type
Description
name
string
Name of the company
perm_id
string
Perm_id of the company
isin
string
Isin code of the company's equity
ticker
string
Ticker of the company's equity
Response
{
"status_code": 200,
"data": [
{
"perm_id": "1-4295905573",
"name": "Apple Inc",
"equities": [
{
"isin": "US0378331005",
"ticker": "AAPL"
}
]
},
{
"perm_id": "1-5039730211",
"name": "Applegreen Ltd",
"equities": [
{
"isin": "IE00BXC8D038",
"ticker": "APGN"
}
]
},
...
],
"detail": null,
"message": "success"
}
Last updated