Find equities

Fetch equities, optionally with events, and narrowed down by search term

GET /equities

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 events to 1+ bloomberg tickers (comma-separated)
isin	query	string	Filter events to 1+ ISINs (comma-separated)
ric	query	string	Filter events to 1+ Reuters/Refinitiv RICs (comma-separated)
permid	query	string	Filter events to 1+ PermIDs (comma-separated)
ticker	query	string	Filter events to 1+ tickers (comma-separated)
from_index	query	integer	The index from which to start returning equities
size	query	integer	The number of equities to return (max: 100)

NOTE

Only one of the equity identifiers (bloomberg_ticker, isin, ric, or ticker) should be used per request. Using multiple equity identifier query parameters will end up resolving only one of them.

Response

[
	{
		"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",
		"gics_sector": "Consumer Discretionary",
		"gics_sub_sector": "Internet & Direct Marketing Retail",
	    "primary_equity": true
	}
]

Code Samples

Bash

curl --request GET \
  --url 'https://premium.aiera.com/api/equities' \
  --header 'X-API-Key: xxx'

Python

import requests
requests.request("GET", "https://premium.aiera.com/api/equities", headers={"X-API-Key": "xxx"})