Equities
Find equities
Fetch equities, optionally with events, and narrowed down by search term or supported equity identifiers
GET /equities-v2
Parameter | Type | DataType | Description |
---|---|---|---|
search | query | string | Returns equities with names matching the search term |
events | query | boolean | Whether to include events |
bloomberg_ticker | query | string | Filter equities to 1+ bloomberg tickers (comma-separated) |
isin | query | string | Filter equities to 1+ ISINs (comma-separated) |
ric | query | string | Filter equities to 1+ Reuters/Refinitiv RICs (comma-separated) |
permid | query | string | Filter equities to 1+ PermIDs (comma-separated) |
sector_id | query | string | Filter equities to a specific sector |
subsector_id | query | string | Filter equities to a specific subsector |
ticker | query | string | Filter equities to 1+ tickers (comma-separated) |
page | query | integer | The page of results to return |
page_size | query | integer | The size of pages to return (default: 100, max: 2500) |
NOTE
- Only one of the equity identifiers (bloomberg_ticker, isin, permid, ric, or ticker) should be used per request. Using multiple equity identifiers will end up resolving only one of them.
Response
{
"params": {
"page": 1,
"sector_id": 1
},
"pagination": {
"total_count": 1461,
"current_page": 1,
"total_pages": 15,
"page_size": 100
},
"data": [
{
"equity_id": 1,
"name": "AMAZON COM INC",
"common_name": "Amazon Inc.",
"local_ticker": "AMZN",
"bloomberg_ticker": "AMZN:US",
"ric": "AMZN.OQ",
"permid": "4295905494",
"isin": "US0231351067",
"sector_id": 1,
"gics_sector": "Consumer Discretionary",
"subsector_id": 21,
"gics_sub_sector": "Internet & Direct Marketing Retail",
"primary_equity": true,
"created": "2023-02-09T01:29:13",
"modified": "2024-06-11T10:15:51"
}
]
}
Code Samples
Bash
curl --request GET \
--url 'https://premium.aiera.com/api/equities-v2' \
--header 'X-API-Key: xxx'
Python
import requests
requests.request("GET", "https://premium.aiera.com/api/equities-v2", headers={"X-API-Key": "xxx"})