List transfers
GET/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.
- ACCOUNT_TYPE_UNSPECIFIED: Default value
- ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
- ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
- ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
- ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
- ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
- ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
- ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
- ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
- ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
- ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
- ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
- ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
- ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
- ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
- ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
- ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
- ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
- ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
- ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
- ACCOUNT_TYPE_NETWORK_TREASURY: Network controlled treasury
- ACCOUNT_TYPE_VESTING_REWARDS: Account holding user's rewards for the vesting period
- ACCOUNT_TYPE_VESTED_REWARDS: Account holding user's rewards after the vesting period
- ACCOUNT_TYPE_REWARD_AVERAGE_POSITION: Per asset market reward account given for average position
- ACCOUNT_TYPE_REWARD_RELATIVE_RETURN: Per asset market reward account given for relative return
- ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY: Per asset market reward account given for return volatility
- ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING: Per asset market reward account given to validators by their ranking
- ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD: Per asset account for pending fee referral reward payouts
- ACCOUNT_TYPE_ORDER_MARGIN: Per asset market account for party in isolated margin mode
- ACCOUNT_TYPE_REWARD_REALISED_RETURN: Per asset market reward account for realised return
- ACCOUNT_TYPE_UNSPECIFIED: Default value
- ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
- ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
- ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
- ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
- ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
- ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
- ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
- ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
- ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
- ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
- ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
- ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
- ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
- ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
- ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
- ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
- ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
- ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
- ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
- ACCOUNT_TYPE_NETWORK_TREASURY: Network controlled treasury
- ACCOUNT_TYPE_VESTING_REWARDS: Account holding user's rewards for the vesting period
- ACCOUNT_TYPE_VESTED_REWARDS: Account holding user's rewards after the vesting period
- ACCOUNT_TYPE_REWARD_AVERAGE_POSITION: Per asset market reward account given for average position
- ACCOUNT_TYPE_REWARD_RELATIVE_RETURN: Per asset market reward account given for relative return
- ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY: Per asset market reward account given for return volatility
- ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING: Per asset market reward account given to validators by their ranking
- ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD: Per asset account for pending fee referral reward payouts
- ACCOUNT_TYPE_ORDER_MARGIN: Per asset market account for party in isolated margin mode
- ACCOUNT_TYPE_REWARD_REALISED_RETURN: Per asset market reward account for realised return
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.
Game ID to filter on.
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
, ACCOUNT_TYPE_HOLDING
, ACCOUNT_TYPE_LP_LIQUIDITY_FEES
, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION
, ACCOUNT_TYPE_NETWORK_TREASURY
, ACCOUNT_TYPE_VESTING_REWARDS
, ACCOUNT_TYPE_VESTED_REWARDS
, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION
, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN
, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY
, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING
, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD
, ACCOUNT_TYPE_ORDER_MARGIN
, ACCOUNT_TYPE_REWARD_REALISED_RETURN
]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type to filter on for transfers from account.
Margin account funds will vary as margin requirements on positions change
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
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
, ACCOUNT_TYPE_HOLDING
, ACCOUNT_TYPE_LP_LIQUIDITY_FEES
, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION
, ACCOUNT_TYPE_NETWORK_TREASURY
, ACCOUNT_TYPE_VESTING_REWARDS
, ACCOUNT_TYPE_VESTED_REWARDS
, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION
, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN
, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY
, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING
, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD
, ACCOUNT_TYPE_ORDER_MARGIN
, ACCOUNT_TYPE_REWARD_REALISED_RETURN
]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type to filter on for transfers to account.
Margin account funds will vary as margin requirements on positions change
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
Responses
- 200
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ACCOUNT_TYPE_UNSPECIFIED: Default value
- ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
- ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
- ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
- ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
- ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
- ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
- ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
- ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
- ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
- ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
- ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
- ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
- ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
- ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
- ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
- ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
- ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
- ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
- ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
- ACCOUNT_TYPE_NETWORK_TREASURY: Network controlled treasury
- ACCOUNT_TYPE_VESTING_REWARDS: Account holding user's rewards for the vesting period
- ACCOUNT_TYPE_VESTED_REWARDS: Account holding user's rewards after the vesting period
- ACCOUNT_TYPE_REWARD_AVERAGE_POSITION: Per asset market reward account given for average position
- ACCOUNT_TYPE_REWARD_RELATIVE_RETURN: Per asset market reward account given for relative return
- ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY: Per asset market reward account given for return volatility
- ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING: Per asset market reward account given to validators by their ranking
- ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD: Per asset account for pending fee referral reward payouts
- ACCOUNT_TYPE_ORDER_MARGIN: Per asset market account for party in isolated margin mode
- ACCOUNT_TYPE_REWARD_REALISED_RETURN: Per asset market reward account for realised return
- DISTRIBUTION_STRATEGY_PRO_RATA: Rewards funded using the pro-rata strategy should be distributed pro-rata by each entity's reward metric, scaled by any active multipliers that party has.
- DISTRIBUTION_STRATEGY_RANK: Rewards funded using the party rank.
- Array [
- ]
- DISTRIBUTION_STRATEGY_PRO_RATA: Rewards funded using the pro-rata strategy should be distributed pro-rata by each entity's reward metric, scaled by any active multipliers that party has.
- DISTRIBUTION_STRATEGY_RANK: Rewards funded using the party rank.
- Array [
- ]
- ACCOUNT_TYPE_UNSPECIFIED: Default value
- ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
- ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
- ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
- ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
- ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
- ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
- ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
- ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
- ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
- ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
- ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
- ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
- ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
- ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
- ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
- ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
- ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
- ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
- ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
- ACCOUNT_TYPE_NETWORK_TREASURY: Network controlled treasury
- ACCOUNT_TYPE_VESTING_REWARDS: Account holding user's rewards for the vesting period
- ACCOUNT_TYPE_VESTED_REWARDS: Account holding user's rewards after the vesting period
- ACCOUNT_TYPE_REWARD_AVERAGE_POSITION: Per asset market reward account given for average position
- ACCOUNT_TYPE_REWARD_RELATIVE_RETURN: Per asset market reward account given for relative return
- ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY: Per asset market reward account given for return volatility
- ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING: Per asset market reward account given to validators by their ranking
- ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD: Per asset account for pending fee referral reward payouts
- ACCOUNT_TYPE_ORDER_MARGIN: Per asset market account for party in isolated margin mode
- ACCOUNT_TYPE_REWARD_REALISED_RETURN: Per asset market reward account for realised return
- ]
transfers object
Page of transfers data and corresponding page information.
edges object[]
Page of transfers data and their corresponding cursors.
Cursor that can be used to fetch further pages.
node object
Data relating to a transfer that has been made.
fees object[]
Fees paid for this transfer.
Amount of fees paid.
Amount that was subtracted from the transfer fee based on available discounts.
Epoch when the transfer was dispatched, and fees were paid.
Transfer that triggered the collection of fees.
transfer object
Data relating to a transfer that has been made.
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
, ACCOUNT_TYPE_HOLDING
, ACCOUNT_TYPE_LP_LIQUIDITY_FEES
, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION
, ACCOUNT_TYPE_NETWORK_TREASURY
, ACCOUNT_TYPE_VESTING_REWARDS
, ACCOUNT_TYPE_VESTED_REWARDS
, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION
, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN
, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY
, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING
, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD
, ACCOUNT_TYPE_ORDER_MARGIN
, ACCOUNT_TYPE_REWARD_REALISED_RETURN
]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Margin account funds will vary as margin requirements on positions change
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
oneOff object
oneOffGovernance object
recurring object
dispatchStrategy object
Asset to use for metric.
If set, the actual amount of rewards transferred to each public key during distribution for this transfer will be `min(calculated_reward_in_quantum, cap_reward_fee_multiple × fees_paid_this_epoch_in_quantum).
Possible values: [DISTRIBUTION_STRATEGY_UNSPECIFIED
, DISTRIBUTION_STRATEGY_PRO_RATA
, DISTRIBUTION_STRATEGY_RANK
]
Default value: DISTRIBUTION_STRATEGY_UNSPECIFIED
Possible values: [ENTITY_SCOPE_UNSPECIFIED
, ENTITY_SCOPE_INDIVIDUALS
, ENTITY_SCOPE_TEAMS
]
Default value: ENTITY_SCOPE_UNSPECIFIED
Mandatory enum that defines the entities within scope.
Possible values: [INDIVIDUAL_SCOPE_UNSPECIFIED
, INDIVIDUAL_SCOPE_ALL
, INDIVIDUAL_SCOPE_IN_TEAM
, INDIVIDUAL_SCOPE_NOT_IN_TEAM
, INDIVIDUAL_SCOPE_AMM
]
Default value: INDIVIDUAL_SCOPE_UNSPECIFIED
Optional enum if the entity scope defined is for individuals, which determines the subset of individuals that are eligible to be rewarded.
Optional markets in scope.
Possible values: [DISPATCH_METRIC_UNSPECIFIED
, DISPATCH_METRIC_MAKER_FEES_PAID
, DISPATCH_METRIC_MAKER_FEES_RECEIVED
, DISPATCH_METRIC_LP_FEES_RECEIVED
, DISPATCH_METRIC_MARKET_VALUE
, DISPATCH_METRIC_AVERAGE_POSITION
, DISPATCH_METRIC_RELATIVE_RETURN
, DISPATCH_METRIC_RETURN_VOLATILITY
, DISPATCH_METRIC_VALIDATOR_RANKING
, DISPATCH_METRIC_REALISED_RETURN
]
Default value: DISPATCH_METRIC_UNSPECIFIED
Metric to apply.
rankTable object[]
Ordered list, using start rank, defining the rank bands and share ratio for each band. Mandatory for the rank distribution strategy.
Number of epochs between transfers, i.e. when 4, funds will be transferred every 4 epochs with the first transfer occurring 4 epochs after the transaction is processed.
recurringGovernance object
dispatchStrategy object
Asset to use for metric.
If set, the actual amount of rewards transferred to each public key during distribution for this transfer will be `min(calculated_reward_in_quantum, cap_reward_fee_multiple × fees_paid_this_epoch_in_quantum).
Possible values: [DISTRIBUTION_STRATEGY_UNSPECIFIED
, DISTRIBUTION_STRATEGY_PRO_RATA
, DISTRIBUTION_STRATEGY_RANK
]
Default value: DISTRIBUTION_STRATEGY_UNSPECIFIED
Possible values: [ENTITY_SCOPE_UNSPECIFIED
, ENTITY_SCOPE_INDIVIDUALS
, ENTITY_SCOPE_TEAMS
]
Default value: ENTITY_SCOPE_UNSPECIFIED
Mandatory enum that defines the entities within scope.
Possible values: [INDIVIDUAL_SCOPE_UNSPECIFIED
, INDIVIDUAL_SCOPE_ALL
, INDIVIDUAL_SCOPE_IN_TEAM
, INDIVIDUAL_SCOPE_NOT_IN_TEAM
, INDIVIDUAL_SCOPE_AMM
]
Default value: INDIVIDUAL_SCOPE_UNSPECIFIED
Optional enum if the entity scope defined is for individuals, which determines the subset of individuals that are eligible to be rewarded.
Optional markets in scope.
Possible values: [DISPATCH_METRIC_UNSPECIFIED
, DISPATCH_METRIC_MAKER_FEES_PAID
, DISPATCH_METRIC_MAKER_FEES_RECEIVED
, DISPATCH_METRIC_LP_FEES_RECEIVED
, DISPATCH_METRIC_MARKET_VALUE
, DISPATCH_METRIC_AVERAGE_POSITION
, DISPATCH_METRIC_RELATIVE_RETURN
, DISPATCH_METRIC_RETURN_VOLATILITY
, DISPATCH_METRIC_VALIDATOR_RANKING
, DISPATCH_METRIC_REALISED_RETURN
]
Default value: DISPATCH_METRIC_UNSPECIFIED
Metric to apply.
rankTable object[]
Ordered list, using start rank, defining the rank bands and share ratio for each band. Mandatory for the rank distribution strategy.
Number of epochs between transfers, i.e. when 4, funds will be transferred every 4 epochs with the first transfer occurring 4 epochs after the transaction is processed.
Possible values: [STATUS_UNSPECIFIED
, STATUS_PENDING
, STATUS_DONE
, STATUS_REJECTED
, STATUS_STOPPED
, STATUS_CANCELLED
]
Default value: STATUS_UNSPECIFIED
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
, ACCOUNT_TYPE_HOLDING
, ACCOUNT_TYPE_LP_LIQUIDITY_FEES
, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION
, ACCOUNT_TYPE_NETWORK_TREASURY
, ACCOUNT_TYPE_VESTING_REWARDS
, ACCOUNT_TYPE_VESTED_REWARDS
, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION
, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN
, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY
, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING
, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD
, ACCOUNT_TYPE_ORDER_MARGIN
, ACCOUNT_TYPE_REWARD_REALISED_RETURN
]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Margin account funds will vary as margin requirements on positions change
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
pageInfo object
Page information that is used for fetching further pages.
End cursor.
Indicator if there is a next page.
Indicator if there is a previous page.
Start cursor.
{
"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",
"capRewardFeeMultiple": "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"
],
"transferInterval": 0,
"windowLength": "string"
},
"endEpoch": "string",
"factor": "string",
"startEpoch": "string"
},
"recurringGovernance": {
"dispatchStrategy": {
"assetForMetric": "string",
"capRewardFeeMultiple": "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"
],
"transferInterval": 0,
"windowLength": "string"
},
"endEpoch": "string",
"factor": "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
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}