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

trading_data.proto

path data-node/api/v2/trading_data.proto

package datanode.api.v2


Messages

AccountBalance

Represents the current balance of an account for an asset on Vega, for a particular owner or party

NameTypeDescription
ownerstringParty that owns the account. Special values include `network` - represents the Vega network and is most commonly seen during liquidation of a distressed trading position.
balancestringAsset balance represented as an integer, for example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places. Balances cannot be negative.
assetstringAsset ID for the account.
market_idstringMarket ID for the account, this field will be empty if the asset is in a general account.
typevega.AccountTypeAccount type of this account.

AccountEdge

Account data item with the corresponding cursor.

NameTypeDescription
nodeAccountBalanceAccount balance data.
cursorstringCursor that can be used to fetch further pages with reference to this account.

AccountFilter

Account filter is used to filter account data. An account is defined as a set of asset ID, type, party ID, and market ID. - Every account has an associated asset and type. - Certain account types such as the global reward pool for example, do not have an associated party. These are denoted by the special party ID 'network'. - Certain account types do not have an associated market such as the general party accounts, for example. These are denoted by the special market ID '' (an empty string).

NameTypeDescription
asset_idstringRestrict accounts to those holding balances in this asset ID.
party_idsrepeated stringRestrict accounts to those owned by the parties in this list. Pass an empty list for no filter.
market_idsrepeated stringRestrict accounts to those connected to the markets in this list. Pass an empty list for no filter.
account_typesrepeated vega.AccountTypeRestrict accounts to those connected to any of the types in this list. Pass an empty list for no filter.

AccountSnapshotPage

'Initial image' snapshot containing current account balances - may be sent over several response messages

NameTypeDescription
accountsrepeated AccountBalanceList of account balances.
last_pageboolIndicator if the current page is the last one or not.

AccountUpdates

List of account updates in the last block

NameTypeDescription
accountsrepeated AccountBalanceList of account balances.

AccountsConnection

Page of accounts data and corresponding page information.

NameTypeDescription
edgesrepeated AccountEdgePage of accounts data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

AggregatedBalance

AggregatedBalance data contains the balance of the set of requested accounts combined with corresponding party ID, market ID and account type details

NameTypeDescription
timestampint64Timestamp in Unix nanoseconds of the block in which the balance exists.
balancestringBalance of the set of requested accounts at the time above.
party_idoptional stringIf grouping by party, the party ID.
asset_idoptional stringIf grouping by asset, the asset ID.
market_idoptional stringIf grouping by market, the market ID
account_typeoptional vega.AccountTypeIf grouping by account type, the account type.

AggregatedBalanceConnection

Page of aggregated balance objects and corresponding page information

NameTypeDescription
edgesrepeated AggregatedBalanceEdgePage of aggregated balance data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

AggregatedBalanceEdge

Aggregated balance data with the corresponding cursor.

NameTypeDescription
nodeAggregatedBalanceBalance of the set of requested accounts.
cursorstringCursor that can be used to fetch further pages.

AggregatedLedgerEntriesConnection

Page of aggregated ledger entries data and corresponding page information.

NameTypeDescription
edgesrepeated AggregatedLedgerEntriesEdgePage of 'AggregatedLedgerEntry' data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

AggregatedLedgerEntriesEdge

Represents the aggregated ledger entry data with corresponding cursor for it

NameTypeDescription
nodeAggregatedLedgerEntry'AggregatedLedgerEntry' data.
cursorstringCursor that can be used to fetch further pages.

AggregatedLedgerEntry

Represents an aggregated view of ledger entry data, sender and receiver accounts, details and balances for both sides after the transfer has been made

NameTypeDescription
timestampint64Timestamp in Unix nanoseconds of the block in which the result is referring to.
quantitystringAmount of ledger entries for the set of requested accounts at the time above.
transfer_typevega.TransferTypeTransfer type.
asset_idoptional stringAsset ID for the asset associated with the entry.
from_account_typevega.AccountTypeType of account sent from.
to_account_typevega.AccountTypeType of account received to.
from_account_party_idoptional stringSender's party ID.
to_account_party_idoptional stringReceiver's party ID.
from_account_market_idoptional stringSender market ID.
to_account_market_idoptional stringReceiver market ID.
from_account_balancestringSender account balance after the transfer.
to_account_balancestringReceiver account balance after the transfer.

AssetEdge

Assets data with the corresponding cursor.

NameTypeDescription
nodevega.AssetAsset data returned.
cursorstringCursor that can be used to fetch further pages.

AssetsConnection

Page of asset data and corresponding page information

NameTypeDescription
edgesrepeated AssetEdgePage of assets data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

Candle

Represents the high, low, open, and closing prices for an interval of trading, referred to commonly as a candlestick or candle

NameTypeDescription
startint64Timestamp in Unix nanoseconds for the point in time when the candle was initially created/opened.
last_updateint64Timestamp in Unix nanoseconds for the point in time when the candle was last updated.
highstringHighest price for trading during the candle interval.
lowstringLowest price for trading during the candle interval.
openstringOpen trade price.
closestringClosing trade price.
volumeuint64Total trading volume during the candle interval.
notionaluint64Total notional value traded during the candle interval.

CandleDataConnection

Page of candles data and corresponding page information

NameTypeDescription
edgesrepeated CandleEdgePage of candle data items and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

CandleEdge

Candle data with the corresponding cursor.

NameTypeDescription
nodeCandleCandlestick data, i.e. high, low, open, and closing prices for an interval of trading.
cursorstringCursor that can be used to fetch further pages.

Checkpoint

Actual data regarding a checkpoint

NameTypeDescription
hashstringHash of the checkpoint.
block_hashstringBlock hash at which the checkpoint is made.
at_blockuint64Block number at which the checkpoint is made.

CheckpointEdge

Checkpoint data with the corresponding cursor.

NameTypeDescription
nodeCheckpointData relating to a single checkpoint generated by the Vega network.
cursorstringCursor that can be used to fetch further pages.

CheckpointsConnection

Page of checkpoints data and corresponding page information

NameTypeDescription
edgesrepeated CheckpointEdgePage of checkpoints data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

CollateralIncreaseEstimate

Estimates the additional funds needed to support the specified position

NameTypeDescription
worst_casestringEstimate assuming slippage cap is applied
best_casestringEstimate assuming no slippage

CoreSnapshotConnection

Page of core snapshot data and corresponding page information.

NameTypeDescription
edgesrepeated CoreSnapshotEdgePage of core snapshot data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

CoreSnapshotEdge

Core snapshot data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.CoreSnapshotDataCore snapshot data.
cursorstringCursor that can be used to fetch further pages.

DateRange

Date range for queries that can return historical data Timestamps should be provided as unix time in Unix nanoseconds and are inclusive.

NameTypeDescription
start_timestampoptional int64Timestamp in Unix nanoseconds indicating the start of the date range.
end_timestampoptional int64Timestamp in Unix nanoseconds indicating the end of the date range.

DelegationEdge

Delegation data with the corresponding cursor.

NameTypeDescription
nodevega.DelegationHow much a party is delegating to a node and when.
cursorstringCursor that can be used to fetch further pages.

DelegationsConnection

Page of delegations data and corresponding page information

NameTypeDescription
edgesrepeated DelegationEdgePage of delegations data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

DepositEdge

Deposits data with the corresponding cursor.

NameTypeDescription
nodevega.DepositData associated with a single deposit made on the Vega network.
cursorstringCursor that can be used to fetch further pages.

DepositsConnection

Page of deposits data received and corresponding page information

NameTypeDescription
edgesrepeated DepositEdgePage of deposits data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ERC20MultiSigSignerAddedBundle

Signature bundle data to be added

NameTypeDescription
new_signerstringEthereum address of the signer to be removed.
submitterstringEthereum address of the submitter.
noncestringNonce used in the signing operation.
timestampint64Unixnano timestamp for when the validator was added.
signaturesstringBundle of signatures from current validators to sign in the new signer.
epoch_seqstringEpoch in which the validator was added.

ERC20MultiSigSignerAddedBundleEdge

Signature bundle data that is to be added with the corresponding cursor.

NameTypeDescription
nodeERC20MultiSigSignerAddedBundleSignature bundle data to be added.
cursorstringCursor that can be used to fetch further pages.

ERC20MultiSigSignerAddedConnection

Page of signature data items to be added and corresponding page information

NameTypeDescription
edgesrepeated ERC20MultiSigSignerAddedBundleEdgePage of signature bundle data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ERC20MultiSigSignerAddedEdge

Signature data that is to be added with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.ERC20MultiSigSignerAddedSignature data to be added.
cursorstringCursor that can be used to fetch further pages.

ERC20MultiSigSignerRemovedBundle

Signature bundle data to be removed

NameTypeDescription
old_signerstringEthereum address of the signer to be removed.
submitterstringEthereum address of the submitter.
noncestringNonce used in the signing operation.
timestampint64Unixnano timestamp for when the validator was added.
signaturesstringBundle of signatures from current validators to sign in the new signer.
epoch_seqstringEpoch in which the validator was removed.

ERC20MultiSigSignerRemovedBundleEdge

Signature bundle data to be removed, with the corresponding cursor.

NameTypeDescription
nodeERC20MultiSigSignerRemovedBundleSignature bundle data to be added.
cursorstringCursor that can be used to fetch further pages.

ERC20MultiSigSignerRemovedConnection

Page of signature data items to be removed and corresponding page information.

NameTypeDescription
edgesrepeated ERC20MultiSigSignerRemovedBundleEdgePage of signature bundle data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ERC20MultiSigSignerRemovedEdge

Signature data to be removed with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.ERC20MultiSigSignerRemovedSignature data to be removed.
cursorstringCursor that can be used to fetch further pages.

EpochRewardSummaryConnection

Page of rewards summary data for epoch and corresponding page information

NameTypeDescription
edgesrepeated EpochRewardSummaryEdgePage of rewards summary data for epochs and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

EpochRewardSummaryEdge

Rewards summary data for epoch with the corresponding cursor.

NameTypeDescription
nodevega.EpochRewardSummaryRewards summary data for epoch.
cursorstringCursor that can be used to fetch further pages.

EstimateFeeRequest

Request to fetch the estimated fee if an order were to trade immediately

NameTypeDescription
market_idstringMarket ID, used to specify the fee factors.
pricestringPrice at which the potential order is expected to trade.
sizeuint64Size at which the potential order is expected to trade.

EstimateFeeResponse

Response that is received from EstimateFeeRequest, contains the estimated fees for a given order

NameTypeDescription
feevega.FeeSummary of the estimated fees for this order if it were to trade now.

EstimateMarginRequest

Request to fetch the estimated MarginLevels if an order were to trade immediately

NameTypeDescription
market_idstringMarket ID for the order.
party_idstringParty ID of the order.
sidevega.SideOrder side - indicator for Seller or Buyer side.
typevega.Order.TypeType of the order.
sizeuint64Size of order.
pricestringPrice of the asset.

EstimateMarginResponse

Response to an estimate margin request, containing the estimated margin levels for a given order

NameTypeDescription
margin_levelsvega.MarginLevelsSummary of the estimated margins for this order if it were to trade now.

EstimatePositionRequest

Request for the estimated margin level, margin account balance change, and liquidation price for the specified position.

NameTypeDescription
market_idstringMarket ID to estimate position for.
open_volumeint64Open volume. This field is a signed integer scaled to the market's position decimal places. A negative number denotes a short position.
average_entry_pricestringAverage entry price corresponding to the open volume. The price is an unsigned integer. For example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places.
ordersrepeated OrderInfoOpen and/or hypothetical orders.
margin_account_balancestringMargin account balance. Needs to be provided scaled to asset decimal places.
general_account_balancestringGeneral account balance. Needs to be provided scaled to asset decimal places.
order_margin_account_balancestringOrder margin account balance. Needs to be provided scaled to asset decimal places.
margin_modevega.MarginModeMargin mode for the party, cross margin or isolated margin.
margin_factoroptional stringMargin factor to be used along with isolated margin mode
include_required_position_margin_in_available_collateraloptional boolWhether the estimated position margin increase should be included in available collateral for liquidation price calculation in isolated margin mode.
scale_liquidation_price_to_market_decimalsoptional boolWhether the liquidation price estimates should be scaled to market decimal places or by asset decimal places. If not set, asset decimal places are used.

EstimatePositionResponse

Response for the estimated margin level, margin account balance change, and liquidation price for the specified position.

NameTypeDescription
marginMarginEstimateMargin level range estimate for the specified position.
collateral_increase_estimateCollateralIncreaseEstimateEstimated margin account balance increase.
liquidationLiquidationEstimateLiquidation price range estimate for the specified position. Only populated if available collateral was specified in the request.

EstimateTransferFeeRequest

Request an estimation of transfer fee and discount

NameTypeDescription
from_accountstringSender's ID.
from_account_typevega.AccountTypeType of account sent from.
to_accountstringReceiver's ID.
amountstringAmount to be transferred.
asset_idstringAsset ID for the asset associated with the transaction.

EstimateTransferFeeResponse

Results of estimation of transfer fee and the fee discount

NameTypeDescription
feestringEstimated fee for the transfer.
discountstringDiscount applied to the fee.

EthereumKeyRotationEdge

Ethereum key rotation data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.EthereumKeyRotationData relating to an Ethereum key rotation performed by a node on the Vega network.
cursorstringCursor that can be used to fetch further pages.

EthereumKeyRotationsConnection

Page of Ethereum key rotations data and corresponding page information

NameTypeDescription
edgesrepeated EthereumKeyRotationEdgePage of Ethereum key rotations data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ExportLedgerEntriesRequest

Request that is sent when exporting ledger entries to csv

NameTypeDescription
party_idstringRestrict exported ledger entries to those relating to the given party ID.
asset_idoptional stringRestrict exported ledger entries to those relating to the given asset ID.
date_rangeoptional DateRangeDate range to export ledger entries for.

ExportNetworkHistoryRequest

Request to export network history data in CSV format

NameTypeDescription
from_blockint64Block to begin exporting from. Must be the first block of a history segment, which by default are 1000 blocks each; in that case - 1, 1001, 2001 etc. are valid values. This can be checked by first calling the API to list all network history segments.
to_blockint64Last block to export up to and including. Must be the last block of a history segment which by default are 1000 blocks each; in that case - 1000, 2000, 3000 etc. are valid values. This can be checked by first calling the API to list all network history segments.
tableTableTable to export data from.

FeesStatsForParty

NameTypeDescription
asset_idstringSettlement asset of the market.
total_rewards_receivedstringTotal referral rewards received by referrer of the referral set.
referees_discount_appliedstringTotal referral discounts applied to referee fees.
volume_discount_appliedstringTotal volume discounts applied to referee fees.
total_maker_fees_receivedstringTotal maker fees received by the maker side.

FundingPayment

A funding payment for a party on a perpetual market

NameTypeDescription
party_idstringParty that received the funding payment.
market_idstringMarket that produced the funding payment.
funding_period_sequint64Funding period sequence this payment was calculated from.
timestampint64Timestamp, in Unix nanoseconds, at which this funding payment occured.
amountstringFunding payment amount, where a positive value indicates an earned payment received and a negative value a loss.

FundingPaymentConnection

Page of funding payment data and corresponding page information.

NameTypeDescription
edgesrepeated FundingPaymentEdgePage of funding payment data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

FundingPaymentEdge

Funding payment data with the corresponding cursor.

NameTypeDescription
nodeFundingPaymentFunding payment data.
cursorstringCursor that can be used to fetch further pages.

FundingPeriodConnection

Page of funding period data and corresponding page information.

NameTypeDescription
edgesrepeated FundingPeriodEdgePage of funding period data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

FundingPeriodDataPointConnection

Page of funding period data points and corresponding page information.

NameTypeDescription
edgesrepeated FundingPeriodDataPointEdgePage of funding period data points and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

FundingPeriodDataPointEdge

Funding period data point with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.FundingPeriodDataPointFunding period data point.
cursorstringCursor that can be used to fetch further pages.

FundingPeriodEdge

Funding period data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.FundingPeriodFunding period data.
cursorstringCursor that can be used to fetch further pages.

Game

Data relating to a game.

NameTypeDescription
idstringUnique ID of the game
epochuint64Epoch at which the last game metrics were captured.
participantsuint64The number of participants in the game.
teamTeamGameEntitiesTeam entities that are participating in the game
individualIndividualGameEntitiesIndividual entities that are participating in the game
reward_asset_idstringID of the asset rewarded for involvement in the game.

GameEdge

Game information and corresponding cursor.

NameTypeDescription
nodeGameGame data.
cursorstringCursor that can be used to fetch further pages.

GamesConnection

Page of games data and corresponding page information.

NameTypeDescription
edgesrepeated GameEdgePage of games data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

GetActiveNetworkHistoryPeerAddressesRequest

Request to get the addresses of active network history peers

NameTypeDescription

GetActiveNetworkHistoryPeerAddressesResponse

Response containing the addresses of active network history peers

NameTypeDescription
ip_addressesrepeated stringList of IP addresses for the active peers.

GetAssetRequest

Request for obtaining asset

NameTypeDescription
asset_idstringAsset ID to get data for.

GetAssetResponse

Response from getting an asset

NameTypeDescription
assetvega.AssetAsset information that is returned.

GetBalanceHistoryRequest

Request that is used when querying balance history

NameTypeDescription
filterAccountFilterAccount filter contains values that can be set in order to limit balance history data to them.
group_byrepeated AccountFieldBy default the net balances of all the accounts specified by the filter are returned. If a list of fields is given in group_by, split out those balances by the supplied criteria.
paginationoptional Pagination
date_rangeoptional DateRange

GetBalanceHistoryResponse

Response that is received when querying for balance history

NameTypeDescription
balancesAggregatedBalanceConnectionPage of aggregated balances with the corresponding page information.

GetCurrentReferralProgramRequest

Request to get the current referral program

NameTypeDescription

GetCurrentReferralProgramResponse

Response containing the current referral program

NameTypeDescription
current_referral_programReferralProgramReferral program currently activated on the network.

GetCurrentVolumeDiscountProgramRequest

Request to get the current referral program

NameTypeDescription

GetCurrentVolumeDiscountProgramResponse

Response containing the current referral program

NameTypeDescription
current_volume_discount_programVolumeDiscountProgramVolume discount program currently activated on the network.

GetDepositRequest

Request to get data about a specific deposit by ID

NameTypeDescription
idstringDeposit ID to return data for.

GetDepositResponse

Response that is received from getting deposit data

NameTypeDescription
depositvega.DepositDeposit matching the ID from the request.

GetERC20ListAssetBundleRequest

Request for listing the signature bundle to an ERC-20 token in the collateral bridge

NameTypeDescription
asset_idstringAsset ID of the asset bundle requested.

GetERC20ListAssetBundleResponse

Response from listing the signature bundle to an ERC-20 token in the collateral bridge

NameTypeDescription
asset_sourcestringAddress of the asset on Ethereum.
vega_asset_idstringAsset ID for the underlying Vega asset.
noncestringNonce that uniquely identifies this signature bundle and prevents resubmission.
signaturesstringSignatures bundle as hex encoded data, prefixed with `0x` e.g: `0x + sig1 + sig2 + ... + sixN`.

GetERC20SetAssetLimitsBundleRequest

Request for the signature bundle to update the token limits i.e. maxLifetimeDeposit and withdrawThreshold for a given ERC20 token that is already allowlisted in the collateral bridge

NameTypeDescription
proposal_idstringProposal ID of the asset update proposal.

GetERC20SetAssetLimitsBundleResponse

Response for the signature bundle to update the token limits i.e. maxLifetimeDeposit and withdrawThreshold for a given ERC20 token that is already allowlisted in the collateral bridge

NameTypeDescription
asset_sourcestringAddress of the asset on Ethereum.
vega_asset_idstringAsset ID for the underlying Vega asset.
noncestringNonce that uniquely identifies this signature bundle and prevents resubmission.
lifetime_limitstringLifetime limit deposit for this asset.
thresholdstringThreshold withdraw for this asset.
signaturesstringSignatures bundle as hex encoded data, prefixed with `0x` e.g: `0x + sig1 + sig2 + ... + sixN`.

GetERC20WithdrawalApprovalRequest

Request to get all information required to bundle the call to finalise the withdrawal on the erc20 bridge

NameTypeDescription
withdrawal_idstringWithdrawal ID to retrieve.

GetERC20WithdrawalApprovalResponse

Response with all information required to bundle the call to finalise the withdrawal on the erc20 bridge function withdraw_asset(address asset_source, uint256 asset_id, uint256 amount, uint256 expiry, uint256 nonce, bytes memory signatures)

NameTypeDescription
asset_sourcestringAddress of asset on Ethereum.
amountstringAmount to be withdrawn.
noncestringNonce that uniquely identifies this signature bundle and prevents resubmission.
signaturesstringSignatures bundle as hex encoded data, prefixed with `0x` e.g: 0x + sig1 + sig2 + ... + sixN.
target_addressstringEthereum address, prefixed with `0x`, that will receive the withdrawn assets.
creationint64Creation timestamps.

GetEpochRequest

Request to fetch epoch data Provide either the epoch ID or the block height to get the epoch for. If both are provided, the epoch ID will be used. If both are omitted, the current epoch will be returned.

NameTypeDescription
idoptional uint64Epoch ID. If provided, returns the epoch with the given ID.
blockoptional uint64Block height. If provided, returns the epoch that the given block is in.

GetEpochResponse

Response from getting epoch

NameTypeDescription
epochvega.EpochData specific to a single epoch on the Vega network. This includes the epoch number, start and end times, and the nodes that participated in the epoch.

GetFeesStatsForPartyRequest

Request that is sent to retrieve fees statistics for a given party.

NameTypeDescription
party_idstringRestrict fees statistics to those for the given party.
asset_idoptional stringRestrict fees statistics to those related to the given asset.
from_epochoptional uint64Epoch to filter from (included). If omitted, the range goes from the oldest epoch to the `to epoch`.
to_epochoptional uint64Epoch to filter to (included). If omitted, the range goes from `from epoch` to the most recent epoch.

GetFeesStatsForPartyResponse

Response that is sent when requesting fees statistics for a given party.

NameTypeDescription
fees_stats_for_partyrepeated FeesStatsForPartyFees statistics for the given request.

GetFeesStatsRequest

Request that is sent to retrieve fees statistics.

NameTypeDescription
market_idoptional stringRestrict fee statistics to those related for the given market.
asset_idoptional stringRestrict fee statistics to those related for the given asset.
epoch_seqoptional uint64Epoch to get referral fee statistics for. If not set, the last complete epoch is used.
party_idoptional stringRestrict fee statistics to those for the given party.

GetFeesStatsResponse

Response that is sent when requesting fees statistics.

NameTypeDescription
fees_statsvega.events.v1.FeesStatsFees statistics for the given request.

GetGovernanceDataRequest

Request to get governance data

NameTypeDescription
proposal_idoptional stringProposal ID to get governance data for, if provided.
referenceoptional stringReference to get proposal data for, if provided.

GetGovernanceDataResponse

Response from getting governance data

NameTypeDescription
datavega.GovernanceDataGovernance data content, i.e. proposal and votes for and against.

GetLastTradeRequest

Request for the latest trade that occurred on Vega for a given market

NameTypeDescription
market_idstringMarket ID to retrieve the last trade for.

GetLastTradeResponse

Response for the latest trade that occurred on Vega for a given market

NameTypeDescription
tradevega.TradeInformation about the trade, if one is found.

GetLatestMarketDataRequest

Request that is sent when listing the latest market data for a given market

NameTypeDescription
market_idstringMarket ID to retrieve market data for.

GetLatestMarketDataResponse

Response that is received when listing the latest market data for a given market

NameTypeDescription
market_datavega.MarketDataMarket data that was requested.

GetLatestMarketDepthRequest

Request that is sent when requesting latest market depth data

NameTypeDescription
market_idstringMarket ID to request market depth for, required field.
max_depthoptional uint64Maximum market depth.

GetLatestMarketDepthResponse

Response that is received when latest market depth data is queried

NameTypeDescription
market_idstringMarket ID of the depth levels returned.
buyrepeated vega.PriceLevelZero or more price levels for the buy side of the market depth data.
sellrepeated vega.PriceLevelZero or more price levels for the sell side of the market depth data.
last_tradevega.TradeLast trade recorded on Vega.
sequence_numberuint64Sequence number incremented after each update.

GetMarketDataHistoryByIDRequest

Request that is sent for getting Market Data History

NameTypeDescription
market_idstringMarket ID to request data history for.
start_timestampoptional int64Timestamp in Unix nanoseconds indicating the start of the date range.
end_timestampoptional int64Timestamp in Unix nanoseconds indicating the end of the date range.
paginationoptional PaginationPagination control.

GetMarketDataHistoryByIDResponse

Response that is received when querying Market Data History

NameTypeDescription
market_dataMarketDataConnectionPage of market data history with the corresponding page information.

GetMarketRequest

Request for getting a market by ID

NameTypeDescription
market_idstringMarket ID of the market to retrieve data for.

GetMarketResponse

Response from getting a market by ID

NameTypeDescription
marketvega.MarketInformation about the market requested.

GetMostRecentNetworkHistorySegmentRequest

Request to get the most recent history segment

NameTypeDescription

GetMostRecentNetworkHistorySegmentResponse

Response from getting most recent history segment

NameTypeDescription
segmentHistorySegmentData relating to a history segment created by a Vega data node.
swarm_key_seedstringKey seed for the swarm section.

GetNetworkDataRequest

Request to get network data

NameTypeDescription

GetNetworkDataResponse

Response from getting network data

NameTypeDescription
node_datavega.NodeDataSummary of information with respect to nodes on the Vega network.

GetNetworkHistoryBootstrapPeersRequest

Request to get the nodes network history bootstrap peers

NameTypeDescription

GetNetworkHistoryBootstrapPeersResponse

Response containing the nodes network history bootstrap peers

NameTypeDescription
bootstrap_peersrepeated stringList of peers that can be used to bootstrap a Vega data node.

GetNetworkHistoryStatusRequest

Request to get the status of network history

NameTypeDescription

GetNetworkHistoryStatusResponse

Response containing the status of network history

NameTypeDescription
ipfs_addressstringIPFS address of the data node currently connected to.
swarm_keystringSwarm key used by the IPFS swarm.
swarm_key_seedstringSwarm key seed used by the IPFS swarm.
connected_peersrepeated stringList of peers connected to the IPFS swarm.

GetNetworkLimitsRequest

Request that is used to query current network limits

NameTypeDescription

GetNetworkLimitsResponse

Response received when querying the current network limits

NameTypeDescription
limitsvega.NetworkLimitsList of received network limits.

GetNetworkParameterRequest

Request for a single network parameter

NameTypeDescription
keystringKey identifying the network parameter.

GetNetworkParameterResponse

Response that is received when getting a network parameter

NameTypeDescription
network_parametervega.NetworkParameterNetwork parameter key and value.

GetNodeRequest

Request to get node data

NameTypeDescription
idstringNode ID to get data for.

GetNodeResponse

Response from getting node

NameTypeDescription
nodevega.NodeData specific to a single node on the Vega network.

GetOracleSpecRequest

Request to get a specific oracle spec by its ID

NameTypeDescription
oracle_spec_idstringOracle spec ID to request data for.

GetOracleSpecResponse

Response for a oracle spec

NameTypeDescription
oracle_specvega.OracleSpecExternal data spec matching the ID.

GetOrderRequest

Request that is sent when executing the query for getting a single order

NameTypeDescription
order_idstringOrder ID to retrieve order information for.
versionoptional int32Historic version number of the order to return. If not set, the most current version will be returned.

GetOrderResponse

Response received from the query for getting a single order

NameTypeDescription
ordervega.OrderOrder details, if one was found.

GetPartyActivityStreakRequest

Request to get a party's activity streaks across epochs

NameTypeDescription
party_idstringParty ID to get the activity streak for.
epochoptional uint64Epoch to get the activity streak for. If not set, the last complete epoch is used.

GetPartyActivityStreakResponse

Response when getting a party's activity streaks across epochs

NameTypeDescription
activity_streakvega.events.v1.PartyActivityStreakParty's activity streak in a given epoch.

GetPartyRequest

Request to get party by ID

NameTypeDescription
party_idstringParty ID to retrieve party information for.

GetPartyResponse

Response from getting party by ID

NameTypeDescription
partyvega.PartyData for the party requested.

GetPartyVestingStatsRequest

Request sent to get statistics about the vesting rewards for a party

NameTypeDescription
party_idstringParty ID to query the vesting stats for.

GetPartyVestingStatsResponse

Vesting reward statistics for a given party

NameTypeDescription
party_idstringParty ID.
reward_bonus_multiplierstringReward bonus multiplier.
epoch_sequint64Epoch for which this information is valid.
quantum_balancestringThe balance of the party, in quantum.

GetProtocolUpgradeStatusRequest

Request to get protocol upgrade status

NameTypeDescription

GetProtocolUpgradeStatusResponse

Response from getting protocol upgrade status

NameTypeDescription
readyboolIndicator if the upgrade is ready or not.

GetReferralSetStatsRequest

Request to get a referral set's stats

NameTypeDescription
referral_set_idoptional stringRestrict referral set statistics to those for the given referral set.
at_epochoptional uint64Epoch to get referral set statistics for. If not set, the last complete epoch is used.
refereeoptional stringRestrict referral set statistics to those for the given referee.
paginationoptional PaginationPagination controls.

GetReferralSetStatsResponse

Response containing the volume discount statistics for the given epoch.

NameTypeDescription
statsReferralSetStatsConnectionReferral set statistics for the epoch.

GetRiskFactorsRequest

Request to get risk factor

NameTypeDescription
market_idstringMarket ID to get the risk factor for.

GetRiskFactorsResponse

Response that is received from getting a risk factor

NameTypeDescription
risk_factorvega.RiskFactorRisk factor emitted by the risk model for a given market.

GetStakeRequest

Request to get stake

NameTypeDescription
party_idstringParty ID for which the stake information is requested.
paginationoptional PaginationOptional pagination information to limit the data that is returned.

GetStakeResponse

Response that is received from requesting stake information

NameTypeDescription
current_stake_availablestringCurrent stake available information.
stake_linkingsStakesConnectionPaged list of stake data with corresponding page information.

GetStopOrderRequest

Request that is sent when executing the query for getting a single stop order.

NameTypeDescription
order_idstringOrder ID to retrieve order information for.

GetStopOrderResponse

Response received from the query for getting a single stop order.

NameTypeDescription
ordervega.events.v1.StopOrderEventOrder details, if one was found.

GetTotalTransferFeeDiscountRequest

Get total transfer fee discount available

NameTypeDescription
party_idstringID of party eligible for the discount.
asset_idstringID of asset to associated with the discount.

GetTotalTransferFeeDiscountResponse

Returns total transfer fee discount available

NameTypeDescription
total_discountstringTotal per party per asset discount available.

GetTransferRequest

Request that is sent for getting a transfer by ID

NameTypeDescription
transfer_idstringTransfer ID to request data for.

GetTransferResponse

Response that is received when querying transfers by ID

NameTypeDescription
transfer_nodeTransferNodeTransfer and its fees requested by ID.

GetVegaTimeRequest

Request to get the current time of the Vega network

NameTypeDescription

GetVegaTimeResponse

Response for the current consensus coordinated time on the Vega network, referred to as "VegaTime"

NameTypeDescription
timestampint64Timestamp representation of current VegaTime as represented in Unix nanoseconds, for example `1580473859111222333` corresponds to `2020-01-31T12:30:59.111222333Z`.

GetVestingBalancesSummaryRequest

Request sent to list the vesting and locked balances for a party

NameTypeDescription
party_idstringParty ID to query vesting balances for.
asset_idoptional stringOptional asset ID, all asset balances returned if not set.

GetVestingBalancesSummaryResponse

List of vesting and locked balances for a party.

NameTypeDescription
party_idstringParty ID.
epoch_seqoptional uint64Epoch for which these balances are valid.
locked_balancesrepeated vega.events.v1.PartyLockedBalanceList of locked balances for the party.
vesting_balancesrepeated vega.events.v1.PartyVestingBalanceList of vesting balances for the party.

GetVolumeDiscountStatsRequest

Request to get the volume discount statistics for a given epoch.

NameTypeDescription
at_epochoptional uint64Epoch to get volume discount statistics for. If not set, last epoch is used.
party_idoptional stringRestrict volume discount statistics to those for the given party.
paginationoptional PaginationPagination controls.

GetVolumeDiscountStatsResponse

Response containing the volume discount statistics for the given epoch.

NameTypeDescription
statsVolumeDiscountStatsConnectionVolume discount statistics for an epoch.

GetWithdrawalRequest

Request to get a specific withdrawal by ID

NameTypeDescription
idstringWithdrawal ID to retrieve data for.

GetWithdrawalResponse

Response for a withdrawal request

NameTypeDescription
withdrawalvega.WithdrawalWithdrawal matching the ID from the request.

GovernanceDataConnection

Page of governance data and corresponding page information

NameTypeDescription
edgesrepeated GovernanceDataEdgePage of governance data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

GovernanceDataEdge

Governance data with the corresponding cursor.

NameTypeDescription
nodevega.GovernanceDataGovernance data content, i.e. proposal and votes for and against.
cursorstringCursor that can be used to fetch further pages.

HistorySegment

Describes a network history segment

NameTypeDescription
from_heightint64Starting height of the history segment.
to_heightint64Ending height of the history segment.
history_segment_idstringHistory segment ID.
previous_history_segment_idstringPrevious history segment ID.
database_versionint64Database schema version of the history segment.
chain_idstringChain ID of the history segment.

IndividualGameEntities

List of individuals that are participating in a game

NameTypeDescription
individualrepeated IndividualGameEntityList of individual party IDs, and the metrics associated with each participant.

IndividualGameEntity

Data relating to an individual participating in a game. This can be used for both team members who are participating in a team game, or individuals participating in an individual entity game.

NameTypeDescription
individualstringParty ID of the individual participating
rankuint64Rank of the individual either in the game or within their team.
volumestringVolume traded by the individual
reward_metricvega.DispatchMetricReward metric applied to the individual
reward_earnedstringReward earned by the individual during the epoch
total_rewards_earnedstringTotal rewards earned by the individual for the game
reward_earned_quantumstringRewards earned by the individual in quantum value
total_rewards_earned_quantumstringTotal rewards earned by the individual in quantum value

InfoRequest

Request that is sent when querying node information

NameTypeDescription

InfoResponse

Response that is received from the node information query

NameTypeDescription
versionstringSemver formatted version of the data node.
commit_hashstringCommit hash from which the data node was built.

IntervalToCandleId

Maps an interval for a given market to its corresponding candle ID

NameTypeDescription
intervalstringInterval for the candle.
candle_idstringUnique id of the candle.

KeyRotationConnection

Page of key rotations data and corresponding page information

NameTypeDescription
edgesrepeated KeyRotationEdgePage of key rotation data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

KeyRotationEdge

Key rotation data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.KeyRotationData relating to a key rotation that was performed by a node on the Vega network.
cursorstringCursor that can be used to fetch further pages.

LedgerEntryFilter

Ledger entry filter sets filters on returned set of ledger entries.

NameTypeDescription
close_on_account_filtersboolDetermines whether an entry must have accounts matching both the account_from_filter and the account_to_filter. If set to 'true', entries must have matches in both filters. If set to `false`, entries matching only the account_from_filter or the account_to_filter will also be included.
from_account_filterAccountFilterUsed to set values for filtering sender accounts. Party must be provided in this filter or 'to' account filter, or both.
to_account_filterAccountFilterUsed to set values for filtering receiver accounts. Party must be provided in this filter or 'from' account filter, or both.
transfer_typesrepeated vega.TransferTypeList of transfer types that is used for filtering sender and receiver accounts.
transfer_idoptional stringList ledger entries that are associated with a specific transfer ID. If provided, all other filters are ignored

LiquidationEstimate

Liquidation estimate for both worst and best case possible.

NameTypeDescription
worst_caseLiquidationPriceLiquidation price estimate assuming slippage cap is applied.
best_caseLiquidationPriceLiquidation price estimate assuming no slippage.

LiquidationPrice

Liquidation price estimate for either only the current open volume and position given some or all buy orders get filled, or position given some or all sell orders get filled.

NameTypeDescription
open_volume_onlystringLiquidation price for current open volume ignoring any active orders.
including_buy_ordersstringLiquidation price assuming buy orders start getting filled.
including_sell_ordersstringLiquidation price assuming sell orders start getting filled.

LiquidityProvider

Liquidity provider information.

NameTypeDescription
party_idstringParty ID of the liquidity provider.
market_idstringID of the market the liquidity provider is active in.
fee_sharevega.LiquidityProviderFeeShareInformation used for calculating an LP's fee share, such as the equity like share, average entry valuation and liquidity score for the liquidity provider for the specified market.
slavega.LiquidityProviderSLAInformation about LP's SLA performance.

LiquidityProviderConnection

Page of liquidity provider data and corresponding page information.

NameTypeDescription
edgesrepeated LiquidityProviderEdgePage of liquidity provider data.
page_infoPageInfoPage information that is used for fetching further pages.

LiquidityProviderEdge

Liquidity provider data with the corresponding cursor.

NameTypeDescription
nodeLiquidityProviderLiquidity provider information returned by the API.
cursorstringCursor that can be used to fetch further data.

LiquidityProvision

Liquidity provider commitment. For API purposes this can report a pending liquidity provision, the current live provision or both in the event that an update has been accepted on the network, but has yet to go live and thus there is still a pending provision that will become active in the next epoch.

NameTypeDescription
currentvega.LiquidityProvisionLiquidity provision that is currently live.
pendingoptional vega.LiquidityProvisionLiquidity provision that is currently pending and will go live in the next epoch.

LiquidityProvisionWithPendingEdge

Liquidity provision data with the corresponding cursor.

NameTypeDescription
nodeLiquidityProvisionData corresponding to a liquidity provider's commitment.
cursorstringCursor that can be used to fetch further pages.

LiquidityProvisionsConnection

Page of liquidity provisions data and corresponding page information

NameTypeDescription
edgesrepeated LiquidityProvisionsEdgePage of liquidity provisions data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

LiquidityProvisionsEdge

Liquidity provision data with the corresponding cursor.

NameTypeDescription
nodevega.LiquidityProvisionData corresponding to a liquidity provider's commitment.
cursorstringCursor that can be used to fetch further pages.

LiquidityProvisionsWithPendingConnection

Page of liquidity provisions data and corresponding page information

NameTypeDescription
edgesrepeated LiquidityProvisionWithPendingEdgePage of liquidity provisions data and their corresponding cursors.
page_infoPageInfoPage information that is used to fetch further pages.

ListAccountsRequest

Request that is sent when listing accounts.

NameTypeDescription
filterAccountFilterAccount filter contains all filter conditions and values that can be applied to the listing.
paginationoptional PaginationOptional pagination control.

ListAccountsResponse

Response that is received from listing accounts query.

NameTypeDescription
accountsAccountsConnectionPage of accounts data and corresponding page information.

ListAllLiquidityProvisionsRequest

Request for listing liquidity provisions

NameTypeDescription
market_idoptional stringRestrict liquidity provisions to those placed on the given market.
party_idoptional stringRestrict liquidity provisions to those placed by the given party.
referenceoptional stringRestrict liquidity provisions to those with the given order reference.
liveoptional boolWhether to include live liquidity provisions. If not set, live orders will not be included.
paginationoptional PaginationPagination controls.

ListAllLiquidityProvisionsResponse

Response from listing liquidity provisions

NameTypeDescription
liquidity_provisionsLiquidityProvisionsWithPendingConnectionPage of liquidity provisions data and corresponding page information.

ListAllNetworkHistorySegmentsRequest

Request to list all the nodes history segments

NameTypeDescription

ListAllNetworkHistorySegmentsResponse

Response with a list of all the nodes history segments

NameTypeDescription
segmentsrepeated HistorySegmentPage of history segments data and corresponding page information.

ListAllPositionsRequest

Request to list positions, given the position filter is supplied.

NameTypeDescription
filterPositionsFilterFilter to apply to the positions.
paginationoptional PaginationPagination controls.

ListAllPositionsResponse

Response to query for listing of positions, given the filter is supplied

NameTypeDescription
positionsPositionConnectionPage of positions data and corresponding page information.

ListAssetsRequest

Request for listing assets data

NameTypeDescription
asset_idoptional stringOptional asset ID to list data for.
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListAssetsResponse

Response from listing assets

NameTypeDescription
assetsAssetsConnectionPage of assets data and corresponding page information.

ListBalanceChangesRequest

Request to use when querying balances changes.

NameTypeDescription
filterAccountFilterLimit the accounts considered according to the filter supplied.
paginationoptional PaginationPagination controls.
date_rangeoptional DateRangeDate range over which to query.

ListBalanceChangesResponse

Response that is received from querying balances changes.

NameTypeDescription
balancesAggregatedBalanceConnectionPage of aggregated balances data and corresponding page information.

ListCandleDataRequest

Request that is used when listing candles for a market at an interval

NameTypeDescription
candle_idstringCandle ID to retrieve candle data for.
from_timestampint64Timestamp in Unix nanoseconds to retrieve candles from.
to_timestampint64Timestamp in Unix nanoseconds to retrieve candles to.
paginationoptional PaginationPagination controls.

ListCandleDataResponse

Response for list of candles for a market at an interval

NameTypeDescription
candlesCandleDataConnectionPage of candle data and corresponding page information.

ListCandleIntervalsRequest

Request that is used to fetch a list of supported intervals for the given market along with the corresponding candle ID

NameTypeDescription
market_idstringUnique ID for the market to list candle intervals for.

ListCandleIntervalsResponse

List of mapped pairs `interval` -> `candle ID` for a given market

NameTypeDescription
interval_to_candle_idrepeated IntervalToCandleIdList of the mappings.

ListCheckpointsRequest

Request to get all checkpoints. Currently no fields, probably will be expanded to allow filtering data

NameTypeDescription
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListCheckpointsResponse

Response message containing all checkpoints requested

NameTypeDescription
checkpointsCheckpointsConnectionPage of checkpoints data and corresponding page information.

ListCoreSnapshotsRequest

Request type for ListCoreSnapshots; fetches a paginated list of the core snapshots.

NameTypeDescription
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListCoreSnapshotsResponse

Response from a ListCoreSnapshots RPC call; a paginated list of the core snapshots.

NameTypeDescription
core_snapshotsCoreSnapshotConnectionPage of core snapshot data and corresponding page information.

ListDelegationsRequest

Request for listing delegations

NameTypeDescription
party_idoptional stringRestrict delegations to those made by the given party ID.
node_idoptional stringRestrict delegations to those made to the given node ID.
epoch_idoptional stringReturn delegations made in the given epoch. If not set, delegations for the current epoch will be returned.
paginationoptional PaginationPagination controls.

ListDelegationsResponse

Response from listing delegations

NameTypeDescription
delegationsDelegationsConnectionPage of delegations data and corresponding page information.

ListDepositsRequest

Request to list all deposits for a given party

NameTypeDescription
party_idstringRestrict deposits to those made by the given party ID.
paginationoptional PaginationPagination controls.
date_rangeoptional DateRangeDate range of the requested data, if provided.

ListDepositsResponse

Response from listing deposits

NameTypeDescription
depositsDepositsConnectionPage of deposits data and corresponding page information.

ListERC20MultiSigSignerAddedBundlesRequest

Request for adding a signature bundle to the signer list of a multisig contract for a particular validator

NameTypeDescription
node_idstringNode ID of the validator for which a signature bundle is required.
submitterstringEthereum address of the validator that will submit the bundle.
epoch_seqstringEpoch in which the bundle was generated, i.e. the epoch in which the node was promoted to consensus validator.
paginationPaginationPagination controls.

ListERC20MultiSigSignerAddedBundlesResponse

Response from adding a signature bundle to the signer list of a multisig contract for a particular validator

NameTypeDescription
bundlesERC20MultiSigSignerAddedConnectionPage of bundles for that validator - it may have been added multiple times if removed in between - and corresponding page information.

ListERC20MultiSigSignerRemovedBundlesRequest

Request for removing a signature bundle from the signer list of the multisig contract for a particular validator

NameTypeDescription
node_idstringNode ID of the validator of which a signature bundle is required.
submitterstringEthereum address of the validator that will submit the bundle.
epoch_seqstringEpoch in which the bundle was generated, i.e. the epoch in which the node was demoted from a consensus validator.
paginationPaginationPagination controls.

ListERC20MultiSigSignerRemovedBundlesResponse

Response when removing a signature bundle from the signer list of the multisig contract for a particular validator

NameTypeDescription
bundlesERC20MultiSigSignerRemovedConnectionPage of signer bundle data items for that validator and corresponding page information.

ListEntitiesRequest

Request to list all entities that were created by the given transaction hash

NameTypeDescription
transaction_hashstringTransaction hash to match against

ListEntitiesResponse

Response from listing entities that were created for a given transaction hash

NameTypeDescription
accountsrepeated vega.Account
ordersrepeated vega.Order
positionsrepeated vega.Position
ledger_entriesrepeated vega.LedgerEntry
balance_changesrepeated AccountBalance
transfersrepeated vega.events.v1.Transfer
votesrepeated vega.Vote
erc20_multi_sig_signer_added_bundlesrepeated ERC20MultiSigSignerAddedBundle
erc20_multi_sig_signer_removed_bundlesrepeated ERC20MultiSigSignerRemovedBundle
tradesrepeated vega.Trade
oracle_specsrepeated vega.OracleSpec
oracle_datarepeated vega.OracleData
marketsrepeated vega.Market
partiesrepeated vega.Party
margin_levelsrepeated vega.MarginLevels
rewardsrepeated vega.Reward
depositsrepeated vega.Deposit
withdrawalsrepeated vega.Withdrawal
assetsrepeated vega.Asset
liquidity_provisionsrepeated vega.LiquidityProvision
proposalsrepeated vega.Proposal
delegationsrepeated vega.Delegation
nodesrepeated NodeBasic
node_signaturesrepeated vega.commands.v1.NodeSignature
network_parametersrepeated vega.NetworkParameter
key_rotationsrepeated vega.events.v1.KeyRotation
ethereum_key_rotationsrepeated vega.events.v1.EthereumKeyRotation
protocol_upgrade_proposalsrepeated vega.events.v1.ProtocolUpgradeEvent

ListEpochRewardSummariesRequest

Request to get summary of reward per epoch for a given range of epochs

NameTypeDescription
filterRewardSummaryFilterLimit the results considered according to the filter supplied.
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListEpochRewardSummariesResponse

Return message with reward details in for a single party

NameTypeDescription
summariesEpochRewardSummaryConnectionPage of rewards details for a single party and corresponding page information.

ListEthereumKeyRotationsRequest

Request to list ethereum key rotations for nodes, optionally filtered by node

NameTypeDescription
node_idoptional stringNode ID to get the rotation for, if provided.
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListEthereumKeyRotationsResponse

Response message containing Ethereum key rotations

NameTypeDescription
key_rotationsEthereumKeyRotationsConnectionPage of Ethereum key rotations data and corresponding page information.

ListFundingPaymentsRequest

Request to list a a party's funding payments

NameTypeDescription
party_idstringParty ID to get funding payment for.
market_idoptional stringRestrict funding payments returned to those generated by the given market.
paginationoptional PaginationPagination controls.

ListFundingPaymentsResponse

Response from listing funding payments

NameTypeDescription
funding_paymentsFundingPaymentConnectionPage of funding period data and corresponding page information.

ListFundingPeriodDataPointsRequest

NameTypeDescription
market_idstringMarket ID to get funding period data points for.
date_rangeoptional DateRangeRestrict the data points to those within the given date range.
sourceoptional vega.events.v1.FundingPeriodDataPoint.SourceRestrict the data points to those with the given source type.
seqoptional uint64Restrict the data points to those that contributed to the given funding period sequence.
paginationoptional PaginationPagination controls.

ListFundingPeriodDataPointsResponse

Response from listing funding period data points.

NameTypeDescription
funding_period_data_pointsFundingPeriodDataPointConnectionPage of funding period data points and corresponding page information.

ListFundingPeriodsRequest

Request to list a perpetual market's funding periods

NameTypeDescription
market_idstringMarket ID to get funding periods for.
date_rangeoptional DateRangeRestrict the funding periods to those within the given date range.
paginationoptional PaginationPagination controls.

ListFundingPeriodsResponse

Response from listing funding periods

NameTypeDescription
funding_periodsFundingPeriodConnectionPage of funding period data and corresponding page information.

ListGamesRequest

Request to retrieve games data.

NameTypeDescription
game_idoptional stringGame ID to filter for.
epoch_fromoptional uint64First epoch to retrieve game data from. If not provided, defaults to the last epoch minus 30, or the first epoch available if not enough epochs have passed.
epoch_tooptional uint64Last epoch to retrieve game data to (inclusive). If not provided, defaults to the last epoch.
entity_scopeoptional vega.EntityScopeEntity scope to filter games for, i.e. team games or individual games only
paginationoptional PaginationPagination controls.

ListGamesResponse

Response containing games data.

NameTypeDescription
gamesGamesConnectionPage of games data and corresponding page information.

ListGovernanceDataRequest

Request to list governance data

NameTypeDescription
proposal_stateoptional vega.Proposal.StateRestrict proposals to those with the given state.
proposal_typeoptional ListGovernanceDataRequest.TypeRestrict proposals to those with the given type.
proposer_party_idoptional stringRestrict proposals to those proposed by the given party ID.
proposal_referenceoptional stringRestrict proposals to those with the given reference.
paginationoptional PaginationPagination controls.

ListGovernanceDataResponse

Response from listing governance data

NameTypeDescription
connectionGovernanceDataConnectionPage of governance data and corresponding page information.

ListKeyRotationsRequest

Request to list all key rotations

NameTypeDescription
node_idoptional stringNode ID to get key rotations for, if provided.
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListKeyRotationsResponse

Response message containing Vega key rotations

NameTypeDescription
rotationsKeyRotationConnectionPage of key rotations data and corresponding page information.

ListLatestMarketDataRequest

Request that is sent when listing the latest market data for every market

NameTypeDescription

ListLatestMarketDataResponse

Response that is received when listing the latest market data for every market

NameTypeDescription
markets_datarepeated vega.MarketData

ListLedgerEntriesRequest

Request that is sent when listing ledger entries.

NameTypeDescription
filterLedgerEntryFilterLedger entry filter that contains all values and conditions according to which the listing of ledger entries is filtered.You must provide at least one party in 'from' account filter, or 'to' account filter.
paginationoptional PaginationOptional pagination control.
date_rangeoptional DateRangeDate range for which to list ledger entries. If not set, the date range is restricted to the last 5 days. If a start and end date is provided, but the range is more than 5 days, the end date will be restricted to 5 days from the start. If a start date is provided, but no end date, the end date will be set to 5 days from the start. If an end date is provided, but no start date, the start date will be set to 5 days before the end.

ListLedgerEntriesResponse

Response that is received when listing ledger entries

NameTypeDescription
ledger_entriesAggregatedLedgerEntriesConnectionPage of aggregated ledger entries data and corresponding page information.

ListLiquidityProvidersRequest

Request for listing active liquidity providers for a given market. Either market ID or party ID or both, must be provided.

NameTypeDescription
market_idoptional stringMarket ID to retrieve liquidity providers for. If omitted, you must provide a party ID.
party_idoptional stringParty ID to retrieve data for. If omitted, you must provide a market ID.
paginationoptional PaginationPagination controls.

ListLiquidityProvidersResponse

Response for listing liquidity providers.

NameTypeDescription
liquidity_providersLiquidityProviderConnectionPage of liquidity providers and corresponding page information.

ListLiquidityProvisionsRequest

Request for listing liquidity provisions

NameTypeDescription
market_idoptional stringRestrict liquidity provisions to those placed on the given market.
party_idoptional stringRestrict liquidity provisions to those placed by the given party.
referenceoptional stringRestrict liquidity provisions to those with the given order reference.
liveoptional boolWhether to include live liquidity provisions. If not set, live orders will not be included.
paginationoptional PaginationPagination controls.

ListLiquidityProvisionsResponse

Response from listing liquidity provisions

NameTypeDescription
liquidity_provisionsLiquidityProvisionsConnectionPage of liquidity provisions data and corresponding page information.

ListMarginLevelsRequest

Request for listing margin levels

NameTypeDescription
party_idstringParty ID for which to list the margin levels
market_idstringMarket ID for which to list the margin levels
paginationPaginationPagination control

ListMarginLevelsResponse

Response from listing margin levels

NameTypeDescription
margin_levelsMarginConnectionPage of margin levels data and corresponding page information.

ListMarketsRequest

Request for listing markets

NameTypeDescription
paginationoptional PaginationPagination control.
include_settledoptional boolWhether to include settled markets. If not set, settled markets will be included.

ListMarketsResponse

Response from listing markets

NameTypeDescription
marketsMarketConnectionPage of markets and corresponding page information.

ListNetworkParametersRequest

Message requesting for the list of all network parameters

NameTypeDescription
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListNetworkParametersResponse

Response containing all of the Vega network parameters

NameTypeDescription
network_parametersNetworkParameterConnectionPage of network parameters and corresponding page information.

ListNodeSignaturesRequest

Request to specify the ID of the resource to retrieve aggregated signatures for

NameTypeDescription
idstringResource ID to list signatures for.
paginationoptional PaginationOptional pagination information to limit the data that is returned.

ListNodeSignaturesResponse

Response to specify the ID of the resource to retrieve aggregated signatures for

NameTypeDescription
signaturesNodeSignaturesConnectionPage of nodes signatures and corresponding page information.

ListNodesRequest

Request to list nodes

NameTypeDescription
epoch_seqoptional uint64Return the node list for the given epoch. If not set, the node list for the current epoch will be returned.
paginationoptional PaginationPagination controls.

ListNodesResponse

Response from listing nodes

NameTypeDescription
nodesNodesConnectionPage of node data and corresponding page information.

ListOracleDataRequest

Request to get all seen oracle data

NameTypeDescription
oracle_spec_idoptional stringOracle spec ID to list data for.
paginationoptional PaginationPagination controls.

ListOracleDataResponse

Response to get all seen oracle data

NameTypeDescription
oracle_dataOracleDataConnectionPage of seen oracle data and corresponding page information.

ListOracleSpecsRequest

Request to get all active oracle specs

NameTypeDescription
paginationoptional PaginationPagination controls.

ListOracleSpecsResponse

Response to get all active oracle specs

NameTypeDescription
oracle_specsOracleSpecsConnectionPage of active oracle specs and corresponding page information.

ListOrderVersionsRequest

Request that is sent when listing possible order versions

NameTypeDescription
order_idstringOrder ID to list versions for.
paginationoptional PaginationOptional pagination control.

ListOrderVersionsResponse

Response that is received when listing possible order versions

NameTypeDescription
ordersOrderConnectionPage of order versions and corresponding page information.

ListOrdersRequest

Request that is sent when executing a query for a list of orders

NameTypeDescription
paginationoptional PaginationOptional pagination control.
filteroptional OrderFilterOrder filter contains all filtering conditions and values that are applied to the orders listing.

ListOrdersResponse

Response that is received from the query to list orders

NameTypeDescription
ordersOrderConnectionPage of orders data and corresponding page information.

ListPaidLiquidityFeesRequest

Paid liquidity fees request.

NameTypeDescription
market_idoptional stringRestrict fee data to those fees generated in the given market.
asset_idoptional stringRestrict fee statistics to those paid in the given asset.
epoch_seqoptional uint64Epoch to get paid liquidity fee statistics for. If omitted, the last complete epoch is used.
party_idsrepeated stringRestrict fee data to those fees paid to the given parties.
paginationoptional PaginationPagination controls.

ListPaidLiquidityFeesResponse

Paid liquidity fees response.

NameTypeDescription
paid_liquidity_feesPaidLiquidityFeesConnectionPage of paid liquidity fees and corresponding page information.

ListPartiesProfilesRequest

Request to list profiles by party ID.

NameTypeDescription
partiesrepeated stringRestrict the returned profiles to only the given party IDs. If not set, all parties' profiles will be returned.
paginationPaginationPagination control.

ListPartiesProfilesResponse

Response from listing parties' profiles.

NameTypeDescription
profilesPartiesProfilesConnectionPage of profile data and corresponding page information.

ListPartiesRequest

Request to list parties by ID

NameTypeDescription
party_idstringRestrict the returned party to only the given party ID. If not set, all parties will be returned.
paginationPaginationPagination control.

ListPartiesResponse

Response from listing parties

NameTypeDescription
partiesPartyConnectionPage of parties data and corresponding page information.

ListPartyMarginModesRequest

Request to retrieve party margin modes.

NameTypeDescription
market_idoptional stringMarket ID to filter for.
party_idoptional stringParty ID to filter for.
paginationoptional PaginationPagination controls.

ListPartyMarginModesResponse

Response containing party margin modes.

NameTypeDescription
party_margin_modesPartyMarginModesConnectionPage of party margin modes data and corresponding page information.

ListPositionsRequest

Request used to list all positions for a party. Optionally, if a market ID is set, the results will be filtered for that market only.

NameTypeDescription
party_idstringParty ID to list positions for, required field.
market_idstringMarket ID to filter for. If empty, no markets will be filtered.
paginationoptional PaginationPagination controls.

ListPositionsResponse

Response for a list of positions for a party

NameTypeDescription
positionsPositionConnectionPage of positions data and corresponding page information.

ListProtocolUpgradeProposalsRequest

Request type for ListProtocolUpgradeProposals; fetches a paginated list of protocol upgrade proposals

NameTypeDescription
statusoptional vega.events.v1.ProtocolUpgradeProposalStatusRestrict protocol upgrade proposals to those with the given status.
approved_byoptional stringRestrict protocol upgrade proposals to those approved by the given node ID.
paginationoptional PaginationPagination controls.

ListProtocolUpgradeProposalsResponse

Response type from a ListProtocolUpgradeProposals RPC call; a paginated list of protocol upgrade proposals

NameTypeDescription
protocol_upgrade_proposalsProtocolUpgradeProposalConnectionPage of protocol upgrade proposals and corresponding page information.

ListReferralSetRefereesRequest

Request to retrieve information about a referral set's referees

NameTypeDescription
referral_set_idoptional stringReferral set ID to retrieve information for
paginationoptional PaginationPagination controls.
referreroptional stringReferrer to filter by. If referrer set ID is provided, this field is ignored.
refereeoptional stringReferee to filter by. If referrer set ID or referrer is provided, this field is ignored.
aggregation_epochsoptional uint32Epochs to aggregate party volume and rewards over. If omitted, 30 epochs will be used.

ListReferralSetRefereesResponse

Response containing information about a referral set's referees

NameTypeDescription
referral_set_refereesReferralSetRefereeConnectionPage of referral set referee data and corresponding page information.

ListReferralSetsRequest

Request to retrieve information about a referral set or sets

NameTypeDescription
referral_set_idoptional stringReferral set ID to retrieve information for
paginationoptional PaginationPagination controls.
referreroptional stringReferrer to filter by. If referrer set ID is provided, this field is ignored.
refereeoptional stringReferee to filter by. If referrer set ID or referrer is provided, this field is ignored.

ListReferralSetsResponse

Response containing information about a referral set or sets

NameTypeDescription
referral_setsReferralSetConnectionPage of referral set data and corresponding page information.

ListRewardSummariesRequest

Request to get reward details for a party

NameTypeDescription
party_idoptional stringRestrict the reward summary to rewards paid to the given parties.
asset_idoptional stringRestrict the reward summary to rewards paid in the given assets.
paginationoptional PaginationPagination controls.

ListRewardSummariesResponse

Response from listing reward details in for a single party

NameTypeDescription
summariesrepeated vega.RewardSummaryPage of rewards details data and corresponding page information.

ListRewardsRequest

Request to get reward details for a party

NameTypeDescription
party_idstringRestrict rewards data to those that were received by the given party.
asset_idoptional stringRestrict rewards data to those that were paid with the given asset ID.
paginationoptional PaginationPagination control.
from_epochoptional uint64Restrict rewards data to those that were paid after and including the given epoch ID.
to_epochoptional uint64Restrict rewards data to those that were paid up to and including the given epoch ID.
team_idoptional stringFilter for rewards paid if the party is a member of the given team
game_idoptional stringFilter for rewards paid if the party participated in the given game

ListRewardsResponse

Response for listing reward details for a single party

NameTypeDescription
rewardsRewardsConnectionPage of rewards data and corresponding page information.

ListStopOrdersRequest

Request that is sent when executing a query for a list of stop orders.

NameTypeDescription
paginationoptional PaginationOptional pagination control.
filteroptional StopOrderFilterOrder filter contains all filtering conditions and values that are applied to the orders listing.

ListStopOrdersResponse

Response that is received from the query to list stop orders.

NameTypeDescription
ordersStopOrderConnectionPage of stop orders data and corresponding page information.

ListSuccessorMarketsRequest

Request for listing successor markets.

NameTypeDescription
market_idstringMarket ID that is a member of the succession line. This can be the original market or any subsequent child market that succeeded it.
include_full_historyboolFlag to indicate whether or not to include the full succession line, or only list the children of the given market ID. If true, the full succession line is included.
paginationPaginationPagination control.

ListSuccessorMarketsResponse

Response from a list successor markets request.

NameTypeDescription
successor_marketsSuccessorMarketConnectionList of markets in the succession line.

ListTeamMembersStatisticsRequest

Request to list all team members' statistics.

NameTypeDescription
team_idstringRestrict team statistics to those with the given team ID.
party_idoptional stringRestrict team members' statistics to those with the given party ID.
aggregation_epochsoptional uint64Defines the number of past epochs to aggregate data from. By default, it takes the last 10 epochs.
paginationoptional PaginationPagination controls.

ListTeamMembersStatisticsResponse

Response for the list team members' statistics request containing the statistics.

NameTypeDescription
statisticsTeamMembersStatisticsConnectionPage of team members' statistics data and corresponding page information.

ListTeamRefereeHistoryRequest

Request that is sent when listing the referee history for a given team.

NameTypeDescription
refereestringParty ID to list referee history for.
paginationoptional PaginationPagination controls.

ListTeamRefereeHistoryResponse

Response that is sent when listing the referee history for a given team.

NameTypeDescription
team_referee_historyTeamRefereeHistoryConnectionPage of team referee history data and corresponding page information.

ListTeamRefereesRequest

Request that is sent when listing the referees for a given team.

NameTypeDescription
team_idstringTeam ID to list referees for.
paginationoptional PaginationPagination controls.

ListTeamRefereesResponse

Response that is sent when listing the referees for a given team.

NameTypeDescription
team_refereesTeamRefereeConnectionPage of team referee data and corresponding page information.

ListTeamsRequest

Request to list all teams

NameTypeDescription
team_idoptional stringRestrict teams to those with the given team ID.
party_idoptional stringRestrict teams to those where the given party is a referrer or a referee.
paginationoptional PaginationPagination controls.

ListTeamsResponse

Response for the list teams request containing the team information.

NameTypeDescription
teamsTeamConnectionPage of team data and corresponding page information.

ListTeamsStatisticsRequest

Request to list all teams' statistics.

NameTypeDescription
team_idoptional stringRestrict team statistics to those with the given team ID.
aggregation_epochsoptional uint64Defines the number of past epochs to aggregate data from. By default, it takes the last 10 epochs.
paginationoptional PaginationPagination controls.

ListTeamsStatisticsResponse

Response for the list teams' statistics request containing the statistics.

NameTypeDescription
statisticsTeamsStatisticsConnectionPage of teams' statistics data and corresponding page information.

ListTradesRequest

Request to list trades

NameTypeDescription
market_idsrepeated stringRestrict trades to those that occurred on the given markets.
order_idsrepeated stringRestrict trades to those that were caused by the given orders.
party_idsrepeated stringRestrict trades to those that were caused by orders placed by the given parties.
paginationoptional PaginationPagination control.
date_rangeoptional DateRangeRestrict trades to those made during the given date range. If not set, all trades will be returned.

ListTradesResponse

Response from listing trades

NameTypeDescription
tradesTradeConnectionPage of trades data and corresponding page information.

ListTransfersRequest

Request that is sent to list transfers

NameTypeDescription
pubkeyoptional stringRestrict transfer to those where the given public key is a sender or receiver.
directionTransferDirectionRestrict 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.
paginationoptional PaginationPagination controls.
is_rewardoptional boolRestrict transfers to those related to reward transfers.
from_epochoptional uint64Epoch to filter from (included). If omitted, the range goes from the oldest epoch to the `to epoch`.
to_epochoptional uint64Epoch to filter to (included). If omitted, the range goes from `from epoch` to the most recent epoch.
statusoptional vega.events.v1.Transfer.StatusStatus to filter on.
scopeoptional ListTransfersRequest.ScopeDispatch strategy's scope to filter for.

ListTransfersResponse

Response that is received when listing transfers

NameTypeDescription
transfersTransferConnectionPage of transfers data and corresponding page information.

ListVotesRequest

Request that is used to list governance votes

NameTypeDescription
party_idoptional stringParty for which the votes are requested.
proposal_idoptional stringProposal ID to list votes for.
paginationoptional PaginationOptional pagination control.

ListVotesResponse

Response that is received when listing Votes

NameTypeDescription
votesVoteConnectionPage of votes data received and corresponding page information.

ListWithdrawalsRequest

List all withdrawals for a given party

NameTypeDescription
party_idstringRestrict withdrawals to those made by this party ID.
paginationoptional PaginationPagination controls.
date_rangeoptional DateRangeDate range of the requested data, if provided.

ListWithdrawalsResponse

Response from listing withdrawals data

NameTypeDescription
withdrawalsWithdrawalsConnectionPage of withdrawals data and corresponding page information.

MarginConnection

Page of margins data and corresponding page information.

NameTypeDescription
edgesrepeated MarginEdgePage of margins data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

MarginEdge

Margin data with the corresponding cursor.

NameTypeDescription
nodevega.MarginLevelsMargin levels data that satisfy a list margin levels request.
cursorstringCursor that can be used to fetch further pages.

MarginEstimate

Margin level estimate for both worst and best case possible.

NameTypeDescription
worst_casevega.MarginLevelsMargin level estimate assuming slippage cap is applied.
best_casevega.MarginLevelsMargin level estimate assuming no slippage.

MarketConnection

Page of markets and corresponding page information.

NameTypeDescription
edgesrepeated MarketEdgePage of markets and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

MarketDataConnection

Page of market data items and corresponding page information

NameTypeDescription
edgesrepeated MarketDataEdgePage of market data items and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

MarketDataEdge

Market data with the corresponding cursor.

NameTypeDescription
nodevega.MarketDataData generated by a market when open.
cursorstringCursor that can be used to fetch further pages.

MarketEdge

Market information with the corresponding cursor.

NameTypeDescription
nodevega.MarketInformation about the market.
cursorstringCursor that can be used to fetch further pages.

NetworkParameterConnection

Page of network parameters and corresponding page information

NameTypeDescription
edgesrepeated NetworkParameterEdgePage of network parameters data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

NetworkParameterEdge

Network parameter with the corresponding cursor.

NameTypeDescription
nodevega.NetworkParameterName and associated value of a network parameter.
cursorstringCursor that can be used to fetch further pages.

NodeBasic

Represents a basic node without any epoch specific details like delegations, staking, rewards etc.

NameTypeDescription
idstringUnique ID identifying the node.
pub_keystringNode operator's public key.
tm_pub_keystringTendermint public key of the node.
ethereum_addressstringEthereum public key of the node.
info_urlstringURL that provides more information about the node.
locationstringCountry code for the location of the node.
statusvega.NodeStatusNode status.
namestringNode name.
avatar_urlstringAvatar URL.

NodeEdge

Node data with the corresponding cursor.

NameTypeDescription
nodevega.NodeData specific to a single node on the Vega network.
cursorstringCursor that can be used to fetch further pages.

NodeSignatureEdge

Nodes signature edge with the corresponding cursor.

NameTypeDescription
nodevega.commands.v1.NodeSignatureNode signature data.
cursorstringCursor that can be used to fetch further pages.

NodeSignaturesConnection

Page of node signatures and corresponding page information.

NameTypeDescription
edgesrepeated NodeSignatureEdgePage of node signatures and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

NodesConnection

Page of node data and corresponding page information

NameTypeDescription
edgesrepeated NodeEdgePage of node data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ObserveAccountsRequest

Request that is sent when getting a subscription to a stream of accounts.

NameTypeDescription
market_idstringMarket ID to filter accounts by. If empty, no markets will be filtered.
party_idstringParty ID to filter accounts by. If empty, no parties will be filtered.
assetstringAsset ID to filter accounts by. If empty, no assets will be filtered.
typevega.AccountTypeAccount type to subscribe to, required field.

ObserveAccountsResponse

Response that is received when subscribing to a stream of accounts.

NameTypeDescription
snapshotAccountSnapshotPage'Initial image' snapshot containing current account balances.
updatesAccountUpdatesList of account updates in the last block.

ObserveCandleDataRequest

Request that is used to subscribe to a stream of candles

NameTypeDescription
candle_idstringUnique ID for the candle.

ObserveCandleDataResponse

Response that is received when subscribing to a stream of candles

NameTypeDescription
candleCandleCandle data.

ObserveDelegationsRequest

Request to subscribe to all event related to delegations, with the given filters

NameTypeDescription
party_idoptional stringParty ID to get delegations for, if provided.
node_idoptional stringNode ID to get delegations for, if provided.

ObserveDelegationsResponse

Response with all events related to delegations, with the given filters

NameTypeDescription
delegationvega.DelegationHow much a party is delegating to a node and when.

ObserveEventBusRequest

Request to subscribe to a stream of one or more event types from the Vega event bus

NameTypeDescription
typerepeated vega.events.v1.BusEventTypeOne or more types of event, required field.
market_idstringMarket ID to filter for, optional field. If empty, no markets will be excluded from the stream.
party_idstringParty ID to filter for, optional field. If empty, no parties will be excluded from the stream.
batch_sizeint64Batch size, If not specified, any events received will be sent immediately. If the client is not ready for the next data-set, data may be dropped a number of times, and eventually the stream is closed. if specified, the first batch will be sent when ready. To receive the next set of events, the client must write an `ObserveEventBatch` message on the stream to flush the buffer. If no message is received in 5 seconds, the stream is closed. Default: 0, send any and all events when they are available.

ObserveEventBusResponse

Response to a subscribed stream of events from the Vega event bus

NameTypeDescription
eventsrepeated vega.events.v1.BusEventList of events that occurred on the Vega event bus.

ObserveGovernanceRequest

Request for governance subscription

NameTypeDescription
party_idoptional stringRestrict proposal updates to those proposed by the given party ID.

ObserveGovernanceResponse

Response from governance subscription

NameTypeDescription
datavega.GovernanceDataGovernance data, i.e. proposal and votes for and against.

ObserveLedgerMovementsRequest

Request to subscribe to ledger movements

NameTypeDescription

ObserveLedgerMovementsResponse

Response from ledger movements subscription

NameTypeDescription
ledger_movementvega.LedgerMovementLedger movements data with list of ledger entries and and post-transfer balances.

ObserveLiquidityProvisionsRequest

Request sent to subscribe to liquidity provisions

NameTypeDescription
market_idoptional stringTarget market to observe for liquidity provisions.
party_idoptional stringTarget party to observe for submitted liquidity provisions.

ObserveLiquidityProvisionsResponse

Response from liquidity provisions subscription

NameTypeDescription
liquidity_provisionsrepeated vega.LiquidityProvision

ObserveMarginLevelsRequest

Request to subscribe to a stream of MarginLevels data. If a party ID is provided, the stream will contain margin levels for that party only. Optionally, the list can be additionally filtered by market

NameTypeDescription
party_idstringRestrict margin level updates to those relating to the given party.
market_idoptional stringRestrict margin level updates to those relating to the given market.

ObserveMarginLevelsResponse

Response from subscribing to margin levels data

NameTypeDescription
margin_levelsvega.MarginLevelsMargin levels data that match the subscription request filters.

ObserveMarketsDataRequest

Request that is sent for market data subscription

NameTypeDescription
market_idsrepeated stringRestrict updates to market data by the given market IDs.

ObserveMarketsDataResponse

Response that is received for market data subscription

NameTypeDescription
market_datarepeated vega.MarketDataList of market data.

ObserveMarketsDepthRequest

Request that is sent to get market depth subscription

NameTypeDescription
market_idsrepeated stringRestrict market depth data by the given market IDs.

ObserveMarketsDepthResponse

Response that is received for MarketDepth subscription.

NameTypeDescription
market_depthrepeated vega.MarketDepthList of market depth data.

ObserveMarketsDepthUpdatesRequest

Request that is sent for market depth update subscription

NameTypeDescription
market_idsrepeated stringRestrict updates to market depth by the given market IDs.

ObserveMarketsDepthUpdatesResponse

Response that is received for market depth update subscription

NameTypeDescription
updaterepeated vega.MarketDepthUpdateList of market depth update data.

ObserveOrdersRequest

Request to subscribe to a stream of orders. Request fields market ID and party ID are both optional filters: If omitted all orders, for all parties on all markets will be returned on the stream Both filters can be combined

NameTypeDescription
market_idsrepeated stringRestrict orders to those placed on the given markets.
party_idsrepeated stringRestrict orders to those placed on the by the given parties.
exclude_liquidityoptional boolWhether liquidity orders should be excluded from the stream. If not set, liquidity orders will be included.

ObserveOrdersResponse

Response that is received from an orders subscription.

NameTypeDescription
snapshotOrderSnapshotPageAn 'initial image' snapshot containing current live orders.
updatesOrderUpdatesList of order updates in the last block.

ObservePositionsRequest

Request that is used to subscribe to a stream of positions

NameTypeDescription
party_idoptional stringRestrict position updates to those related to the given parties.
market_idoptional stringRestrict position updates to those related to the given markets.

ObservePositionsResponse

Response received from a positions subscription request

NameTypeDescription
snapshotPositionSnapshotPageAn 'initial image' snapshot containing current positions.
updatesPositionUpdatesList of position updates in the last block.

ObserveRewardsRequest

Request sent for subscribing to rewards

NameTypeDescription
asset_idoptional stringAsset ID to get rewards data for, if provided.
party_idoptional stringParty ID to get rewards data for, if provided.

ObserveRewardsResponse

Response that is received from subscribing to rewards data

NameTypeDescription
rewardvega.RewardRewards data received.

ObserveTradesRequest

Request to subscribe to a stream of trades Request fields market ID and party ID are both optional filters: If omitted all trades, for all parties on all markets will be returned on the stream If market ID is given, trades from that market will be returned on the stream If party ID is given, trades from that party will be returned on the stream Both filters can be combined.

NameTypeDescription
market_idsrepeated stringRestrict the trades streamed to those made on the given markets.
party_idsrepeated stringRestrict the trades streamed to those made by the given parties.

ObserveTradesResponse

Stream of trades

NameTypeDescription
tradesrepeated vega.TradeList of 0 or more trades.

ObserveTransactionResultsRequest

Request to subscribe to a stream of users' transaction results Request fields party ID, hash and status are all optional filters: If omitted all transaction results, for all parties with all hashes and states will be returned on the stream If party ID is given, transaction results from that party will be returned on the stream If hash is given, transaction result with that hash will be returned on the stream If status is given, transaction result with that status (true/false - success failure) will be returned on the stream All filters can be combined.

NameTypeDescription
party_idsrepeated stringRestrict the transaction results streamed to those made by the given parties.
hashesrepeated stringRestrict the transaction results streamed to those with given hashes.
statusoptional boolRestrict the transaction results streamed to those with given status true/false (success/failure).

ObserveTransactionResultsResponse

Stream of transaction results

NameTypeDescription
transaction_resultsrepeated vega.events.v1.TransactionResultList of 0 or more transaction results.

ObserveVotesRequest

Request that is sent to subscribe to votes

NameTypeDescription
party_idoptional stringRestrict vote updates to those made by the given party.
proposal_idoptional stringRestrict vote updates to those made on the given proposal.

ObserveVotesResponse

Response that is received from votes subscription

NameTypeDescription
votevega.VoteData associated with governance votes that are published to the stream.

OracleDataConnection

Page of oracle data and corresponding page information.

NameTypeDescription
edgesrepeated OracleDataEdgePage of oracle data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

OracleDataEdge

Oracle data item with the corresponding cursor.

NameTypeDescription
nodevega.OracleDataData that was received from an external oracle.
cursorstringCursor that can be used to fetch further pages.

OracleSpecEdge

Oracle specs data item with the corresponding cursor.

NameTypeDescription
nodevega.OracleSpecExternal spec data that satisfies the list request.
cursorstringCursor that can be used to fetch further pages.

OracleSpecsConnection

Page of oracle specs and corresponding page information

NameTypeDescription
edgesrepeated OracleSpecEdgePage of oracle specs data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

OrderConnection

Page of orders data and corresponding page information.

NameTypeDescription
edgesrepeated OrderEdgePage of orders and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

OrderEdge

Order data with the corresponding cursor.

NameTypeDescription
nodevega.OrderData associated with an order submitted to a Vega node.
cursorstringCursor that can be used to fetch further pages.

OrderFilter

Order filter that contains all filtering conditions and values that are applied to the orders listing

NameTypeDescription
statusesrepeated vega.Order.StatusRestrict orders to those with the given statuses.
typesrepeated vega.Order.TypeRestrict orders to those with the given types.
time_in_forcesrepeated vega.Order.TimeInForceRestrict orders to those with the given Time In Force.
exclude_liquidityboolIndicator if liquidity provisions should be included or not in the list.
party_idsrepeated stringRestrict orders to those placed by the given party IDs.
market_idsrepeated stringRestrict orders to those placed on the given market IDs.
referenceoptional stringRestrict orders to those with the given reference.
date_rangeoptional DateRangeRestrict orders to those placed during the given date range. If not set, all orders will be returned.
live_onlyoptional boolRestrict orders to those that are live. If not set, it is treated as being false.

OrderInfo

Basic description of an order.

NameTypeDescription
sidevega.SideSide for the order, e.g. buy or sell.
pricestringPrice for the order. The price is an unsigned integer. For example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places.
remaininguint64Size remaining.
is_market_orderboolBoolean that indicates if it is a market order.

OrderSnapshotPage

'Initial image' of live orders, may be sent over multiple response messages.

NameTypeDescription
ordersrepeated vega.OrderList of order data parts.
last_pageboolIndicator if the last page is reached or not.

OrderUpdates

List of order updates in the last block.

NameTypeDescription
ordersrepeated vega.OrderList of orders data.

PageInfo

Page information for cursor based pagination

NameTypeDescription
has_next_pageboolIndicator if there is a next page.
has_previous_pageboolIndicator if there is a previous page.
start_cursorstringStart cursor.
end_cursorstringEnd cursor.

Pagination

All data returned from the API is ordered in a well-defined manner. The specific columns and the order in which the sorting is performed depend on the API endpoint being called. However, the primary sorting column is usually the timestamp of the block in which the data was last updated. To prevent excessively large response messages and to avoid overloading database resources, the API employs a cursor-based pagination mechanism. This Pagination message can be optionally provided as part of the request to specify: - The starting point within the total result set for beginning the page - The size of the returned page - The ordering of the data within that page If no Pagination message is provided, the API will return the first page of data using the default page size. The default page size is 1000. To retrieve subsequent pages, the caller must examine the PageInfo structure returned in the response to find a cursor string that uniquely identifies the last row of that page. This cursor should then be passed in the 'after' field of the Pagination message in a subsequent request. For paging backward, take the cursor for the first row of the page from PageInfo and pass it in the 'before' field of the Pagination message. Pagination message that uses both first/after and last/before is considered invalid.

NameTypeDescription
firstoptional int32Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.
afteroptional stringIf paging forwards, the cursor string for the last row of the previous page.
lastoptional int32Number of records to be returned that sort less than row identified by cursor supplied in 'before'.
beforeoptional stringIf paging forwards, the cursor string for the first row of the previous page.
newest_firstoptional boolWhether to order the results with the newest records first. If not set, the default value is true.

PaidLiquidityFeesConnection

Paid liquidity fees data and corresponding page information.

NameTypeDescription
edgesrepeated PaidLiquidityFeesEdgePage of paid liquidity fees data.
page_infoPageInfoPage information that is used for fetching further pages.

PaidLiquidityFeesEdge

Paid liquidity fees data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.PaidLiquidityFeesStatsPaid liquidity fees data returned by the API.
cursorstringCursor that can be used to fetch further data.

PartiesProfilesConnection

Page of profile data per party and corresponding page information.

NameTypeDescription
edgesrepeated PartyProfileEdgePage of profiles and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

PartyConnection

Page of parties data and corresponding page information.

NameTypeDescription
edgesrepeated PartyEdgePage of parties and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

PartyEdge

Party data with the corresponding cursor.

NameTypeDescription
nodevega.PartyData associated with a party.
cursorstringCursor that can be used to fetch further pages.

PartyMarginMode

Margin mode selected for the given party and market.

NameTypeDescription
market_idstringUnique ID of the market.
party_idstringUnique ID of the party.
margin_modevega.MarginModeSelected margin mode.
margin_factoroptional stringMargin factor for the market. Isolated mode only.
min_theoretical_margin_factoroptional stringMinimum theoretical margin factor for the market. Isolated mode only.
max_theoretical_leverageoptional stringMaximum theoretical leverage for the market. Isolated mode only.
at_epochuint64Epoch at which the update happened.

PartyMarginModeEdge

Party margin mode information and corresponding cursor.

NameTypeDescription
nodePartyMarginModeParty margin mode data.
cursorstringCursor that can be used to fetch further pages.

PartyMarginModesConnection

Page of party margin modes data and corresponding page information.

NameTypeDescription
edgesrepeated PartyMarginModeEdgePage of party margin modes data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

PartyProfileEdge

Party's profile data with the corresponding cursor.

NameTypeDescription
nodevega.PartyProfileData associated with a party's profile.
cursorstringCursor that can be used to fetch further pages.

PingRequest

Request to ping the data node

NameTypeDescription

PingResponse

Ping response from the data node

NameTypeDescription

PositionConnection

Page of positions and corresponding page information

NameTypeDescription
edgesrepeated PositionEdgePage of positions data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

PositionEdge

Position data with the corresponding cursor.

NameTypeDescription
nodevega.PositionPosition data for a party on a market.
cursorstringCursor that can be used to fetch further pages.

PositionSnapshotPage

'Initial image' of current positions, may be sent over multiple response messages

NameTypeDescription
positionsrepeated vega.PositionList of positions data.
last_pageboolIndicator if last page is reached or not.

PositionUpdates

List of position updates in the last block

NameTypeDescription
positionsrepeated vega.PositionList of positions data.

PositionsFilter

Filter to apply to the ListAllPositionsRequest

NameTypeDescription
party_idsrepeated stringRestrict positions to those related to the given parties.
market_idsrepeated stringRestrict positions to those on the given markets.

ProtocolUpgradeProposalConnection

Page of protocol upgrade proposals and corresponding page information

NameTypeDescription
edgesrepeated ProtocolUpgradeProposalEdgePage of protocol upgrade proposals data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ProtocolUpgradeProposalEdge

Protocol upgrade proposal data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.ProtocolUpgradeEventProtocol upgrade proposal data.
cursorstringCursor that can be used to fetch further pages.

QuantumRewardsPerEpoch

NameTypeDescription
epochuint64Epoch for which this information is valid.
total_quantum_rewardsstringTotal rewards accumulated over the epoch period, expressed in quantum value.

QuantumVolumesPerEpoch

NameTypeDescription
epochuint64Epoch for which this information is valid.
total_quantum_volumesstringTotal volumes accumulated over the epoch period, expressed in quantum value.

ReferralProgram

Referral program details.

NameTypeDescription
versionuint64Incremental version of the program. It is incremented after each program update.
idstringUnique ID generated from the proposal that created this program.
benefit_tiersrepeated vega.BenefitTierDefined tiers in increasing order. First element will give Tier 1, second element will give Tier 2, and so on.
end_of_program_timestampint64Timestamp in Unix nanoseconds, after which when the current epoch ends, the program will end and benefits will be disabled.
window_lengthuint64Number of epochs over which the referral set's running volume is evaluated.
staking_tiersrepeated vega.StakingTierDefined benefit tiers ordered by increasing reward multiplier. Determines the level of benefit a party can expect based on their staking.
ended_atoptional int64Timestamp, in Unix nanoseconds, when the program ended.

ReferralSet

Data relating to a referral set.

NameTypeDescription
idstringUnique ID of the created set.
referrerstringParty that created the set.
created_atint64Timestamp, in Unix nanoseconds, when the set was created.
updated_atint64Timestamp, in Unix nanoseconds, when the set was updated.
total_membersuint64Current number of members in the referral set.

ReferralSetConnection

Page of referral set data and corresponding page information.

NameTypeDescription
edgesrepeated ReferralSetEdgePage of referral set data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ReferralSetEdge

Referral set data with the corresponding cursor.

NameTypeDescription
nodeReferralSetReferral set data.
cursorstringCursor that can be used to fetch further pages.

ReferralSetReferee

Data relating to referees that have joined a referral set

NameTypeDescription
referral_set_idstringUnique ID of the referral set the referee joined.
refereestringParty that joined the set.
joined_atint64Timestamp, in Unix nanoseconds, when the party joined the set.
at_epochuint64Epoch at which the party joined the set.
total_referee_notional_taker_volumestringTotal notional volume of the referee's aggressive trades over the aggregation period.
total_referee_generated_rewardsstringTotal rewards generated by the referee over the aggregation period.

ReferralSetRefereeConnection

Page of data about the referral set's referees and corresponding page information.

NameTypeDescription
edgesrepeated ReferralSetRefereeEdgePage of referral set referee data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ReferralSetRefereeEdge

Data about the Referral set's referees with the corresponding cursor.

NameTypeDescription
nodeReferralSetRefereeReferral set referee data.
cursorstringCursor that can be used to fetch further pages.

ReferralSetStats

Referral set statistics for a given epoch for a party.

NameTypeDescription
at_epochuint64Epoch at which the set's statistics were updated.
referral_set_running_notional_taker_volumestringRunning volume for the set based on the window length of the current referral program.
party_idstringParty ID.
discount_factorstringDiscount factor applied to the party.
reward_factorstringReward factor applied to the party.
epoch_notional_taker_volumestringCurrent referee notional taker volume.
rewards_multiplierstringMultiplier applied to the referral reward factor when calculating referral rewards due to the referrer.
rewards_factor_multiplierstringProportion of the referee's taker fees to be rewarded to the referrer.
was_eligibleboolIndicates if the referral set was eligible to be part of the referral program.
referrer_taker_volumestringReferrer's taker volume

ReferralSetStatsConnection

Page of volume discount stats data and corresponding page information.

NameTypeDescription
edgesrepeated ReferralSetStatsEdgePage of volume discount statistics data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

ReferralSetStatsEdge

Referral set stats data with the corresponding cursor.

NameTypeDescription
nodeReferralSetStatsReferral set stats data.
cursorstringCursor that can be used to fetch further pages.

RewardEdge

Rewards data with the corresponding cursor.

NameTypeDescription
nodevega.RewardDetails for a single reward payment.
cursorstringCursor that can be used to fetch further pages.

RewardSummaryFilter

Filter to restrict the results returned by the ListEpochRewardSummaries

NameTypeDescription
asset_idsrepeated stringRestrict reward summaries to those connected to the assets in the given list.
market_idsrepeated stringRestrict reward summaries to those connected to the markets in the given list.
from_epochoptional uint64Restrict rewards summaries to those that were paid after and including the given epoch ID.
to_epochoptional uint64Restrict rewards summaries to those that were paid up to and including the given epoch ID.

RewardsConnection

Page of rewards data and corresponding page information.

NameTypeDescription
edgesrepeated RewardEdgePage of rewards data items and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

StakeLinkingEdge

Stake linking data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.StakeLinkingStake linking represent the intent from a party to deposit.
cursorstringCursor that can be used to fetch further pages.

StakesConnection

Page of stake data and corresponding page information.

NameTypeDescription
edgesrepeated StakeLinkingEdgePage of stake data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

StopOrderConnection

Page of stop orders data and corresponding page information.

NameTypeDescription
edgesrepeated StopOrderEdgePage of stop orders and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

StopOrderEdge

Order data with the corresponding cursor.

NameTypeDescription
nodevega.events.v1.StopOrderEventData associated with an order submitted to a Vega node.
cursorstringCursor that can be used to fetch further pages.

StopOrderFilter

Stop order filter Stop order filter that contains all filtering conditions and values that are applied to the stop orders listing.

NameTypeDescription
statusesrepeated vega.StopOrder.StatusRestrict orders to those with the given statuses.
expiry_strategiesrepeated vega.StopOrder.ExpiryStrategyRestrict orders to those with the given expiry strategies.
date_rangeoptional DateRangeRestrict orders to those placed during the given date range. If not set, all orders will be returned.
party_idsrepeated stringRestrict orders to those placed by the given party IDs.
market_idsrepeated stringRestrict orders to those placed on the given market IDs.
live_onlyoptional boolLive stop orders only

SuccessorMarket

Successor market information includes the market that is a member of the succession line and any governance data that is associated with proposals for child markets whether enacted or not.

NameTypeDescription
marketvega.MarketThe market that is a member of the succession line.
proposalsrepeated vega.GovernanceDataAll proposals for child markets that have the market as a parent.

SuccessorMarketConnection

Page of successor market records and corresponding page information.

NameTypeDescription
edgesrepeated SuccessorMarketEdgePage of successor markets and their cursors.
page_infoPageInfoPage information for pagination control.

SuccessorMarketEdge

Successor market record with the corresponding cursor for paginated results

NameTypeDescription
nodeSuccessorMarketSuccessor market record.
cursorstringCursor identifying the record for pagination control.

Team

Team record containing the team information.

NameTypeDescription
team_idstringID of the created team.
referrerstringParty ID that created the team.
namestringName of the team.
team_urloptional stringLink to the team's homepage.
avatar_urloptional stringLink to an image of the team's avatar.
created_atint64Timestamp in Unix nanoseconds when the team was created.
closedboolWhether or not the team is closed to new party members. When closed, only parties specified in the allow list can join the team.
created_at_epochuint64Epoch at which the team was created.
allow_listrepeated stringList of public keys that are allowed to join the team. Only applicable to closed teams.
total_membersuint64Current number of members in the team.

TeamConnection

Page of team data and corresponding page information.

NameTypeDescription
edgesrepeated TeamEdgePage of team data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TeamEdge

Team data item with the corresponding cursor.

NameTypeDescription
nodeTeamTeam data.
cursorstringCursor that can be used to fetch further pages.

TeamGameEntities

List of teams that are participating in a game

NameTypeDescription
teamrepeated TeamGameEntityList of teams, the participant members of a team, and the metrics associated with each participant.

TeamGameEntity

Data relating to a team participating in a game.

NameTypeDescription
teamTeamGameParticipationTeam participation breakdown
rankuint64Rank of the team in the game
volumestringVolume traded by the team
reward_metricvega.DispatchMetricReward metric applied to the team
reward_earnedstringReward earned by the team
total_rewards_earnedstringTotal rewards earned by the individual for the team
reward_earned_quantumstringRewards earned by the team in quantum value
total_rewards_earned_quantumstringTotal rewards earned by the team in quantum value

TeamGameParticipation

Breakdown of a team's participation in a game.

NameTypeDescription
team_idstringID of the team participating
members_participatingrepeated IndividualGameEntityIndividual team member metrics for their participation in the game

TeamMemberStatistics

Team member's statistics record containing the team member's information.

NameTypeDescription
party_idstringParty ID the statistics are related to.
total_quantum_volumestringTotal of volume accumulated over the requested epoch period, expressed in quantum value.
total_quantum_rewardsstringTotal of rewards accumulated over the requested epoch period, expressed in quantum value.
quantum_rewardsrepeated QuantumRewardsPerEpochList of rewards over the requested epoch period, expressed in quantum value for each epoch.
total_games_playeduint64Total number of games played.
games_playedrepeated stringList of games played over the requested epoch period.
quantum_volumesrepeated QuantumVolumesPerEpochList of volumes over the requested epoch period, expressed in quantum value for each epoch.

TeamMemberStatisticsEdge

Team member data item with the corresponding cursor.

NameTypeDescription
nodeTeamMemberStatisticsTeam member's statistics data.
cursorstringCursor that can be used to fetch further pages.

TeamMembersStatisticsConnection

Page of team members' statistics and corresponding page information.

NameTypeDescription
edgesrepeated TeamMemberStatisticsEdgePage of team member data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TeamReferee

A team's referee info

NameTypeDescription
team_idstringID of the team the referee joined.
refereestringParty that joined the team.
joined_atint64Timestamp in Unix nanoseconds when the party joined the team.
joined_at_epochuint64Epoch at which the party joined the team.

TeamRefereeConnection

Page of team referee data and corresponding page information.

NameTypeDescription
edgesrepeated TeamRefereeEdgePage of team referee data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TeamRefereeEdge

Team referee data item with the corresponding cursor.

NameTypeDescription
nodeTeamRefereeTeam referee data.
cursorstringCursor that can be used to fetch further pages.

TeamRefereeHistory

A referee's team change information

NameTypeDescription
team_idstringID of the team the referee joined.
joined_atint64Timestamp in Unix nanoseconds when the party joined the team.
joined_at_epochuint64Epoch at which the party joined the team.

TeamRefereeHistoryConnection

Page of history data about a referee's team membership and corresponding page information.

NameTypeDescription
edgesrepeated TeamRefereeHistoryEdgePage of team referee history data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TeamRefereeHistoryEdge

Team referee history data item with the corresponding cursor.

NameTypeDescription
nodeTeamRefereeHistoryTeam referee data.
cursorstringCursor that can be used to fetch further pages.

TeamStatistics

Team's statistics record containing the team information.

NameTypeDescription
team_idstringTeam ID the statistics are related to.
total_quantum_volumestringTotal of volume accumulated over the requested epoch period, expressed in quantum value.
total_quantum_rewardsstringTotal of rewards accumulated over the requested epoch period, expressed in quantum value.
quantum_rewardsrepeated QuantumRewardsPerEpochList of rewards over the requested epoch period, expressed in quantum value for each epoch.
total_games_playeduint64Total of games played.
games_playedrepeated stringList of games played over the requested epoch period.
quantum_volumesrepeated QuantumVolumesPerEpochList of volumes over the requested epoch period, expressed in quantum value for each epoch.

TeamStatisticsEdge

Team data item with the corresponding cursor.

NameTypeDescription
nodeTeamStatisticsTeam's statistics data.
cursorstringCursor that can be used to fetch further pages.

TeamsStatisticsConnection

Page of teams' statistics and corresponding page information.

NameTypeDescription
edgesrepeated TeamStatisticsEdgePage of team data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TradeConnection

Page of trades and corresponding page information

NameTypeDescription
edgesrepeated TradeEdgePage of trades and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TradeEdge

Trade data item with the corresponding cursor..

NameTypeDescription
nodevega.TradeData associated with a trade that has been executed.
cursorstringCursor that can be used to fetch further pages.

TransferConnection

Page of transfers data items and corresponding page information

NameTypeDescription
edgesrepeated TransferEdgePage of transfers data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

TransferEdge

Transfers data with the corresponding cursor.

NameTypeDescription
nodeTransferNodeData relating to a transfer that has been made.
cursorstringCursor that can be used to fetch further pages.

TransferNode

NameTypeDescription
transfervega.events.v1.TransferData relating to a transfer that has been made.
feesrepeated vega.events.v1.TransferFeesFees paid for this transfer.

VolumeDiscountProgram

Volume discount program details.

NameTypeDescription
versionuint64Incremental version of the program. It is incremented after each program update.
idstringUnique ID generated from the proposal that created this program.
benefit_tiersrepeated vega.VolumeBenefitTierDefined benefit tiers ordered by increasing discounts. Determines the level of benefit a party can expect based on performance criteria.
end_of_program_timestampint64Timestamp in Unix nanoseconds, after which when the current epoch ends, the program will end and benefits will be disabled.
window_lengthuint64Number of epochs over which a volume discount statistics' running volume is evaluated.
ended_atoptional int64Timestamp in Unix nanoseconds, at which the program ended.

VolumeDiscountStats

Volume discount statistics for a given epoch for all parties.

NameTypeDescription
at_epochuint64Epoch at which the statistics apply.
party_idstringParty ID for which the statistics apply.
discount_factorstringDiscount factor applied given the party's running volume.
running_volumestringThe party's running volume.

VolumeDiscountStatsConnection

Page of volume discount stats data and corresponding page information.

NameTypeDescription
edgesrepeated VolumeDiscountStatsEdgePage of volume discount statistics data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

VolumeDiscountStatsEdge

Volume discount stats data with the corresponding cursor.

NameTypeDescription
nodeVolumeDiscountStatsVolume discount stats data.
cursorstringCursor that can be used to fetch further pages.

VoteConnection

Page of vote data items and corresponding page information

NameTypeDescription
edgesrepeated VoteEdgePage of vote data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

VoteEdge

Votes data with the corresponding cursor.

NameTypeDescription
nodevega.VoteData associated with a governance vote.
cursorstringCursor that can be used to fetch further pages.

WithdrawalEdge

Withdrawals data with the corresponding cursor.

NameTypeDescription
nodevega.WithdrawalData associated with a single withdrawal made from the Vega network.
cursorstringCursor that can be used to fetch further pages.

WithdrawalsConnection

Page of withdrawals data and corresponding page information

NameTypeDescription
edgesrepeated WithdrawalEdgePage of withdrawals data and their corresponding cursors.
page_infoPageInfoPage information that is used for fetching further pages.

Enums

AccountField

List of the properties of an account, used for grouping

NameNumberDescription
ACCOUNT_FIELD_UNSPECIFIED0
ACCOUNT_FIELD_ID1
ACCOUNT_FIELD_PARTY_ID2
ACCOUNT_FIELD_ASSET_ID3
ACCOUNT_FIELD_MARKET_ID4
ACCOUNT_FIELD_TYPE5

LedgerEntryField

List of fields for a ledger entry

NameNumberDescription
LEDGER_ENTRY_FIELD_UNSPECIFIED0
LEDGER_ENTRY_FIELD_ACCOUNT_FROM_ID1
LEDGER_ENTRY_FIELD_ACCOUNT_TO_ID2
LEDGER_ENTRY_FIELD_TRANSFER_TYPE3

ListGovernanceDataRequest.Type

Filter for the types of governance proposals to view

NameNumberDescription
TYPE_UNSPECIFIED0
TYPE_ALL1List all proposals
TYPE_NEW_MARKET2List new market proposals
TYPE_UPDATE_MARKET3List update market proposals
TYPE_NETWORK_PARAMETERS4List change Vega network parameter proposals
TYPE_NEW_ASSET5New asset proposals
TYPE_NEW_FREE_FORM6Proposals for creating a new free form proposal
TYPE_UPDATE_ASSET7Update asset proposals
TYPE_NEW_SPOT_MARKET8Propose a new spot market
TYPE_UPDATE_SPOT_MARKET9Update an existing spot market
TYPE_NEW_TRANSFER10Propose a new transfer
TYPE_CANCEL_TRANSFER11Proposal to cancel a transfer
TYPE_UPDATE_MARKET_STATE12Proposal for updating the state of a market
TYPE_UPDATE_REFERRAL_PROGRAM13Proposal to update the referral program
TYPE_UPDATE_VOLUME_DISCOUNT_PROGRAM14Proposal to update the volume discount program

ListTransfersRequest.Scope

Defines the types of a dispatch strategy's scope the API can filter on.

NameNumberDescription
SCOPE_UNSPECIFIED0
SCOPE_INDIVIDUAL1Matches transfers that have dispatch strategy scope of individual set.
SCOPE_TEAM2Matches transfers that have dispatch strategy scope of team set.

Table

NameNumberDescription
TABLE_UNSPECIFIED0
TABLE_BALANCES1
TABLE_CHECKPOINTS2
TABLE_DELEGATIONS3
TABLE_LEDGER4
TABLE_ORDERS5
TABLE_TRADES6
TABLE_MARKET_DATA7
TABLE_MARGIN_LEVELS8
TABLE_POSITIONS9
TABLE_LIQUIDITY_PROVISIONS10
TABLE_MARKETS11
TABLE_DEPOSITS12
TABLE_WITHDRAWALS13
TABLE_BLOCKS14
TABLE_REWARDS15

TransferDirection

Direction of a transfer

NameNumberDescription
TRANSFER_DIRECTION_UNSPECIFIED0
TRANSFER_DIRECTION_TRANSFER_FROM1
TRANSFER_DIRECTION_TRANSFER_TO2
TRANSFER_DIRECTION_TRANSFER_TO_OR_FROM3

Services

TradingDataService

ListAccounts

MethodListAccounts
RequestListAccountsRequest
ResponseListAccountsResponse
DescriptionList accounts Get a list of accounts matching the supplied filter, including their current balances. If a given account has never had a balance, it will be absent from the list.

ObserveAccounts

MethodObserveAccounts
RequestObserveAccountsRequest
ResponseObserveAccountsResponse stream
DescriptionAccounts subscription Subscribe to a stream of accounts

Info

MethodInfo
RequestInfoRequest
ResponseInfoResponse
DescriptionData node information Get information about the data node. Response contains a semver formatted version of the data node and the commit hash, from which the data node was built

GetOrder

MethodGetOrder
RequestGetOrderRequest
ResponseGetOrderResponse
DescriptionGet order Get an order by its ID. An order's ID will be the SHA3-256 hash of the signature that the order was submitted with

ListOrders

MethodListOrders
RequestListOrdersRequest
ResponseListOrdersResponse
DescriptionList orders Get a list of orders that match the given filters

ListOrderVersions

MethodListOrderVersions
RequestListOrderVersionsRequest
ResponseListOrderVersionsResponse
DescriptionList order versions Get a list of all versions of an order in the order history

ObserveOrders

MethodObserveOrders
RequestObserveOrdersRequest
ResponseObserveOrdersResponse stream
DescriptionObserve orders Subscribe to a stream of orders

GetStopOrder

MethodGetStopOrder
RequestGetStopOrderRequest
ResponseGetStopOrderResponse
DescriptionGet stop order Get a stop order by its ID. A stop order's ID will be the SHA3-256 hash of the signature that the order was submitted with. A stop order's ID is likely to be different from the ID of the order that will be submitted when the stop is triggered.

ListStopOrders

MethodListStopOrders
RequestListStopOrdersRequest
ResponseListStopOrdersResponse
DescriptionList stop orders Get a list of stop orders that match the given filters

ListPositions

MethodListPositions
RequestListPositionsRequest
ResponseListPositionsResponse
DescriptionDeprecated: List positions Get a list of positions by party's public key using cursor based pagination Deprecated: use ListAllPositions instead

ListAllPositions

MethodListAllPositions
RequestListAllPositionsRequest
ResponseListAllPositionsResponse
DescriptionList positions Get a list of all of a party's positions

ObservePositions

MethodObservePositions
RequestObservePositionsRequest
ResponseObservePositionsResponse stream
DescriptionObserve positions Subscribe to a stream of position updates. The first messages sent through the stream will contain information about current positions, followed by updates to those positions.

ListLedgerEntries

MethodListLedgerEntries
RequestListLedgerEntriesRequest
ResponseListLedgerEntriesResponse
DescriptionList ledger entries Get a list of ledger entries within the given date range. The date range is restricted to a maximum of 5 days. This query requests and sums the number of ledger entries from a given subset of accounts, specified via the 'filter' argument. It returns a time series - implemented as a list of AggregateLedgerEntry structs - with a row for every time the summed ledger entries of the set of specified accounts changes. Each account filter must contain no more than one party ID. At least one party ID must be specified in the from or to account filter. Entries can be filtered by: - the sending account (market ID, asset ID, account type) - receiving account (market ID, asset ID, account type) - sending AND receiving account - transfer type either in addition to the above filters or as a standalone option Note: The date range is restricted to any 5 days. If no start or end date is provided, only ledger entries from the last 5 days will be returned. If a start and end date are provided, but the end date is more than 5 days after the start date, only data up to 5 days after the start date will be returned. If a start date is provided but no end date, the end date will be set to 5 days after the start date. If no start date is provided, but the end date is, the start date will be set to 5 days before the end date.

ExportLedgerEntries

MethodExportLedgerEntries
RequestExportLedgerEntriesRequest
ResponseHttpBody stream
DescriptionExport ledger entries Export ledger entries records ledger entries to a csv file. May or may not contain a date range - if no date range is provided, list all records for all times. Ledger entries can be exported by: - export ledger entries for a single party for a given asset within a given time range - export ledger entries for a single party for a given asset for all times buf:lint:ignore RPC_RESPONSE_STANDARD_NAME buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE

ListBalanceChanges

MethodListBalanceChanges
RequestListBalanceChangesRequest
ResponseListBalanceChangesResponse
DescriptionList balance changes Get a list of the changes in account balances over a period of time.

GetLatestMarketData

MethodGetLatestMarketData
RequestGetLatestMarketDataRequest
ResponseGetLatestMarketDataResponse
DescriptionGet latest market data Get the latest market data for a given market

ListLatestMarketData

MethodListLatestMarketData
RequestListLatestMarketDataRequest
ResponseListLatestMarketDataResponse
DescriptionList latest market data Get a list of the latest market data for every market

GetLatestMarketDepth

MethodGetLatestMarketDepth
RequestGetLatestMarketDepthRequest
ResponseGetLatestMarketDepthResponse
DescriptionGet latest market depth Get the latest market depth for a given market

ObserveMarketsDepth

MethodObserveMarketsDepth
RequestObserveMarketsDepthRequest
ResponseObserveMarketsDepthResponse stream
DescriptionObserve markets depth Subscribe to a stream of the latest market depth for a given market

ObserveMarketsDepthUpdates

MethodObserveMarketsDepthUpdates
RequestObserveMarketsDepthUpdatesRequest
ResponseObserveMarketsDepthUpdatesResponse stream
DescriptionObserve markets depth updates Subscribe to a stream of updates on market depth for a given market

ObserveMarketsData

MethodObserveMarketsData
RequestObserveMarketsDataRequest
ResponseObserveMarketsDataResponse stream
DescriptionObserve markets data Subscribe to a stream of data about a given market

GetMarketDataHistoryByID

MethodGetMarketDataHistoryByID
RequestGetMarketDataHistoryByIDRequest
ResponseGetMarketDataHistoryByIDResponse
DescriptionGet market data history Get market data history for a market ID from between a given date range

ListTransfers

MethodListTransfers
RequestListTransfersRequest
ResponseListTransfersResponse
DescriptionList 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

GetTransfer

MethodGetTransfer
RequestGetTransferRequest
ResponseGetTransferResponse
DescriptionGet transfer by ID Get a specific transfer by ID

GetNetworkLimits

MethodGetNetworkLimits
RequestGetNetworkLimitsRequest
ResponseGetNetworkLimitsResponse
DescriptionGet network limits Get the network limits relating to asset and market creation

ListCandleData

MethodListCandleData
RequestListCandleDataRequest
ResponseListCandleDataResponse
DescriptionList candle data Get a list of candle data for a given candle ID. Candle IDs can be obtained by calling list-candle-intervals

ObserveCandleData

MethodObserveCandleData
RequestObserveCandleDataRequest
ResponseObserveCandleDataResponse stream
DescriptionObserve candle data Subscribe to a stream of candle updates

ListCandleIntervals

MethodListCandleIntervals
RequestListCandleIntervalsRequest
ResponseListCandleIntervalsResponse
DescriptionList candle intervals Get a list of all available intervals for a given market along with the corresponding candle ID

ListVotes

MethodListVotes
RequestListVotesRequest
ResponseListVotesResponse
DescriptionList votes Get a list of votes. A party ID or a proposal ID must be provided.

ObserveVotes

MethodObserveVotes
RequestObserveVotesRequest
ResponseObserveVotesResponse stream
DescriptionObserve votes Subscribe to a stream of votes cast on a given proposal, or by all votes made by a given party

ListERC20MultiSigSignerAddedBundles

MethodListERC20MultiSigSignerAddedBundles
RequestListERC20MultiSigSignerAddedBundlesRequest
ResponseListERC20MultiSigSignerAddedBundlesResponse
DescriptionList ERC20 multi-sig signer added bundles Get a list of the signature bundles to add a particular validator to the signer list of the multisig contract

ListERC20MultiSigSignerRemovedBundles

MethodListERC20MultiSigSignerRemovedBundles
RequestListERC20MultiSigSignerRemovedBundlesRequest
ResponseListERC20MultiSigSignerRemovedBundlesResponse
DescriptionList ERC20 multi-sig signer removed bundles Get a list of the signature bundles to remove a particular validator from signer list of the multisig contract

GetERC20ListAssetBundle

MethodGetERC20ListAssetBundle
RequestGetERC20ListAssetBundleRequest
ResponseGetERC20ListAssetBundleResponse
DescriptionGet ERC20 list asset bundle Get the signatures bundle to allowlist an ERC20 token in the collateral bridge

GetERC20SetAssetLimitsBundle

MethodGetERC20SetAssetLimitsBundle
RequestGetERC20SetAssetLimitsBundleRequest
ResponseGetERC20SetAssetLimitsBundleResponse
DescriptionGet ERC20 set asset limits bundle Get the signature bundle to update the token limits. These are `maxLifetimeDeposit` and `withdrawThreshold` for a given ERC20 token that is already allowlisted in the collateral bridge.

GetERC20WithdrawalApproval

MethodGetERC20WithdrawalApproval
RequestGetERC20WithdrawalApprovalRequest
ResponseGetERC20WithdrawalApprovalResponse
DescriptionGet ERC20 withdrawal approval Get the signature bundle to finalise a withdrawal on Ethereum

GetLastTrade

MethodGetLastTrade
RequestGetLastTradeRequest
ResponseGetLastTradeResponse
DescriptionGet last trade Get the last trade made for a given market.

ListTrades

MethodListTrades
RequestListTradesRequest
ResponseListTradesResponse
DescriptionList trades Get a list of all trades, optionally filtered by party/market/order

ObserveTrades

MethodObserveTrades
RequestObserveTradesRequest
ResponseObserveTradesResponse stream
DescriptionObserve trades Subscribe to a stream of trades, optionally filtered by party/market

GetOracleSpec

MethodGetOracleSpec
RequestGetOracleSpecRequest
ResponseGetOracleSpecResponse
DescriptionGet oracle spec Get an oracle spec by ID. Oracle spec IDs can be found by querying markets that use them as a data source

ListOracleSpecs

MethodListOracleSpecs
RequestListOracleSpecsRequest
ResponseListOracleSpecsResponse
DescriptionList oracle specs Get a list of all oracles specs that are defined against all markets

ListOracleData

MethodListOracleData
RequestListOracleDataRequest
ResponseListOracleDataResponse
DescriptionList oracle data Get a list of all oracle data that have been broadcast to any market

GetMarket

MethodGetMarket
RequestGetMarketRequest
ResponseGetMarketResponse
DescriptionGet market Get information about a specific market using its ID. A market's ID will be the same as the ID of the proposal that generated it

ListMarkets

MethodListMarkets
RequestListMarketsRequest
ResponseListMarketsResponse
DescriptionList markets Get a list of markets

ListSuccessorMarkets

MethodListSuccessorMarkets
RequestListSuccessorMarketsRequest
ResponseListSuccessorMarketsResponse
DescriptionList successor markets Given a market ID, return the full lineage of markets since inception, or all successor markets since and including the given market ID. The markets will be returned in succession order, i.e. the market at position i will be the parent of the market at position i+1.

GetParty

MethodGetParty
RequestGetPartyRequest
ResponseGetPartyResponse
DescriptionGet party Get a single party

ListParties

MethodListParties
RequestListPartiesRequest
ResponseListPartiesResponse
DescriptionList parties Get a list of parties

ListPartiesProfiles

MethodListPartiesProfiles
RequestListPartiesProfilesRequest
ResponseListPartiesProfilesResponse
DescriptionList parties' profiles Get a list of profiles for multiple parties

ListMarginLevels

MethodListMarginLevels
RequestListMarginLevelsRequest
ResponseListMarginLevelsResponse
DescriptionList margin levels Get a list margin levels that match the provided criteria. If no filter is provided, all margin levels will be returned.

ObserveMarginLevels

MethodObserveMarginLevels
RequestObserveMarginLevelsRequest
ResponseObserveMarginLevelsResponse stream
DescriptionObserve margin levels Subscribe to a stream of margin levels updates

ListRewards

MethodListRewards
RequestListRewardsRequest
ResponseListRewardsResponse
DescriptionList rewards Get a list of rewards that match the provided criteria. If no filter is provided, all rewards will be returned.

ListRewardSummaries

MethodListRewardSummaries
RequestListRewardSummariesRequest
ResponseListRewardSummariesResponse
DescriptionList reward summaries Get a list of reward summaries where the reward amount is the total rewards received over all epochs per party ID and asset ID. Request parameters are optional party ID and asset ID. If no data is provided, all reward summaries will be returned grouped by party and asset ID.

ListEpochRewardSummaries

MethodListEpochRewardSummaries
RequestListEpochRewardSummariesRequest
ResponseListEpochRewardSummariesResponse
DescriptionList epoch reward summaries Get a list of reward summaries by epoch for a given range of epochs. The result is filtered by list of asset IDs, market IDs and starting and ending epochs, for which to return rewards. If no data is provided, all reward summaries will be returned, grouped by epochs, market IDs, asset IDs and reward type.

GetDeposit

MethodGetDeposit
RequestGetDepositRequest
ResponseGetDepositResponse
DescriptionGet deposit Get a deposit by its ID

ListDeposits

MethodListDeposits
RequestListDepositsRequest
ResponseListDepositsResponse
DescriptionList deposits Get a list of deposits for a given party. If a date range is provided, filtering will be based on the last time the deposit has been updated in Vega time.

GetWithdrawal

MethodGetWithdrawal
RequestGetWithdrawalRequest
ResponseGetWithdrawalResponse
DescriptionGet withdrawal Get a withdrawal by its ID. A withdrawal's ID will be the SHA3-256 hash of the signature that the withdrawal was submitted with

ListWithdrawals

MethodListWithdrawals
RequestListWithdrawalsRequest
ResponseListWithdrawalsResponse
DescriptionList withdrawals Get a list of withdrawals for a given party

GetAsset

MethodGetAsset
RequestGetAssetRequest
ResponseGetAssetResponse
DescriptionGet asset Get a single asset using its ID. Use the assets list query to get an asset's ID

ListAssets

MethodListAssets
RequestListAssetsRequest
ResponseListAssetsResponse
DescriptionList assets Get a list of assets available on the Vega network

ListLiquidityProvisions

MethodListLiquidityProvisions
RequestListLiquidityProvisionsRequest
ResponseListLiquidityProvisionsResponse
DescriptionList liquidity provisions DEPRECATED: When a liquidity provider amends a provision, and it's accepted by the network, the pending provision is returned by the API instead of the provision that is currently active. Use ListAllLiquidityProvisions instead.

ListAllLiquidityProvisions

MethodListAllLiquidityProvisions
RequestListAllLiquidityProvisionsRequest
ResponseListAllLiquidityProvisionsResponse
DescriptionList liquidity provisions Get a list of liquidity provisions for a given market. This API returns a current and pending liquidity provision in the event that a provision has been updated by the provider but the updated provision will not be active until the next epoch.

ObserveLiquidityProvisions

MethodObserveLiquidityProvisions
RequestObserveLiquidityProvisionsRequest
ResponseObserveLiquidityProvisionsResponse stream
DescriptionObserve liquidity provisions Subscribe to a stream of liquidity provision events for a given market and party

ListLiquidityProviders

MethodListLiquidityProviders
RequestListLiquidityProvidersRequest
ResponseListLiquidityProvidersResponse
DescriptionList liquidity providers data List information about active liquidity provider(s) for a given market, or liquidity provider's party ID.

ListPaidLiquidityFees

MethodListPaidLiquidityFees
RequestListPaidLiquidityFeesRequest
ResponseListPaidLiquidityFeesResponse
DescriptionList paid liquidity fees data List information about paid liquidity fees for a given market, or asset ID.

GetGovernanceData

MethodGetGovernanceData
RequestGetGovernanceDataRequest
ResponseGetGovernanceDataResponse
DescriptionGet governance data Get a single proposal's details either by proposal ID or by reference

ListGovernanceData

MethodListGovernanceData
RequestListGovernanceDataRequest
ResponseListGovernanceDataResponse
DescriptionList governance data Get a list of proposals

ObserveGovernance

MethodObserveGovernance
RequestObserveGovernanceRequest
ResponseObserveGovernanceResponse stream
DescriptionObserve governance Subscribe to a stream of updates to governance proposals

ListDelegations

MethodListDelegations
RequestListDelegationsRequest
ResponseListDelegationsResponse
DescriptionList delegations Get a list of the token delegations on the network

GetNetworkData

MethodGetNetworkData
RequestGetNetworkDataRequest
ResponseGetNetworkDataResponse
DescriptionGet network data Get data regarding the nodes of the network

GetNode

MethodGetNode
RequestGetNodeRequest
ResponseGetNodeResponse
DescriptionGet node Get information about a given node

ListNodes

MethodListNodes
RequestListNodesRequest
ResponseListNodesResponse
DescriptionList nodes Get a list of the nodes on the network along with the related information.

ListNodeSignatures

MethodListNodeSignatures
RequestListNodeSignaturesRequest
ResponseListNodeSignaturesResponse
DescriptionList node signatures Get a list of aggregate signatures from all the nodes of the network

GetEpoch

MethodGetEpoch
RequestGetEpochRequest
ResponseGetEpochResponse
DescriptionGet epoch Get data for a specific epoch, if ID is omitted, it retrieves the current epoch

EstimateFee

MethodEstimateFee
RequestEstimateFeeRequest
ResponseEstimateFeeResponse
DescriptionEstimate fee Estimate the fee that would be incurred for submitting an order with the specified price and size on the market.

EstimateMargin

MethodEstimateMargin
RequestEstimateMarginRequest
ResponseEstimateMarginResponse
DescriptionEstimate margin Estimate the margin that would be required for submitting this order

EstimatePosition

MethodEstimatePosition
RequestEstimatePositionRequest
ResponseEstimatePositionResponse
DescriptionEstimate position Estimate the margin that would be required for maintaining the specified position, collateral increase needed to open the specified position and the liquidation price estimate. Margin estimates are scaled to asset decimal places. Liquidation price estimates are scaled to asset decimal places by default, unless an argument to scale to market decimal places is specified in the request.

ListNetworkParameters

MethodListNetworkParameters
RequestListNetworkParametersRequest
ResponseListNetworkParametersResponse
DescriptionList network parameters Get a list of the network parameter keys and their values

GetNetworkParameter

MethodGetNetworkParameter
RequestGetNetworkParameterRequest
ResponseGetNetworkParameterResponse
DescriptionGet network parameter Get a network parameter's value by its key

ListCheckpoints

MethodListCheckpoints
RequestListCheckpointsRequest
ResponseListCheckpointsResponse
DescriptionList checkpoints Get a list of information about checkpoints generated by the network

GetStake

MethodGetStake
RequestGetStakeRequest
ResponseGetStakeResponse
DescriptionGet stake Get staking information for a given party

GetRiskFactors

MethodGetRiskFactors
RequestGetRiskFactorsRequest
ResponseGetRiskFactorsResponse
DescriptionGet risk factors Get risk factor data for a given market

ObserveEventBus

MethodObserveEventBus
RequestObserveEventBusRequest stream
ResponseObserveEventBusResponse stream
DescriptionObserve event bus Subscribe to a stream of events from the core

ObserveLedgerMovements

MethodObserveLedgerMovements
RequestObserveLedgerMovementsRequest
ResponseObserveLedgerMovementsResponse stream
DescriptionObserve ledger movements Subscribe to a stream of transfer responses

ListKeyRotations

MethodListKeyRotations
RequestListKeyRotationsRequest
ResponseListKeyRotationsResponse
DescriptionList key rotations Get a list of information about Vega key rotations that have been performed by validator nodes

ListEthereumKeyRotations

MethodListEthereumKeyRotations
RequestListEthereumKeyRotationsRequest
ResponseListEthereumKeyRotationsResponse
DescriptionList Ethereum key rotations Get a list of information about Ethereum key rotations that have been performed by validator nodes

GetVegaTime

MethodGetVegaTime
RequestGetVegaTimeRequest
ResponseGetVegaTimeResponse
DescriptionGet Vega time Get the current time of the network in Unix nanoseconds

GetProtocolUpgradeStatus

MethodGetProtocolUpgradeStatus
RequestGetProtocolUpgradeStatusRequest
ResponseGetProtocolUpgradeStatusResponse
DescriptionGet protocol upgrade status Get status of a protocol upgrade

ListProtocolUpgradeProposals

MethodListProtocolUpgradeProposals
RequestListProtocolUpgradeProposalsRequest
ResponseListProtocolUpgradeProposalsResponse
DescriptionList protocol upgrade proposals Get a list of protocol upgrade proposals, optionally filtering on status or approver.

ListCoreSnapshots

MethodListCoreSnapshots
RequestListCoreSnapshotsRequest
ResponseListCoreSnapshotsResponse
DescriptionList snapshots Get a list of core snapshots taken

GetMostRecentNetworkHistorySegment

MethodGetMostRecentNetworkHistorySegment
RequestGetMostRecentNetworkHistorySegmentRequest
ResponseGetMostRecentNetworkHistorySegmentResponse
DescriptionGet most recent network history segment Get the network's most recently history segment

ListAllNetworkHistorySegments

MethodListAllNetworkHistorySegments
RequestListAllNetworkHistorySegmentsRequest
ResponseListAllNetworkHistorySegmentsResponse
DescriptionList all network history segments Get a list of all history segments stored by the data node currently connected to

GetActiveNetworkHistoryPeerAddresses

MethodGetActiveNetworkHistoryPeerAddresses
RequestGetActiveNetworkHistoryPeerAddressesRequest
ResponseGetActiveNetworkHistoryPeerAddressesResponse
DescriptionGet active network history peer addresses Get a list of the addresses of all active network history peers

GetNetworkHistoryStatus

MethodGetNetworkHistoryStatus
RequestGetNetworkHistoryStatusRequest
ResponseGetNetworkHistoryStatusResponse
DescriptionNetwork history status Get information about the current state of network history's IPFS swarm

GetNetworkHistoryBootstrapPeers

MethodGetNetworkHistoryBootstrapPeers
RequestGetNetworkHistoryBootstrapPeersRequest
ResponseGetNetworkHistoryBootstrapPeersResponse
DescriptionNetwork history bootstrap peers Get a list of IPFS peers that can be used to initialise a new data node with network history

ListEntities

MethodListEntities
RequestListEntitiesRequest
ResponseListEntitiesResponse
DescriptionList entities Get a list of all entities created by transaction hash

ListFundingPeriods

MethodListFundingPeriods
RequestListFundingPeriodsRequest
ResponseListFundingPeriodsResponse
DescriptionList funding periods Get a list of funding periods for a perpetual market.

ListFundingPeriodDataPoints

MethodListFundingPeriodDataPoints
RequestListFundingPeriodDataPointsRequest
ResponseListFundingPeriodDataPointsResponse
DescriptionList funding period data points Get a list of data points for a perpetual market's funding periods.

ListFundingPayments

MethodListFundingPayments
RequestListFundingPaymentsRequest
ResponseListFundingPaymentsResponse
DescriptionList funding payments Get a list of funding payment gains and losses for a party as a result of their position on a perpetual market when a funding period ends.

GetPartyActivityStreak

MethodGetPartyActivityStreak
RequestGetPartyActivityStreakRequest
ResponseGetPartyActivityStreakResponse
DescriptionList party activity streak Get a party's activity across epochs.

GetCurrentReferralProgram

MethodGetCurrentReferralProgram
RequestGetCurrentReferralProgramRequest
ResponseGetCurrentReferralProgramResponse
DescriptionGet current referral program Get the current referral program for the network. This program may not be active if it has ended and has not been replaced by another.

ListReferralSets

MethodListReferralSets
RequestListReferralSetsRequest
ResponseListReferralSetsResponse
DescriptionList referral sets List all referral sets, or a specific referral set if you know its ID.

ListReferralSetReferees

MethodListReferralSetReferees
RequestListReferralSetRefereesRequest
ResponseListReferralSetRefereesResponse
DescriptionList referral set referees List all referees that belong to a referral set.

GetReferralSetStats

MethodGetReferralSetStats
RequestGetReferralSetStatsRequest
ResponseGetReferralSetStatsResponse
DescriptionGet referral set statistics Get the total taker volume, and each referee's taker volume and, reward and discount factors for a referral set at the latest or a specific epoch. You can also optionally filter for a specific referee's statistics.

ListTeams

MethodListTeams
RequestListTeamsRequest
ResponseListTeamsResponse
DescriptionList teams Get a list of all teams, or for a specific team by using team ID, or party ID of a referrer or referee

ListTeamsStatistics

MethodListTeamsStatistics
RequestListTeamsStatisticsRequest
ResponseListTeamsStatisticsResponse
DescriptionList teams statistics Get the statistics of all teams, or for a specific team by using team ID, over a number of epochs. If a team does not have at least the number of epochs' worth of data, it is ignored.

ListTeamMembersStatistics

MethodListTeamMembersStatistics
RequestListTeamMembersStatisticsRequest
ResponseListTeamMembersStatisticsResponse
DescriptionList team members' statistics Get the statistics for all members of a given team, or for a specific member by using party ID, over a number of epochs. If a team does not have at least the number of epochs' worth of data, it is ignored.

ListTeamReferees

MethodListTeamReferees
RequestListTeamRefereesRequest
ResponseListTeamRefereesResponse
DescriptionList team referees Get a list of all referees for a given team ID

ListTeamRefereeHistory

MethodListTeamRefereeHistory
RequestListTeamRefereeHistoryRequest
ResponseListTeamRefereeHistoryResponse
DescriptionList referee team history Get a list of a referee's team history, i.e. the teams that a referee has been a member of and transferred from/to.

GetFeesStats

MethodGetFeesStats
RequestGetFeesStatsRequest
ResponseGetFeesStatsResponse
DescriptionGet fees statistics Get accumulated fees, rewards, and applied discount information. Either a market or an asset must be supplied as filter.

GetFeesStatsForParty

MethodGetFeesStatsForParty
RequestGetFeesStatsForPartyRequest
ResponseGetFeesStatsForPartyResponse
DescriptionGet fees statistics for a party Get accumulated fees, rewards, and applied discount information. A party ID must be supplied as filter.

GetCurrentVolumeDiscountProgram

MethodGetCurrentVolumeDiscountProgram
RequestGetCurrentVolumeDiscountProgramRequest
ResponseGetCurrentVolumeDiscountProgramResponse
DescriptionGet current volume discount program Get the current volume discount program for the network. This program may not be active if it has ended and has not been replaced by another.

GetVolumeDiscountStats

MethodGetVolumeDiscountStats
RequestGetVolumeDiscountStatsRequest
ResponseGetVolumeDiscountStatsResponse
DescriptionGet volume discount statistics Get the information about a party's running traded volume, and the discount factor it earns them.

GetVestingBalancesSummary

MethodGetVestingBalancesSummary
RequestGetVestingBalancesSummaryRequest
ResponseGetVestingBalancesSummaryResponse
DescriptionGet vesting balances summary Get information about a party's vesting and locked balances

GetPartyVestingStats

MethodGetPartyVestingStats
RequestGetPartyVestingStatsRequest
ResponseGetPartyVestingStatsResponse
DescriptionGet vesting balance statistics Get information about a party's vesting rewards

ObserveTransactionResults

MethodObserveTransactionResults
RequestObserveTransactionResultsRequest
ResponseObserveTransactionResultsResponse stream
DescriptionObserve transaction results Subscribe to a stream of transaction results, optionally filtered by party/hash/status

EstimateTransferFee

MethodEstimateTransferFee
RequestEstimateTransferFeeRequest
ResponseEstimateTransferFeeResponse
DescriptionEstimate transfer fee costs Estimate transfer fee costs with potential discount applied

GetTotalTransferFeeDiscount

MethodGetTotalTransferFeeDiscount
RequestGetTotalTransferFeeDiscountRequest
ResponseGetTotalTransferFeeDiscountResponse
DescriptionAvailable transfer fee discount Returns available per party per asset transfer discount

ListGames

MethodListGames
RequestListGamesRequest
ResponseListGamesResponse
DescriptionList games Get a list of games and corresponding game data, given the provided filters

ListPartyMarginModes

MethodListPartyMarginModes
RequestListPartyMarginModesRequest
ResponseListPartyMarginModesResponse
DescriptionList margin modes per party per market Get a list of all margin modes, or for a specific market ID, or party ID.

ExportNetworkHistory

MethodExportNetworkHistory
RequestExportNetworkHistoryRequest
ResponseHttpBody stream
DescriptionExport network history as CSV Export CSV table data from network history between two block heights. The requested block heights must fall on network history segment boundaries, which can be discovered by calling the API to list all network history segments. By default segments contain 1000 blocks. In that case ranges such as (1, 1000), (1001, 2000), (1, 3000) would all fall on segment boundaries and be valid. The generated CSV file is compressed into a ZIP file and returned, with the file name in the following format: `[chain id]-[table name]-[start block]-[end block].zip` In gRPC, results are returned in a chunked stream of base64 encoded data. Through the REST gateway, the base64 data chunks are decoded and streamed as a `content-type: application/zip` HTTP response. The CSV exported data uses a comma as a DELIMITER between fields, and " for QUOTE-ing fields. If a value contains any of: DELIMITER, QUOTE, carriage return, or line feed then the whole value is prefixed and suffixed by the QUOTE character and any occurrence within the value of a QUOTE character preceded by another QUOTE. A NULL is output as the NULL parameter string and is not quoted, while a non-NULL value matching the NULL parameter string is quoted. For example, with the default settings, a NULL is written as an unquoted empty string, while an empty string data value is written with double quotes. Note that CSV files produced may contain quoted values containing embedded carriage returns and line feeds. Thus the files are not strictly one line per table row like text-format files. The first row of the CSV file is a header that describes the contents of each column in subsequent rows. Usually the ZIP file will contain only a single CSV file. However it is possible that the (from_block, to_block) request spans over a range of blocks in which the underlying schema of the database changes. For example, a column may have been added, removed, or renamed. If this happens, the CSV file will be split at the point of the schema change and the zip file will contain multiple CSV files, with a potentially different set of headers. The 'version' number of the database schema is part of the in the CSV filename: `[chain id]-[table name]-[schema version]-[start block]-[end block].zip` For example, a zip file might be called mainnet-sometable-000001-003000.zip And contain two CSV files: `mainnet-sometable-1-000001-002000.csv`: timestamp, value 1, foo 2, bar And `mainnet-sometable-2-002001-003000.csv`: timestamp, value, extra_value 3, baz, apple It is worth noting that the schema will not change within a single network history segment. buf:lint:ignore RPC_RESPONSE_STANDARD_NAME buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE

Ping

MethodPing
RequestPingRequest
ResponsePingResponse
DescriptionPing Ping the data node