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 one or more bloomberg tickers (comma-separated)
isin	query	string	Filter equities to one or more ISINs (comma-separated)
ric	query	string	Filter equities to one or more Reuters/Refinitiv RICs (comma-separated)
permid	query	string	Filter equities to one or more 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 one or more 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)
include_company_metadata	query	boolean	Whether to include the associated company's metadata (e.g. names, urls)
include_inactive	query	boolean	Whether to include inactive equities

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.

Request

https://premium.aiera.com/api/equities-v2?bloomberg_ticker=AMZN:US&include_company_metadata=true

Response

{
  "params": {
    "bloomberg_ticker": "AMZN:US",
    "include_company_metadata": true
  },
  "pagination": {
    "total_count": 1,
    "current_page": 1,
    "total_pages": 1,
    "page_size": 1
  },
  "data": [
    {
      "equity_id": 1,
      "name": "AMAZON COM INC",
      "common_name": "AMAZON COM INC",
      "ticker": null,
      "local_ticker": "AMZN",
      "mic": "XNAS",
      "bloomberg_ticker": "AMZN:US",
      "isin": "US0231351067",
      "permid": "4295905494",
      "sector_id": 1,
      "gics_sector": "Consumer Discretionary",
      "subsector_id": 259,
      "gics_sub_sector": "Broadline Retail",
      "primary_equity": true,
      "created": "2017-06-01T00:00:00",
      "modified": "2024-11-11T14:02:12",
      "status": "active",
      "company_metadata": {
        "company_id": 1,
        "common_name": "Amazon",
        "legal_name": "Amazon.com Inc",
        "incorporated_country_code": "US",
        "domiciled_country_code": "US",
        "urls": [
          {
            "url": "https://s3.amazonaws.com/assets.aiera.com/assets/manual-override-1-1723048553.9238625.png",
            "url_type": "logo_icon"
          },
          {
            "url": "https://ir.aboutamazon.com/overview/default.aspx",
            "url_type": "ir_home"
          },
          {
            "url": "https://ir.aboutamazon.com/events/default.aspx",
            "url_type": "ir_events"
          },
          {
            "url": "https://press.aboutamazon.com/press-release-archive",
            "url_type": "ir_news"
          },
          {
            "url": "https://www.amazon.com/",
            "url_type": "home"
          },
          {
            "url": "https://ir.aboutamazon.com/sec-filings/default.aspx",
            "url_type": "filings"
          },
          {
            "url": "https://www.youtube.com/user/amazon",
            "url_type": "youtube"
          }
        ]
      }
    }
  ]
}

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"})