latestSwagger 2.02026-08-1274120326.8 KB
3a995f316cda
Index Data V2
Get Ticker Data (Single)
This endpoint allows permissioned users to retrieve ticker/index data with flexible querying options. Data can be queried by full ticker notation or individual components, allowing for broad or specific searches.
Query Parameter Semantics:
- ticker: Fully qualified ticker notation in format "{Index}.{Granularity}" (e.g., "OTMS.DAL"). When provided, automatically splits into index and granularity1 components. This is the most specific form.
- index: The base ticker/index identifier only (e.g., "OTMS"). Use this for broader queries across all granularities of an index.
- granularity1: The primary granularity dimension (e.g., "USA", "DAL"). Can be used alone or with index.
- granularity_level: Additional granularity level filtering (e.g., location codes).
Flexible Querying Examples:
- Specific ticker: ```ticker=OTMS.DAL``` → Returns OTMS index with DAL granularity
- All granularities: ```index=OTMS``` → Returns all OTMS data across all granularities
- Partial granularity: ```index=OTMS&granularity=DAL``` → Returns OTMS with XMKT granularity
- OTMS for all markets: ```index=OTMS&granularity_level=XMKT``` → Returns OTMS with XMKT granularity
- With level filter: ```index=OTMS.DAL&granularity_level=XMKT``` → Most specific query
Precedence: ticker takes precedence as it's most specific. Individual parameters override components parsed from ticker.
Required Parameters: start_date, end_date, and at least one of (ticker or index) must be provided.
get/v2/index_data
Query parameters
start_datestring date
Start date (YYYY-MM-DD), required
end_datestring date
End date (YYYY-MM-DD), required
tickerstring
Fully qualified ticker notation (e.g., "OTMS.DAL"), optional
indexstring
Base index identifier (e.g., "OTMS"), optional
granularitystring
Primary granularity (e.g., "DAL"), optional
granularity_levelstring
Granularity level filter (e.g. "XMKT"), optional
Headers
x-api-versionstring
Response
OK
Example response
[
{
"index": "OTMS",
"granularity": "DAL",
"granularity_level": "XMKT",
"data_date": "2025-01-15",
"data_value": 2.45
}
]