List deposits

Get a list of deposits for a given party. If a date range is provided, filtering will be based on the last time the deposit has been updated in Vega time.

Query Parameters

partyId string

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

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

deposits object
Page of deposits data and corresponding page information.
edges object[]
Page of deposits data and their corresponding cursors.
cursor string
node object
Data associated with a single deposit made on the Vega network.
amount string
asset string
createdTimestamp int64
creditedTimestamp int64
id string
partyId string
status Status of the deposit
Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_CANCELLED, STATUS_FINALIZED]
txHash string
pageInfo object
Page information that is used for fetching further pages.
endCursor string
hasNextPage boolean
hasPreviousPage boolean
startCursor string

{
  "deposits": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "amount": "string",
          "asset": "string",
          "createdTimestamp": "string",
          "creditedTimestamp": "string",
          "id": "string",
          "partyId": "string",
          "status": "STATUS_UNSPECIFIED",
          "txHash": "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/deposits

Request

Base URL

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

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://api.n06.testnet.vega.xyz/api/v2/deposits' \
-H 'Accept: application/json'

python / requests

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

go / native

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

nodejs / axios

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