List withdrawals

Get a list of withdrawals for a given party

Query Parameters

partyId string

Party ID whose withdrawals are to retrieved. If not provided, withdrawals for all parties will be returned.

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.

dateRange.startTimestamp int64
dateRange.endTimestamp int64

Responses

• 200
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

withdrawals object
Page of withdrawals data and corresponding page information.
edges object[]
Page of withdrawals data and their corresponding cursors.
cursor string
node object
Data associated with a single withdrawal made from the Vega network.
amount string
asset string
createdTimestamp int64
ext object
Foreign chain specifics.
erc20 object
ERC20 withdrawal details.
receiverAddress string
id string
partyId string
ref string
status Status of the withdrawal
Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_REJECTED, STATUS_FINALIZED]
txHash string
withdrawnTimestamp int64
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "withdrawals": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "asset": "string",
          "createdTimestamp": "string",
          "ext": {
            "erc20": {
              "receiverAddress": "string"
            }
          },
          "id": "string",
          "partyId": "string",
          "ref": "string",
          "status": "STATUS_UNSPECIFIED",
          "txHash": "string",
          "withdrawnTimestamp": "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/withdrawals

Request

Base URL

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

partyId — query

pagination.first — query

pagination.after — query

pagination.last — query

pagination.before — query

pagination.newestFirst — query

---truefalse

dateRange.startTimestamp — query

dateRange.endTimestamp — query

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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