Get index summary

GET 
/api/v1/indices/:externalId

Request

Path Parameters

externalId stringrequired

ID of the Index

Responses

200

successful operation

application/json

Schema

Schema

serverTime date-time
error stringnullable

description of error in natural language, absent in case of successful operation

payload

object

nullable

The response data

id string

ID of the Index

name string

The name of the index

decimals int32

Number of decimal places in the publish result

base string

base asset ID

quote string

quote asset ID

demiseDateTime date-timenullable

Date time when this index will be demised

Example (from schema)

{
  "serverTime": "2024-01-01T09:00:00.000Z",
  "error": "string",
  "payload": {
    "id": "BRR",
    "name": "CME CF Bitcoin Reference Rate",
    "decimals": 2,
    "base": "BTC",
    "quote": "USD",
    "demiseDateTime": "2024-01-01T09:00:00.000Z"
  }
}

Loading...