Skip to main content
Version: mainnet (v0.71)

Get market​

Get information about a specific market using its ID. Use the market lists query to get a market's ID

Path Parameters
    marketId string required

    Market ID of the market to retrieve data for.

Responses

A successful response.

Schema
    market object

    Information about the market requested.

    decimalPlaces uint64
    fees object

    Fees configuration that apply to the market.

    factors object

    Fee factors.

    infrastructureFee string
    liquidityFee string
    makerFee string
    id string
    linearSlippageFactor string
    liquidityMonitoringParameters object

    LiquidityMonitoringParameters for the market.

    auctionExtension int64
    targetStakeParameters object

    Specifies parameters related to target stake calculation.

    scalingFactor double
    timeWindow int64
    triggeringRatio string
    lpPriceRange string
    marketTimestamps object

    Timestamps for when the market state changes.

    close int64
    open int64
    pending int64
    proposed int64
    openingAuction object

    Auction duration specifies how long the opening auction will run (minimum duration and optionally a minimum traded volume).

    duration int64
    volume uint64
    positionDecimalPlaces int64
    priceMonitoringSettings object

    PriceMonitoringSettings for the market.

    parameters object

    Specifies price monitoring parameters to be used for price monitoring purposes.

    triggers object[]
    auctionExtension int64
    horizon int64
    probability string
    quadraticSlippageFactor string
    state Current state of the market

    Possible values: [STATE_UNSPECIFIED, STATE_PROPOSED, STATE_REJECTED, STATE_PENDING, STATE_CANCELLED, STATE_ACTIVE, STATE_SUSPENDED, STATE_CLOSED, STATE_TRADING_TERMINATED, STATE_SETTLED]

    tradableInstrument object

    Tradable instrument configuration.

    instrument object

    Details for the underlying instrument.

    code string
    future object

    Future.

    dataSourceSpecBinding object

    Binding between the data spec and the data source.

    settlementDataProperty string
    tradingTerminationProperty string
    dataSourceSpecForSettlementData object

    Data source specification that describes the settlement data source filter.

    createdAt int64
    data object

    DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.

    external object

    DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.

    oracle object

    All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.

    filters object[]

    Filters describes which source data are considered of interest or not for the product (or the risk model).

    conditions object[]

    Conditions that should be matched by the data to be considered of interest.

    operator string

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

    value string
    key object

    Data source's data property key targeted by the filter.

    name string
    numberDecimalPlaces uint64
    type string

    Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]

    signers object[]

    Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.

    ethAddress object
    address string
    pubKey object

    List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.

    key string
    internal object

    DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.

    time object

    DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.

    conditions object[]

    Conditions that the timestamps should meet in order to be considered.

    operator string

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

    value string
    id string
    status Status describes the status of the data source spec

    Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]

    updatedAt int64
    dataSourceSpecForTradingTermination object

    Data source specification that describes the trading termination data source filter.

    createdAt int64
    data object

    DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.

    external object

    DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.

    oracle object

    All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.

    filters object[]

    Filters describes which source data are considered of interest or not for the product (or the risk model).

    conditions object[]

    Conditions that should be matched by the data to be considered of interest.

    operator string

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

    value string
    key object

    Data source's data property key targeted by the filter.

    name string
    numberDecimalPlaces uint64
    type string

    Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]

    signers object[]

    Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.

    ethAddress object
    address string
    pubKey object

    List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.

    key string
    internal object

    DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.

    time object

    DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.

    conditions object[]

    Conditions that the timestamps should meet in order to be considered.

    operator string

    Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]

    value string
    id string
    status Status describes the status of the data source spec

    Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]

    updatedAt int64
    quoteName string
    settlementAsset string
    id string
    metadata object

    Collection of instrument meta-data.

    tags string[]
    name string
    logNormalRiskModel object

    Log normal.

    params object

    Risk model parameters for log normal.

    mu double
    r double
    sigma double
    riskAversionParameter double
    tau double
    marginCalculator object

    Margin calculator for the instrument.

    scalingFactors object

    Scaling factors for margin calculation.

    collateralRelease double
    initialMargin double
    searchLevel double
    simpleRiskModel object

    Simple.

    params object

    Risk model params for simple modelling.

    factorLong double
    factorShort double
    maxMoveUp double
    minMoveDown double
    probabilityOfTrading double
    tradingMode Trading mode the market is currently running, also referred to as 'market state'

    Possible values: [TRADING_MODE_UNSPECIFIED, TRADING_MODE_CONTINUOUS, TRADING_MODE_BATCH_AUCTION, TRADING_MODE_OPENING_AUCTION, TRADING_MODE_MONITORING_AUCTION, TRADING_MODE_NO_TRADING]

Loading...