API Enterprise
The indices ORTEX holds an announced, point-in-time membership history for, with the dates the history covers and whether your key is entitled to each.
Start here: every identifier listed is one the membership, changes and spells endpoints accept.
Available Data Points:
- Identifier: The ORTEX index identifier, passed as index= to the history endpoints.
- Name: The index's name at ORTEX.
- Country: The country the index covers (ISO 3166-1 alpha-2).
- Launch Date / History From: The index's launch and the first date the history answers.
- Last Event Date: The latest effective date of a recorded change.
- Event Count / Member Count: The changes recorded, and today's member count.
- Linked Share: The share of today's members linked to an ORTEX company.
- Entitled: Whether your key may read the index's history.
Access
Each index is licensed separately. Your key reads the indices it is entitled to, as listed with entitled true by /api/v11/enterprise/reference/indices/membership_coverage/. Naming an index you are not entitled to returns 403 addOnRequired; the multi-index feed leaves such indices out.
Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.
Trial key restrictions: Trial keys may be limited to a specific date range and set of regions. Requests outside the allowed regions or entirely outside the allowed date range are rejected; a date window that partially overlaps the allowed range is trimmed to it, reported in meta.restriction.
Get full access! Contact [email protected]
