v1

latestSwagger 2.02026-07-179553242.0 KB

Instrument

Show constituent parts of an index.

Composite indices are built from multiple external price sources.

Use this endpoint to get the underlying prices of an index. For example, send a symbol of .BXBT to get the ticks and weights of the constituent exchanges that build the ".BXBT" index.

A tick with reference "BMI" and weight null is the composite index tick.

get/instrument/compositeIndex

Query parameters

symbolstring

The composite index symbol.

filterstring JSON

Generic table filter. Send JSON key/value pairs, such as {"key": "value"}.

columnsstring JSON

Array of column names to fetch. If omitted, will return all columns.

Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.

countinteger

Number of results to fetch. Must be a positive integer.

startinteger

Starting point for results.

reverseboolean

If true, will sort results newest first.

startTimestring date-time

Starting date filter for results.

endTimestring date-time

Ending date filter for results.

Response

Request was successful

timestampstring date-time required

symbolstring

indexSymbolstring

indexMultipliernumber double

referencestring

lastPricenumber double

sourcePricenumber double

conversionIndexstring

conversionIndexPricenumber double

weightnumber double

loggedstring date-time

Example response

[
  {
    "reference": "reference",
    "conversionIndex": "conversionIndex",
    "symbol": "symbol",
    "indexSymbol": "indexSymbol",
    "logged": "2000-01-23T04:56:07.000+00:00",
    "conversionIndexPrice": 5.962133916683182,
    "weight": 5.637376656633329,
    "indexMultiplier": 0.8008281904610115,
    "sourcePrice": 1.4658129805029452,
    "timestamp": "2000-01-23T04:56:07.000+00:00",
    "lastPrice": 6.027456183070403
  }
]