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

Observe positions

GET 
/api/v2/stream/positions

Subscribe to a stream of position updates. The first messages sent through the stream will contain information about current positions, followed by updates to those positions.

Request​

Query Parameters

    partyId string

    Restrict position updates to those related to the given parties.

    marketId string

    Restrict position updates to those related to the given markets.

Responses​

A successful response.(streaming responses)

Schema
    error object
    code int32
    details object[]
  • Array [
    • @type string

    A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

    In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

    • If no scheme is provided, https is assumed.
    • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
    • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

    Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

    Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • ]
    • message string
    result object
    snapshot object

    An 'initial image' snapshot containing current positions.

    lastPage boolean

    Indicator if last page is reached or not.

    positions object[]

    List of positions data.

  • Array [
    • averageEntryPrice string

    Average entry price for the position, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.

    lossSocialisationAmount string

    Sum of profit that could not be paid due to loss socialisation.

    marketId string

    Market ID in which the position is held.

    openVolume int64

    Open volume for the position, value is signed +ve for long and -ve for short.

    partyId string

    Party ID holding the position.

    positionStatus Represents the status of a position

    Possible values: [POSITION_STATUS_UNSPECIFIED, POSITION_STATUS_ORDERS_CLOSED, POSITION_STATUS_CLOSED_OUT, POSITION_STATUS_DISTRESSED]

    Default value: POSITION_STATUS_UNSPECIFIED

    Position status, indicating whether the party was distressed and had orders cancelled or was closed out.

    realisedPnl string

    Realised profit and loss for the position, value is signed +ve for long and -ve for short. This field is a signed integer scaled to the market's decimal places.

    unrealisedPnl string

    Unrealised profit and loss for the position, value is signed +ve for long and -ve for short. This field is a signed integer scaled to the market's decimal places.

    updatedAt int64

    Timestamp for the latest time the position was updated.

  • ]
    • updates object

    List of position updates in the last block.

    positions object[]

    List of positions data.

  • Array [
    • averageEntryPrice string

    Average entry price for the position, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.

    lossSocialisationAmount string

    Sum of profit that could not be paid due to loss socialisation.

    marketId string

    Market ID in which the position is held.

    openVolume int64

    Open volume for the position, value is signed +ve for long and -ve for short.

    partyId string

    Party ID holding the position.

    positionStatus Represents the status of a position

    Possible values: [POSITION_STATUS_UNSPECIFIED, POSITION_STATUS_ORDERS_CLOSED, POSITION_STATUS_CLOSED_OUT, POSITION_STATUS_DISTRESSED]

    Default value: POSITION_STATUS_UNSPECIFIED

    Position status, indicating whether the party was distressed and had orders cancelled or was closed out.

    realisedPnl string

    Realised profit and loss for the position, value is signed +ve for long and -ve for short. This field is a signed integer scaled to the market's decimal places.

    unrealisedPnl string

    Unrealised profit and loss for the position, value is signed +ve for long and -ve for short. This field is a signed integer scaled to the market's decimal places.

    updatedAt int64

    Timestamp for the latest time the position was updated.

  • ]
Loading...