List positions

Get a list of positions by party's public key using cursor based pagination

Query Parameters

filter.partyIds string[]

List of party IDs to filter on.

filter.marketIds string[]

List of market IDs to filter on.

pagination.first int32

Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

pagination.after string

If paging forwards, the cursor string for the last row of the previous page.

pagination.last int32

Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

pagination.before string

If paging forwards, the cursor string for the first row of the previous page.

pagination.newestFirst boolean

Newest records first, older records last, default is true.

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

positions object
Page of positions data and corresponding page information.
edges object[]
Page of positions data and their corresponding cursors.
cursor string
node object
Represents position data for a party on the specified market on Vega.
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
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "positions": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "averageEntryPrice": "string",
          "lossSocialisationAmount": "string",
          "marketId": "string",
          "openVolume": "string",
          "partyId": "string",
          "positionStatus": "POSITION_STATUS_UNSPECIFIED",
          "realisedPnl": "string",
          "unrealisedPnl": "string",
          "updatedAt": "string"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "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/positions

Request

Base URL

https://api.n06.testnet.vega.xyz

filter.partyIds — query

filter.marketIds — query

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

curl / cURL

curl -L -X GET 'https://api.n06.testnet.vega.xyz/api/v2/positions' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://api.n06.testnet.vega.xyz/api/v2/positions' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://api.n06.testnet.vega.xyz/api/v2/positions' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://api.n06.testnet.vega.xyz/api/v2/positions' \
-H 'Accept: application/json'