Observe positions

Subscribe to a stream of positions

Query Parameters

partyId string

Optional party ID to filter for. If empty, no parties will be filtered from the stream.

marketId string

Optional market ID to filter for. If empty, no markets will be filtered from the stream.

Responses

• 200
• 500
• default

---

A successful response.(streaming responses)

application/json

Schema

Example (from schema)

---

Schema

error object
code int32
details object[]
@type string
message string
result object
snapshot object
An 'initial image' snapshot containing current positions.
lastPage boolean
positions object[]
List of positions data.
averageEntryPrice string
lossSocialisationAmount string
marketId string
openVolume int64
partyId string
positionStatus Represents the status of a position
Possible values: [POSITION_STATUS_UNSPECIFIED, POSITION_STATUS_ORDERS_CLOSED, POSITION_STATUS_CLOSED_OUT, POSITION_STATUS_DISTRESSED]
realisedPnl string
unrealisedPnl string
updatedAt int64
updates object
List of position updates in the last block.
positions object[]
List of positions data.
averageEntryPrice string
lossSocialisationAmount string
marketId string
openVolume int64
partyId string
positionStatus Represents the status of a position
Possible values: [POSITION_STATUS_UNSPECIFIED, POSITION_STATUS_ORDERS_CLOSED, POSITION_STATUS_CLOSED_OUT, POSITION_STATUS_DISTRESSED]
realisedPnl string
unrealisedPnl string
updatedAt int64

{
  "error": {
    "code": 0,
    "details": [
      {
        "@type": "string"
      }
    ],
    "message": "string"
  },
  "result": {
    "snapshot": {
      "lastPage": true,
      "positions": [
        {
          "averageEntryPrice": "string",
          "lossSocialisationAmount": "string",
          "marketId": "string",
          "openVolume": "string",
          "partyId": "string",
          "positionStatus": "POSITION_STATUS_UNSPECIFIED",
          "realisedPnl": "string",
          "unrealisedPnl": "string",
          "updatedAt": "string"
        }
      ]
    },
    "updates": {
      "positions": [
        {
          "averageEntryPrice": "string",
          "lossSocialisationAmount": "string",
          "marketId": "string",
          "openVolume": "string",
          "partyId": "string",
          "positionStatus": "POSITION_STATUS_UNSPECIFIED",
          "realisedPnl": "string",
          "unrealisedPnl": "string",
          "updatedAt": "string"
        }
      ]
    }
  }
}

An internal server error

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

GET /api/v2/stream/positions

Request

Base URL

https://vega-mainnet-data.commodum.io

partyId — query

marketId — query

curl / cURL

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/positions' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/positions' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/positions' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/positions' \
-H 'Accept: application/json'