Skip to main content

Get index detailed

GET 
/api/v1/indices/:externalId/detail

Request​

Path Parameters

    externalId stringrequired

    ID of the Index

Responses​

successful operation

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 published result

    base string

    base asset ID

    quote string

    quote asset ID

    underlyingAssetsType string

    Possible values: [SINGLE_ASSET, PORTFOLIO]

    bloomberg stringnullable

    ID under which the index is stored in Bloomberg system

    refinitiv stringnullable

    ID under which the index is stored in Refinitiv system

    isin stringnullable

    ISIN

    sedol stringnullable

    SEDOL

    inceptionValue doublenullable

    If this index is a portfolio, then this is its value at inception

    publicationFrequency stringnullable

    Possible values: [NOT_APPLICABLE, DAILY, BUSINESS_DAYS, PER_SECOND, PER_MINUTE, PER_HOUR, UNRECOGNIZED]

    How often the value of this index is updated

    publicationTime timenullable

    If the publicationFrequency is DAILY then this field will denote the time of publication

    publicationTimeZone stringnullable

    If the publicationFrequency is DAILY then this field will denote the timezone of publicationTime

    referenceRateParameters

    object

    nullable

    Reference rate specific parameters

    windowDuration stringnullable

    ISO8601 formatted duration of the observation window

    partitionCount int32nullable

    Number of partitions in the observation window

    inceptionDateTime date-timenullable

    Date time when this index was initially created

    launchDateTime date-timenullable

    Date time when this index was officially launched publically

    demiseDateTime date-timenullable

    If this index has been demised, then this field will be present and contain the date and time when it was demised.

    family stringnullable

    Family of the index

    exchanges string[]

    Constituent exchanges

Loading...