latestSwagger 2.02026-08-1274120326.8 KB

3a995f316cda

Index Data V2

Get Ticker Data (Bulk)

This endpoint allows permissioned users to retrieve ticker/index data for multiple ticker combinations with flexible querying options. Each ticker specification in the request can use different levels of specificity.

Request Body Structure:

  • start_date: Earliest date of the range (YYYY-MM-DD), required
  • end_date: Most recent date of the range (YYYY-MM-DD), required
  • tickers: Array of ticker query objects, required. Each object supports flexible querying:

Ticker Query Object Fields:

  • ticker: Fully qualified notation "{Index}.{Granularity1}" (e.g., "OTMS.DAL"). Automatically splits into index and granularity1. Most specific form.
  • index: Base ticker/index identifier (e.g., "OTMS"). Use for broader queries.
  • granularity1: Primary granularity dimension (e.g., "USA", "DAL").
  • granularity_level: Additional granularity level filtering.

Flexible Query Examples:

``` { "start_date": "2025-01-01", "end_date": "2025-01-20", "tickers": [ { "ticker": "OTMS.DAL" }, // Specific ticker { "index": "OTRI" }, // All OTRI granularities { "index": "VSTLR", "granularity1": "DAL" }, // Partial specification { "ticker": "TSTOP.NYC", "granularity_level": "METRO" } // With level filter ] } ```

Precedence: ticker takes precedence. Explicit fields (index, granularity1) override components parsed from ticker.

Null Handling: Omitted/null granularity fields enable broader queries (e.g., all granularities for an index).

post/v2/index_data

Headers

x-api-versionstring

Request body

start_datestring date

Start date for the data range (YYYY-MM-DD)

end_datestring date

End date for the data range (YYYY-MM-DD)

Example request

{
  "start_date": "2025-01-01",
  "end_date": "2025-01-20",
  "tickers": [
    {
      "ticker": "OTMS.DAL",
      "index": "OTMS",
      "granularity": "DAL",
      "granularity_level": "XMKT"
    }
  ]
}

Response

OK

indexstring

The ticker symbol/identifier

granularitystring

Specific granularity item

granularity_levelstring

Granularity level identifier

data_datestring date

Date of the data point

data_valuenumber double

The value for this data point

Example response

[
  {
    "index": "OTMS",
    "granularity": "DAL",
    "granularity_level": "XMKT",
    "data_date": "2025-01-15",
    "data_value": 2.45
  }
]