Company Docs
Get company document categories
Get a company document categories
GET /company-docs-v1/categories
| 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 categories 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/categories?bloomberg_ticker=AAPL:US
Response
{
"pagination": {
"total_count": 12,
"current_page": 1,
"total_pages": 2,
"page_size": 10
},
"data": {
"announcement": 37490,
"sec_filing": 23246,
"slide_presentation": 22097,
"press_release": 20405,
"earnings_release": 16737,
"other": 5462,
"annual_report": 3135,
"financial_report": 2991,
"sustainability_report": 1105,
"technical_report": 969,
"transcript": 690,
"certification": 446,
"investor_presentation": 415,
"product": 413,
"research_report": 403,
"privacy_policy": 354,
"corporate_governance": 354,
"proxy_statement": 350,
"datasheet": 333,
"shareholder_letter": 312,
...
}
}
Code Samples
Bash
curl --request GET \
--url 'https://premium.aiera.com/api/company-docs-v1/categories' \
--header 'X-API-Key: xxx'
Python
import requests
requests.request("GET", "https://premium.aiera.com/api/company-docs-v1/categories", headers={"X-API-Key": "xxx"})