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

pubkey string

Restrict transfer to those where the given public key is a sender or receiver.

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

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.

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.

isReward boolean

Restrict transfers to those related to reward transfers.

fromEpoch uint64

Epoch to filter from (included). If omitted, the range goes from the oldest epoch to the to epoch.

toEpoch uint64

Epoch to filter to (included). If omitted, the range goes from from epoch to the most recent epoch.

status string
Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_DONE, STATUS_REJECTED, STATUS_STOPPED, STATUS_CANCELLED]
Default value: STATUS_UNSPECIFIED
Status to filter on.
• 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 string
Possible values: [SCOPE_UNSPECIFIED, SCOPE_INDIVIDUAL, SCOPE_TEAM]
Default value: SCOPE_UNSPECIFIED
Dispatch strategy's scope to filter for.
• SCOPE_INDIVIDUAL: Matches transfers that have dispatch strategy scope of individual set.
• SCOPE_TEAM: Matches transfers that have dispatch strategy scope of team set.
gameId string

Game ID to filter on.

fromAccountType string
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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES, ACCOUNT_TYPE_LOCKED_FOR_STAKING]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type to filter on for transfers from account.
• 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'
Margin account funds will vary as margin requirements on positions change
• 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
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
• 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_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_BUY_BACK_FEES: Per asset account for paid buy-back fees
• ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL: Per asset market reward account given for average notional
• ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES: Reward account for the eligible entities metric.
• ACCOUNT_TYPE_LOCKED_FOR_STAKING: Account for assets that are locked for staking.
toAccountType string
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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES, ACCOUNT_TYPE_LOCKED_FOR_STAKING]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type to filter on for transfers to account.
• 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'
Margin account funds will vary as margin requirements on positions change
• 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
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
• 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_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_BUY_BACK_FEES: Per asset account for paid buy-back fees
• ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL: Per asset market reward account given for average notional
• ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES: Reward account for the eligible entities metric.
• ACCOUNT_TYPE_LOCKED_FOR_STAKING: Account for assets that are locked for staking.

Responses

200

A successful response.

application/json

Schema

Schema

transfers object

Page of transfers data and corresponding page information.

edges object[]

Page of transfers data and their corresponding cursors.

Array [

cursor string

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.

Array [

amount string

Amount of fees paid.

discountApplied string

Amount that was subtracted from the transfer fee based on available discounts.

epoch uint64

Epoch when the transfer was dispatched, and fees were paid.

transferId string

Transfer that triggered the collection of fees.

]

transfer 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 (string)

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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES, ACCOUNT_TYPE_LOCKED_FOR_STAKING]

Default value: ACCOUNT_TYPE_UNSPECIFIED

• 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'

Margin account funds will vary as margin requirements on positions change

• 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

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

• 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_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_BUY_BACK_FEES: Per asset account for paid buy-back fees
• ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL: Per asset market reward account given for average notional
• ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES: Reward account for the eligible entities metric.
• ACCOUNT_TYPE_LOCKED_FOR_STAKING: Account for assets that are locked for staking.

gameId ID of the game this transfer was made in relation to. A transfer is made to members of a team or participants who take part in a game and are rewarded for their participation (string)

id string

oneOff object

deliverOn int64

oneOffGovernance object

deliverOn int64

reason string

recurring object

dispatchStrategy object

assetForMetric string

Asset to use for metric.

capRewardFeeMultiple string

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).

distributionStrategy Controls how the reward is distributed between qualifying parties (string)

Possible values: [DISTRIBUTION_STRATEGY_UNSPECIFIED, DISTRIBUTION_STRATEGY_PRO_RATA, DISTRIBUTION_STRATEGY_RANK, DISTRIBUTION_STRATEGY_RANK_LOTTERY]

Default value: DISTRIBUTION_STRATEGY_UNSPECIFIED

• 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.
• DISTRIBUTION_STRATEGY_RANK_LOTTERY: Rewards funded using the ranked lottery.

eligibleKeys string[]

A list of party keys to constrain the potential receivers of a reward transfer.

entityScope - ENTITY_SCOPE_INDIVIDUALS: Rewards must be distributed directly to eligible parties. - ENTITY_SCOPE_TEAMS: Rewards must be distributed to directly eligible teams, and then amongst team members (string)

Possible values: [ENTITY_SCOPE_UNSPECIFIED, ENTITY_SCOPE_INDIVIDUALS, ENTITY_SCOPE_TEAMS]

Default value: ENTITY_SCOPE_UNSPECIFIED

Mandatory enum that defines the entities within scope.

individualScope vegaIndividualScope (string)

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.

lockPeriod uint64

markets string[]

Optional markets in scope.

metric - DISPATCH_METRIC_MAKER_FEES_PAID: Dispatch metric that uses the total maker fees paid in the market - DISPATCH_METRIC_MAKER_FEES_RECEIVED: Dispatch metric that uses the total maker fees received in the market - DISPATCH_METRIC_LP_FEES_RECEIVED: Dispatch metric that uses the total LP fees received in the market - DISPATCH_METRIC_MARKET_VALUE: Dispatch metric that uses total value of the market if above the required threshold and not paid given proposer bonus yet - DISPATCH_METRIC_RELATIVE_RETURN: Dispatch metric that uses the relative PNL of the party in the market - DISPATCH_METRIC_RETURN_VOLATILITY: Dispatch metric that uses return volatility of the party in the market - DISPATCH_METRIC_VALIDATOR_RANKING: Dispatch metric that uses the validator ranking of the validator as metric - DISPATCH_METRIC_REALISED_RETURN: Dispatch metric that uses the realised return of the party in a market - DISPATCH_METRIC_AVERAGE_NOTIONAL: Dispatch metric that uses the time weighted average notional - DISPATCH_METRIC_ELIGIBLE_ENTITIES: Dispatch metric that uses the eligibility criteria of entities (string)

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_RELATIVE_RETURN, DISPATCH_METRIC_RETURN_VOLATILITY, DISPATCH_METRIC_VALIDATOR_RANKING, DISPATCH_METRIC_REALISED_RETURN, DISPATCH_METRIC_AVERAGE_NOTIONAL, DISPATCH_METRIC_ELIGIBLE_ENTITIES]

Default value: DISPATCH_METRIC_UNSPECIFIED

Metric to apply.

nTopPerformers The proportion of the top performers in the team for a given metric to be averaged for the metric calculation if the scope is team (string)

notionalTimeWeightedAveragePositionRequirement Minimum notional time-weighted averaged position required for a party to be considered eligible. Defaults to 0 (string)

rankTable object[]

Ordered list, using start rank, defining the rank bands and share ratio for each band. Mandatory for the rank and rank lottery distribution strategies.

Array [

shareRatio int64

startRank int64

]

stakingRequirement Minimum number of governance (e.g. VEGA) tokens staked for a party to be considered eligible. Defaults to 0 (string)

targetNotionalVolume If set, the target notional factor used to scale the amount to be taken from the source account (string)

teamScope string[]

transferInterval int32

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.

windowLength uint64

endEpoch uint64

factor string

startEpoch uint64

recurringGovernance object

dispatchStrategy object

assetForMetric string

Asset to use for metric.

capRewardFeeMultiple string

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).

distributionStrategy Controls how the reward is distributed between qualifying parties (string)

Possible values: [DISTRIBUTION_STRATEGY_UNSPECIFIED, DISTRIBUTION_STRATEGY_PRO_RATA, DISTRIBUTION_STRATEGY_RANK, DISTRIBUTION_STRATEGY_RANK_LOTTERY]

Default value: DISTRIBUTION_STRATEGY_UNSPECIFIED

• 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.
• DISTRIBUTION_STRATEGY_RANK_LOTTERY: Rewards funded using the ranked lottery.

eligibleKeys string[]

A list of party keys to constrain the potential receivers of a reward transfer.

entityScope - ENTITY_SCOPE_INDIVIDUALS: Rewards must be distributed directly to eligible parties. - ENTITY_SCOPE_TEAMS: Rewards must be distributed to directly eligible teams, and then amongst team members (string)

Possible values: [ENTITY_SCOPE_UNSPECIFIED, ENTITY_SCOPE_INDIVIDUALS, ENTITY_SCOPE_TEAMS]

Default value: ENTITY_SCOPE_UNSPECIFIED

Mandatory enum that defines the entities within scope.

individualScope vegaIndividualScope (string)

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.

lockPeriod uint64

markets string[]

Optional markets in scope.

metric - DISPATCH_METRIC_MAKER_FEES_PAID: Dispatch metric that uses the total maker fees paid in the market - DISPATCH_METRIC_MAKER_FEES_RECEIVED: Dispatch metric that uses the total maker fees received in the market - DISPATCH_METRIC_LP_FEES_RECEIVED: Dispatch metric that uses the total LP fees received in the market - DISPATCH_METRIC_MARKET_VALUE: Dispatch metric that uses total value of the market if above the required threshold and not paid given proposer bonus yet - DISPATCH_METRIC_RELATIVE_RETURN: Dispatch metric that uses the relative PNL of the party in the market - DISPATCH_METRIC_RETURN_VOLATILITY: Dispatch metric that uses return volatility of the party in the market - DISPATCH_METRIC_VALIDATOR_RANKING: Dispatch metric that uses the validator ranking of the validator as metric - DISPATCH_METRIC_REALISED_RETURN: Dispatch metric that uses the realised return of the party in a market - DISPATCH_METRIC_AVERAGE_NOTIONAL: Dispatch metric that uses the time weighted average notional - DISPATCH_METRIC_ELIGIBLE_ENTITIES: Dispatch metric that uses the eligibility criteria of entities (string)

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_RELATIVE_RETURN, DISPATCH_METRIC_RETURN_VOLATILITY, DISPATCH_METRIC_VALIDATOR_RANKING, DISPATCH_METRIC_REALISED_RETURN, DISPATCH_METRIC_AVERAGE_NOTIONAL, DISPATCH_METRIC_ELIGIBLE_ENTITIES]

Default value: DISPATCH_METRIC_UNSPECIFIED

Metric to apply.

nTopPerformers The proportion of the top performers in the team for a given metric to be averaged for the metric calculation if the scope is team (string)

notionalTimeWeightedAveragePositionRequirement Minimum notional time-weighted averaged position required for a party to be considered eligible. Defaults to 0 (string)

rankTable object[]

Ordered list, using start rank, defining the rank bands and share ratio for each band. Mandatory for the rank and rank lottery distribution strategies.

Array [

shareRatio int64

startRank int64

]

stakingRequirement Minimum number of governance (e.g. VEGA) tokens staked for a party to be considered eligible. Defaults to 0 (string)

targetNotionalVolume If set, the target notional factor used to scale the amount to be taken from the source account (string)

teamScope string[]

transferInterval int32

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.

windowLength uint64

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 (string)

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

Default value: STATUS_UNSPECIFIED

timestamp int64

to string

toAccountType Various collateral/account types as used by Vega (string)

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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES, ACCOUNT_TYPE_LOCKED_FOR_STAKING]

Default value: ACCOUNT_TYPE_UNSPECIFIED

• 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'

Margin account funds will vary as margin requirements on positions change

• 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

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

• 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_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_BUY_BACK_FEES: Per asset account for paid buy-back fees
• ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL: Per asset market reward account given for average notional
• ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES: Reward account for the eligible entities metric.
• ACCOUNT_TYPE_LOCKED_FOR_STAKING: Account for assets that are locked for staking.

]

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.

Example (from schema)

{
  "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",
                "eligibleKeys": [
                  "string"
                ],
                "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",
                "targetNotionalVolume": "string",
                "teamScope": [
                  "string"
                ],
                "transferInterval": 0,
                "windowLength": "string"
              },
              "endEpoch": "string",
              "factor": "string",
              "startEpoch": "string"
            },
            "recurringGovernance": {
              "dispatchStrategy": {
                "assetForMetric": "string",
                "capRewardFeeMultiple": "string",
                "distributionStrategy": "DISTRIBUTION_STRATEGY_UNSPECIFIED",
                "eligibleKeys": [
                  "string"
                ],
                "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",
                "targetNotionalVolume": "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"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
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:
• 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.)
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.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
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:
• 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.)
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.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...