List transfers
GEThttps://vega-data.nodes.guru:3008/api/v2/transfers
Get a list of transfers between public keys. A valid value for public key can be one of:
- a party ID
- "network"
- "0000000000000000000000000000000000000000000000000000000000000000", the public key for the global rewards account
Request
Query Parameters
- 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
- SCOPE_INDIVIDUAL: Matches transfers that have dispatch strategy scope of individual set.
- SCOPE_TEAM: Matches transfers that have dispatch strategy scope of team set.
Restrict transfer to those where the given public key is a sender or receiver.
Possible values: [TRANSFER_DIRECTION_UNSPECIFIED
, TRANSFER_DIRECTION_TRANSFER_FROM
, TRANSFER_DIRECTION_TRANSFER_TO
, TRANSFER_DIRECTION_TRANSFER_TO_OR_FROM
]
Default value: TRANSFER_DIRECTION_UNSPECIFIED
Restrict transfers to those in the given direction from the supplied public key. When is_reward is true, and pubkey is set, then direction MUST be TRANSFER_DIRECTION_DIRECTION_FROM.
Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.
If paging forwards, the cursor string for the last row of the previous page.
Number of records to be returned that sort less than row identified by cursor supplied in 'before'.
If paging forwards, the cursor string for the first row of the previous page.
Whether to order the results with the newest records first. If not set, the default value is true.
Restrict transfers to those related to reward transfers.
Epoch to filter from (included). If omitted, the range goes from the oldest epoch to the to epoch
.
Epoch to filter to (included). If omitted, the range goes from from epoch
to the most recent epoch.
Possible values: [STATUS_UNSPECIFIED
, STATUS_PENDING
, STATUS_DONE
, STATUS_REJECTED
, STATUS_STOPPED
, STATUS_CANCELLED
]
Default value: STATUS_UNSPECIFIED
Status to filter on.
Possible values: [SCOPE_UNSPECIFIED
, SCOPE_INDIVIDUAL
, SCOPE_TEAM
]
Default value: SCOPE_UNSPECIFIED
Dispatch strategy's scope to filter for.
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
transfers object
{
"transfers": {
"edges": [
{
"cursor": "string",
"node": {
"fees": [
{
"amount": "string",
"discountApplied": "string",
"epoch": "string",
"transferId": "string"
}
],
"transfer": {
"amount": "string",
"asset": "string",
"from": "string",
"fromAccountType": "ACCOUNT_TYPE_UNSPECIFIED",
"gameId": "string",
"id": "string",
"oneOff": {
"deliverOn": "string"
},
"oneOffGovernance": {
"deliverOn": "string"
},
"reason": "string",
"recurring": {
"dispatchStrategy": {
"assetForMetric": "string",
"distributionStrategy": "DISTRIBUTION_STRATEGY_UNSPECIFIED",
"entityScope": "ENTITY_SCOPE_UNSPECIFIED",
"individualScope": "INDIVIDUAL_SCOPE_UNSPECIFIED",
"lockPeriod": "string",
"markets": [
"string"
],
"metric": "DISPATCH_METRIC_UNSPECIFIED",
"nTopPerformers": "string",
"notionalTimeWeightedAveragePositionRequirement": "string",
"rankTable": [
{
"shareRatio": 0,
"startRank": 0
}
],
"stakingRequirement": "string",
"teamScope": [
"string"
],
"windowLength": "string"
},
"endEpoch": "string",
"factor": "string",
"startEpoch": "string"
},
"recurringGovernance": {
"dispatchStrategy": {
"assetForMetric": "string",
"distributionStrategy": "DISTRIBUTION_STRATEGY_UNSPECIFIED",
"entityScope": "ENTITY_SCOPE_UNSPECIFIED",
"individualScope": "INDIVIDUAL_SCOPE_UNSPECIFIED",
"lockPeriod": "string",
"markets": [
"string"
],
"metric": "DISPATCH_METRIC_UNSPECIFIED",
"nTopPerformers": "string",
"notionalTimeWeightedAveragePositionRequirement": "string",
"rankTable": [
{
"shareRatio": 0,
"startRank": 0
}
],
"stakingRequirement": "string",
"teamScope": [
"string"
],
"windowLength": "string"
},
"endEpoch": "string",
"startEpoch": "string"
},
"reference": "string",
"status": "STATUS_UNSPECIFIED",
"timestamp": "string",
"to": "string",
"toAccountType": "ACCOUNT_TYPE_UNSPECIFIED"
}
}
}
],
"pageInfo": {
"endCursor": "string",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string"
}
}
}
An internal server error
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
- curl
- python
- go
- nodejs
- CURL
curl -L -X GET 'https://vega-data.nodes.guru:3008/api/v2/transfers' \
-H 'Accept: application/json'