Skip to main content
Version: testnet (v0.71)

List transfers​

Get a list of transfers to/from/either a public key

Query Parameters
    pubkey string

    Public key for which to request transfers, this can be a party ID, "0000000000000000000000000000000000000000000000000000000000000000" for the global rewards account, or "network".

    direction string

    Possible values: [TRANSFER_DIRECTION_UNSPECIFIED, TRANSFER_DIRECTION_TRANSFER_FROM, TRANSFER_DIRECTION_TRANSFER_TO, TRANSFER_DIRECTION_TRANSFER_TO_OR_FROM]

    Default value: TRANSFER_DIRECTION_UNSPECIFIED

    Transfer directions - i.e. sender, receiver - to include in the response data.

    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

A successful response.

Schema
    transfers object

    Page of transfers data and corresponding page information.

    edges object[]

    Page of transfers data and their corresponding cursors.

    cursor string
    node object

    Data relating to a transfer that has been made.

    amount string
    asset string
    from string
    fromAccountType Various collateral/account types as used by Vega

    Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS]

    id string
    oneOff object
    deliverOn int64
    reason string
    recurring object
    dispatchStrategy object
    assetForMetric string
    markets string[]
    metric - DISPATCH_METRIC_MAKER_FEES_PAID: Dispatch metric that is using the total maker fees paid in the market - DISPATCH_METRIC_MAKER_FEES_RECEIVED: Dispatch metric that is using the total maker fees received in the market - DISPATCH_METRIC_LP_FEES_RECEIVED: Dispatch metric that is using the total LP fees received in the market - DISPATCH_METRIC_MARKET_VALUE: Dispatch metric that is using total value of the market if above the required threshold and not paid given proposer bonus yet

    Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE]

    endEpoch uint64
    factor string
    startEpoch uint64
    reference string
    status - STATUS_UNSPECIFIED: Default value - STATUS_PENDING: Indicates a transfer still being processed - STATUS_DONE: Indicates a transfer accepted by the Vega network - STATUS_REJECTED: Indicates a transfer rejected by the Vega network - STATUS_STOPPED: Indicates a transfer stopped by the Vega network e.g: no funds left to cover the transfer - STATUS_CANCELLED: Indicates a transfer cancelled by the user

    Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_DONE, STATUS_REJECTED, STATUS_STOPPED, STATUS_CANCELLED]

    timestamp int64
    to string
    toAccountType Various collateral/account types as used by Vega

    Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS]

    pageInfo object

    Page information that is used for fetching further pages.

    endCursor string
    hasNextPage boolean
    hasPreviousPage boolean
    startCursor string
GET /api/v2/transfers

Request

Base URL
https://api.n06.testnet.vega.xyz
pubkey — query
direction — query
pagination.first — query
pagination.after — query
pagination.last — query
pagination.before — query
pagination.newestFirst — query
curl / cURL
curl -L -X GET 'https://api.n06.testnet.vega.xyz/api/v2/transfers' \
-H 'Accept: application/json'