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

List withdrawals

GET 

/api/v2/withdrawals

Get a list of withdrawals for a given party

Request

Query Parameters

    partyId string

    Restrict withdrawals to those made by this party ID.

    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

    Whether to order the results with the newest records first. If not set, the default value is true.

    dateRange.startTimestamp int64

    Timestamp in Unix nanoseconds indicating the start of the date range.

    dateRange.endTimestamp int64

    Timestamp in Unix nanoseconds indicating the end of the date range.

Responses

A successful response.

Schema
    withdrawals object

    Page of withdrawals data and corresponding page information.

    edges object[]

    Page of withdrawals data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Data associated with a single withdrawal made from the Vega network.

    amount string

    Amount to be withdrawn. This field is an unsigned integer scaled to the asset's decimal places.

    asset string

    Asset to withdraw funds from.

    createdTimestamp int64

    Timestamp for when the network started to process this withdrawal.

    ext object

    Foreign chain specifics.

    erc20 object

    ERC20 withdrawal details.

    receiverAddress string

    Address into which the bridge will release the funds.

    id string

    Unique ID for the withdrawal.

    partyId string

    Unique party ID of the user initiating the withdrawal.

    ref string

    Reference which is used by the foreign chain to refer to this withdrawal.

    status Status of the withdrawal

    Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_REJECTED, STATUS_FINALIZED]

    Default value: STATUS_UNSPECIFIED

    Status of the withdrawal.

    txHash string

    Hash of the foreign chain for this transaction.

    withdrawnTimestamp int64

    Timestamp for when the withdrawal was finalised by the network.

  • ]
  • pageInfo object

    Page information that is used for fetching further pages.

    endCursor string

    End cursor.

    hasNextPage boolean

    Indicator if there is a next page.

    hasPreviousPage boolean

    Indicator if there is a previous page.

    startCursor string

    Start cursor.

Loading...