Company Docs
Get company document keywords
Get a company document keywords
GET /company-docs-v1/keywords
| Parameter | Type | DataType | Description |
|---|---|---|---|
| bloomberg_ticker | query | string | Filter to one or more bloomberg tickers (comma-separated) |
| isin | query | string | Filter to one or more ISINs (comma-separated) |
| cusip | query | string | Filter to one or more CUSIPs (comma-separated) |
| ric | query | string | Filter to one or more RICs (comma-separated) |
| permid | query | string | Filter to one or more PermIDs (comma-separated) |
| search | query | string | Filter keywords by name |
| include_delisted | query | boolean | Whether to include delisted equities (default: true) |
| company_rollup | query | boolean | Whether to rollup to all company equities (default: true) |
| page | query | integer | The page of results to return |
| page_size | query | integer | The size of pages to return (default: 100, min: 10, max: 100) |
NOTE
- At least one equity identifier is required
- Only one identifier should be used per request
Request
https://premium.aiera.com/api/company-docs-v1/keywords?bloomberg_ticker=AAPL:US
Response
{
"pagination": {
"total_count": 500,
"current_page": 1,
"total_pages": 5,
"page_size": 100
},
"data": {
"financial results": 18981,
"financial performance": 15857,
"financial statements": 13289,
"sustainability": 12830,
"risk management": 9470,
"earnings": 9449,
"corporate governance": 9142,
"securities": 8919,
"compliance": 8790,
"cash flow": 8723,
"net income": 8347,
"beneficial ownership": 7961,
"revenue": 7477,
"revenue growth": 7093,
"Form 4": 6725,
"common stock": 5717,
"board of directors": 5656,
"annual report": 5581,
"EBITDA": 5462,
"investment": 5316,
"shareholders": 5300,
"acquisition": 5112,
...
}
}
Code Samples
Bash
curl --request GET \
--url 'https://premium.aiera.com/api/company-docs-v1/keywords' \
--header 'X-API-Key: xxx'
Python
import requests
requests.request("GET", "https://premium.aiera.com/api/company-docs-v1/keywords", headers={"X-API-Key": "xxx"})