Events subscription

Subscribe to a stream of events from the core

Query Parameters

type string[]
Possible values: [BUS_EVENT_TYPE_UNSPECIFIED, BUS_EVENT_TYPE_ALL, BUS_EVENT_TYPE_TIME_UPDATE, BUS_EVENT_TYPE_LEDGER_MOVEMENTS, BUS_EVENT_TYPE_POSITION_RESOLUTION, BUS_EVENT_TYPE_ORDER, BUS_EVENT_TYPE_ACCOUNT, BUS_EVENT_TYPE_PARTY, BUS_EVENT_TYPE_TRADE, BUS_EVENT_TYPE_MARGIN_LEVELS, BUS_EVENT_TYPE_PROPOSAL, BUS_EVENT_TYPE_VOTE, BUS_EVENT_TYPE_MARKET_DATA, BUS_EVENT_TYPE_NODE_SIGNATURE, BUS_EVENT_TYPE_LOSS_SOCIALIZATION, BUS_EVENT_TYPE_SETTLE_POSITION, BUS_EVENT_TYPE_SETTLE_DISTRESSED, BUS_EVENT_TYPE_MARKET_CREATED, BUS_EVENT_TYPE_ASSET, BUS_EVENT_TYPE_MARKET_TICK, BUS_EVENT_TYPE_WITHDRAWAL, BUS_EVENT_TYPE_DEPOSIT, BUS_EVENT_TYPE_AUCTION, BUS_EVENT_TYPE_RISK_FACTOR, BUS_EVENT_TYPE_NETWORK_PARAMETER, BUS_EVENT_TYPE_LIQUIDITY_PROVISION, BUS_EVENT_TYPE_MARKET_UPDATED, BUS_EVENT_TYPE_ORACLE_SPEC, BUS_EVENT_TYPE_ORACLE_DATA, BUS_EVENT_TYPE_DELEGATION_BALANCE, BUS_EVENT_TYPE_VALIDATOR_SCORE, BUS_EVENT_TYPE_EPOCH_UPDATE, BUS_EVENT_TYPE_VALIDATOR_UPDATE, BUS_EVENT_TYPE_STAKE_LINKING, BUS_EVENT_TYPE_REWARD_PAYOUT_EVENT, BUS_EVENT_TYPE_CHECKPOINT, BUS_EVENT_TYPE_STREAM_START, BUS_EVENT_TYPE_KEY_ROTATION, BUS_EVENT_TYPE_STATE_VAR, BUS_EVENT_TYPE_NETWORK_LIMITS, BUS_EVENT_TYPE_TRANSFER, BUS_EVENT_TYPE_VALIDATOR_RANKING, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_EVENT, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SET_THRESHOLD, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_ADDED, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_REMOVED, BUS_EVENT_TYPE_POSITION_STATE, BUS_EVENT_TYPE_ETHEREUM_KEY_ROTATION, BUS_EVENT_TYPE_PROTOCOL_UPGRADE_PROPOSAL, BUS_EVENT_TYPE_BEGIN_BLOCK, BUS_EVENT_TYPE_END_BLOCK, BUS_EVENT_TYPE_PROTOCOL_UPGRADE_STARTED, BUS_EVENT_TYPE_SETTLE_MARKET, BUS_EVENT_TYPE_TRANSACTION_RESULT, BUS_EVENT_TYPE_SNAPSHOT_TAKEN, BUS_EVENT_TYPE_PROTOCOL_UPGRADE_DATA_NODE_READY, BUS_EVENT_TYPE_DISTRESSED_ORDERS_CLOSED, BUS_EVENT_TYPE_EXPIRED_ORDERS, BUS_EVENT_TYPE_DISTRESSED_POSITIONS, BUS_EVENT_TYPE_SPOT_LIQUIDITY_PROVISION, BUS_EVENT_TYPE_STOP_ORDER, BUS_EVENT_TYPE_MARKET, BUS_EVENT_TYPE_TX_ERROR]
One or more types of event, required field.
• BUS_EVENT_TYPE_UNSPECIFIED: Default value, always invalid
• BUS_EVENT_TYPE_ALL: Events of ALL event types, used when filtering stream from event bus
• BUS_EVENT_TYPE_TIME_UPDATE: Event for blockchain time updates
• BUS_EVENT_TYPE_LEDGER_MOVEMENTS: Event for when a transfer happens internally, contains the transfer information
• BUS_EVENT_TYPE_POSITION_RESOLUTION: Event indicating position resolution has occurred
• BUS_EVENT_TYPE_ORDER: Event for order updates, both new and existing orders
• BUS_EVENT_TYPE_ACCOUNT: Event for account updates
• BUS_EVENT_TYPE_PARTY: Event for party updates
• BUS_EVENT_TYPE_TRADE: Event indicating a new trade has occurred
• BUS_EVENT_TYPE_MARGIN_LEVELS: Event indicating margin levels have changed for a party
• BUS_EVENT_TYPE_PROPOSAL: Event for proposal updates (for governance)
• BUS_EVENT_TYPE_VOTE: Event indicating a new vote has occurred (for governance)
• BUS_EVENT_TYPE_MARKET_DATA: Event for market data updates
• BUS_EVENT_TYPE_NODE_SIGNATURE: Event for a new signature for a Vega node
• BUS_EVENT_TYPE_LOSS_SOCIALIZATION: Event indicating loss socialisation occurred for a party
• BUS_EVENT_TYPE_SETTLE_POSITION: Event for when a position is being settled
• BUS_EVENT_TYPE_SETTLE_DISTRESSED: Event for when a position is distressed
• BUS_EVENT_TYPE_MARKET_CREATED: Event indicating a new market was created
• BUS_EVENT_TYPE_ASSET: Event for when an asset is added to Vega
• BUS_EVENT_TYPE_MARKET_TICK: Event indicating a market tick event
• BUS_EVENT_TYPE_WITHDRAWAL: Event for when a withdrawal occurs
• BUS_EVENT_TYPE_DEPOSIT: Event for when a deposit occurs
• BUS_EVENT_TYPE_AUCTION: Event indicating a change in auction state, for example starting or ending an auction
• BUS_EVENT_TYPE_RISK_FACTOR: Event indicating a risk factor has been updated
• BUS_EVENT_TYPE_NETWORK_PARAMETER: Event indicating a network parameter has been added or updated
• BUS_EVENT_TYPE_LIQUIDITY_PROVISION: Event indicating a liquidity provision has been created or updated
• BUS_EVENT_TYPE_MARKET_UPDATED: Event indicating a new market was created
• BUS_EVENT_TYPE_ORACLE_SPEC: Event indicating an oracle spec has been created or updated
• BUS_EVENT_TYPE_ORACLE_DATA: Event indicating that an oracle data has been broadcast
• BUS_EVENT_TYPE_DELEGATION_BALANCE: Event indicating that an delegation balance of a party to a node for current epoch has changed
• BUS_EVENT_TYPE_VALIDATOR_SCORE: Event indicating the validator score for the given epoch
• BUS_EVENT_TYPE_EPOCH_UPDATE: Event indicating the start or end of an epoch
• BUS_EVENT_TYPE_VALIDATOR_UPDATE: Event indicating that validator node has been updated
• BUS_EVENT_TYPE_STAKE_LINKING: Event indicating a new staking event have been processed by the network
• BUS_EVENT_TYPE_REWARD_PAYOUT_EVENT: Event indicating the payout of a reward has been initiated
• BUS_EVENT_TYPE_CHECKPOINT: Event indicating a new checkpoint was created
• BUS_EVENT_TYPE_STREAM_START: Event indicating stream is starting
• BUS_EVENT_TYPE_KEY_ROTATION: Event indicating key rotation took place
• BUS_EVENT_TYPE_STATE_VAR: Event indicating state transitions in state variable consensus
• BUS_EVENT_TYPE_NETWORK_LIMITS: Event indicating network limits set or updated
• BUS_EVENT_TYPE_TRANSFER: Event indicating a update for a transfer
• BUS_EVENT_TYPE_VALIDATOR_RANKING: Event indicating the ranking of validator and their status in Vega
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_EVENT: Event indicating a new multi sig signer event have been processed
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SET_THRESHOLD: Event indicating the erc20 multi sig threshold have been updated
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_ADDED: Event indicating a new signer has been added to the ERC-20 multisig
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_REMOVED: Event indicating a signer has been removed from the ERC-20 multisig
• BUS_EVENT_TYPE_POSITION_STATE: Event indicating that a party's position has changed
• BUS_EVENT_TYPE_ETHEREUM_KEY_ROTATION: Event indicating Ethereum key rotation took place
• BUS_EVENT_TYPE_PROTOCOL_UPGRADE_PROPOSAL: Event indicating protocol upgrade proposal updates
• BUS_EVENT_TYPE_BEGIN_BLOCK: Event indicating the core is starting to process a new block
• BUS_EVENT_TYPE_END_BLOCK: Event indicating the core finished to process a block
• BUS_EVENT_TYPE_PROTOCOL_UPGRADE_STARTED: Event indicating the core is starting a protocol upgrade
• BUS_EVENT_TYPE_SETTLE_MARKET: Event indicating the market has stopped and settled
• BUS_EVENT_TYPE_TRANSACTION_RESULT: Event indicating the result of a transaction processed by the network
• BUS_EVENT_TYPE_SNAPSHOT_TAKEN: Event indicating a snapshot was taken at this block height
• BUS_EVENT_TYPE_PROTOCOL_UPGRADE_DATA_NODE_READY: Event data node uses to notify that it is ready to upgrade
• BUS_EVENT_TYPE_DISTRESSED_ORDERS_CLOSED: Event indicating parties had orders closed because they were distressed, but were not closed out.
• BUS_EVENT_TYPE_EXPIRED_ORDERS: Event indicating parties had orders closed because they were distressed, but were not closed out.
• BUS_EVENT_TYPE_DISTRESSED_POSITIONS: Event indicating parties have become, or were, distressed but still have an active position.
• BUS_EVENT_TYPE_SPOT_LIQUIDITY_PROVISION: Event indicating a spot liquidity provision has been created or updated.
• BUS_EVENT_TYPE_STOP_ORDER: Event indicating a stop order has been submitted or updated.
• BUS_EVENT_TYPE_MARKET: Event indicating a market related event, for example when a market opens
• BUS_EVENT_TYPE_TX_ERROR: Event used to report failed transactions back to a user, this is excluded from the ALL type
marketId string

Market ID to filter events for, optional field. If omitted, no markets will be filtered out.

partyId string

Party ID to filter events for, optional field. If omitted, no parties will be filtered out.

batchSize int64

Batch size, optional field - 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.

Responses

• 200
• default

---

A successful response.(streaming responses)

application/json

Schema

Example (from schema)

---

Schema

error object
code int32
details object[]
Array [
@type string
]
message string
result object
events object[]
One or more events that match the subscription request criteria.
Array [
account object
asset string
Asset ID for the account.
balance string
Balance of the asset, the balance is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places and importantly balances cannot be negative.
id string
Unique account ID, used internally by Vega.
marketId string
Market ID for the account, if AccountType.ACCOUNT_TYPE_GENERAL this will be empty.
owner string
Party that the account belongs to, special values include network, which represents the Vega network and is most commonly seen during liquidation of distressed trading positions.
type Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type related to this account.
asset object
details object
Definition of the external source for this asset.
builtinAsset object
Vega built-in asset.
maxFaucetAmountMint string
Maximum amount that can be requested by a party through the built-in asset faucet at a time.
decimals uint64
Number of decimal / precision handled by this asset.
erc20 object
Ethereum ERC20 asset.
contractAddress string
Address of the contract for the token, on the ethereum network.
lifetimeLimit string
Lifetime limits deposit per address note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
name string
Name of the asset (e.g: Great British Pound).
quantum string
Minimum economically meaningful amount in the asset.
symbol string
Symbol of the asset (e.g: GBP).
id string
Internal identifier of the asset.
status - STATUS_UNSPECIFIED: Default value, always invalid - STATUS_PROPOSED: Asset is proposed and under vote - STATUS_REJECTED: Asset has been rejected from governance - STATUS_PENDING_LISTING: Asset is pending listing from the bridge - STATUS_ENABLED: Asset is fully usable in the network
Possible values: [STATUS_UNSPECIFIED, STATUS_PROPOSED, STATUS_REJECTED, STATUS_PENDING_LISTING, STATUS_ENABLED]
Default value: STATUS_UNSPECIFIED
Status of the asset.
auction object
end int64
extensionTrigger If an auction was ongoing, but was extended for whatever reason, this field will be set to the trigger type indicating which component extended the auction
Possible values: [AUCTION_TRIGGER_UNSPECIFIED, AUCTION_TRIGGER_BATCH, AUCTION_TRIGGER_OPENING, AUCTION_TRIGGER_PRICE, AUCTION_TRIGGER_LIQUIDITY, AUCTION_TRIGGER_LIQUIDITY_TARGET_NOT_MET, AUCTION_TRIGGER_UNABLE_TO_DEPLOY_LP_ORDERS]
Default value: AUCTION_TRIGGER_UNSPECIFIED
• AUCTION_TRIGGER_UNSPECIFIED: Default value for AuctionTrigger, no auction triggered
• AUCTION_TRIGGER_BATCH: Batch auction
• AUCTION_TRIGGER_OPENING: Opening auction
• AUCTION_TRIGGER_PRICE: Price monitoring trigger
• AUCTION_TRIGGER_LIQUIDITY: Deprecated
• AUCTION_TRIGGER_LIQUIDITY_TARGET_NOT_MET: Liquidity auction due to not enough committed liquidity
• AUCTION_TRIGGER_UNABLE_TO_DEPLOY_LP_ORDERS: Liquidity auction due to not being able to deploy LP orders because there's nothing to peg on one or both sides of the book
leave True if the event indicates leaving auction mode and False otherwise
marketId Market ID for the event
openingAuction True if the event indicates an auction opening and False otherwise
start int64
trigger Reason this market is/was in auction
Possible values: [AUCTION_TRIGGER_UNSPECIFIED, AUCTION_TRIGGER_BATCH, AUCTION_TRIGGER_OPENING, AUCTION_TRIGGER_PRICE, AUCTION_TRIGGER_LIQUIDITY, AUCTION_TRIGGER_LIQUIDITY_TARGET_NOT_MET, AUCTION_TRIGGER_UNABLE_TO_DEPLOY_LP_ORDERS]
Default value: AUCTION_TRIGGER_UNSPECIFIED
• AUCTION_TRIGGER_UNSPECIFIED: Default value for AuctionTrigger, no auction triggered
• AUCTION_TRIGGER_BATCH: Batch auction
• AUCTION_TRIGGER_OPENING: Opening auction
• AUCTION_TRIGGER_PRICE: Price monitoring trigger
• AUCTION_TRIGGER_LIQUIDITY: Deprecated
• AUCTION_TRIGGER_LIQUIDITY_TARGET_NOT_MET: Liquidity auction due to not enough committed liquidity
• AUCTION_TRIGGER_UNABLE_TO_DEPLOY_LP_ORDERS: Liquidity auction due to not being able to deploy LP orders because there's nothing to peg on one or both sides of the book
beginBlock object
hash string
height uint64
timestamp int64
block The batch or block of transactions that the events relate to
chainId string
checkpoint object
blockHash string
blockHeight uint64
hash string
coreSnapshotEvent object
CoreSnapshotData represents the core snapshot data.
blockHash Hash of the snapshot block
blockHeight uint64
coreVersion string
Semver version number of the core.
protocolUpgradeBlock Indicates if the snapshot is taken as part of protocol upgrade
delegationBalance object
amount string
epochSeq string
nodeId string
party string
deposit object
amount string
Amount to be deposited. This field is an unsigned integer scaled to the asset's decimal places.
asset string
Vega asset targeted by this deposit.
createdTimestamp int64
Timestamp for when the deposit was created on the Vega network.
creditedTimestamp int64
Timestamp for when the Vega account was updated with the deposit.
id string
Unique ID for the deposit.
partyId string
Party ID of the user initiating the deposit.
status Status of the deposit
Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_CANCELLED, STATUS_FINALIZED]
Default value: STATUS_UNSPECIFIED
Status of the deposit.
txHash string
Hash of the transaction from the foreign chain.
distressedOrders object
marketId Market ID for the event
parties string[]
distressedPositions object
Distressed positions event contains the party IDs for all parties that were distressed, had their orders closed but because of insufficient volume on the book could not be fully closed out. These parties are distressed, but still hold an active position on the book as a result. Once enough volume is on the book to close them out, a SettleDistressed event will be sent. In case they manage to reduce their position, or meet the margin requirements, this status will be updated. Parties that are no longer distressed but active will be listed in the safe_parties field.
distressedParties string[]
marketId Market ID for the event
safeParties string[]
endBlock object
height uint64
epochEvent object
action Action tells us what action is taking place
Possible values: [EPOCH_ACTION_UNSPECIFIED, EPOCH_ACTION_START, EPOCH_ACTION_END]
Default value: EPOCH_ACTION_UNSPECIFIED
• EPOCH_ACTION_START: Epoch update is for a new epoch.
• EPOCH_ACTION_END: Epoch update is for the end of an epoch.
endTime int64
expireTime int64
seq uint64
startTime int64
erc20MultisigSetThresholdEvent object
blockNumber uint64
blockTime int64
id string
logIndex uint64
newThreshold int64
nonce string
txHash string
erc20MultisigSignerAdded object
epochSeq Epoch that the node was added for
newSigner Ethereum address of the new signer
nonce string
Nonce used.
signatureId ID of the signature bundle
submitter Address of the submitter of the transaction
timestamp int64
validatorId Node ID of the Vega node to be added
erc20MultisigSignerEvent object
blockNumber uint64
blockTime int64
id string
logIndex uint64
nonce string
signer string
txHash string
type v1ERC20MultiSigSignerEventType
Possible values: [TYPE_UNSPECIFIED, TYPE_ADDED, TYPE_REMOVED]
Default value: TYPE_UNSPECIFIED
erc20MultisigSignerRemoved object
epochSeq Epoch that the node was removed for
nonce string
Nonce used.
oldSigner Ethereum address of the signer to be removed
signatureSubmitters object[]
Array [
signatureId string
Signature ID of the signer removed.
submitter Address of the submitter of the transaction
]
timestamp int64
validatorId Node ID of the Vega node which is to be removed
ethereumKeyRotation object
blockHeight uint64
newAddress Ethereum address that is newly associated with the node
nodeId Node ID of the node that rotated their Ethereum key
oldAddress Ethereum address that was previously associated with the node
expiredOrders object
marketId Market ID for the event
orderIds string[]
id Unique event ID for the message
keyRotation object
blockHeight uint64
newPubKey Vega public key that is newly associated with the node
nodeId Node ID of the node that rotated their Vega key
oldPubKey Vega public key that was previously associated with the node
ledgerMovements object
ledgerMovements object[]
Array [
balances object[]
Resulting balances once the ledger movement are applied.
Array [
account object
Account relating to the transfer.
assetId string
Asset ID of the asset for this account.
marketId string
Not specified if account is not related to a market.
owner string
Not specified if network account.
type Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Type of the account.
balance string
Balance relating to the transfer. This field is an unsigned integer scaled to the asset's decimal places.
]
entries object[]
All the entries for these ledger movements.
Array [
amount string
Amount to transfer. This field is an unsigned integer scaled to the asset's decimal places.
fromAccount object
One or more accounts to transfer from.
assetId string
Asset ID of the asset for this account.
marketId string
Not specified if account is not related to a market.
owner string
Not specified if network account.
type Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Type of the account.
fromAccountBalance string
Sender account balance after the transfer. This field is an unsigned integer scaled to the asset's decimal places.
timestamp int64
Timestamp in nanoseconds of when the ledger entry was created.
toAccount object
One or more accounts to transfer to.
assetId string
Asset ID of the asset for this account.
marketId string
Not specified if account is not related to a market.
owner string
Not specified if network account.
type Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Type of the account.
toAccountBalance string
Receiver account balance after the transfer. This field is an unsigned integer scaled to the asset's decimal places.
type Transfers can occur between parties on Vega, these are the types that indicate why a transfer took place
Possible values: [TRANSFER_TYPE_UNSPECIFIED, TRANSFER_TYPE_LOSS, TRANSFER_TYPE_WIN, TRANSFER_TYPE_MTM_LOSS, TRANSFER_TYPE_MTM_WIN, TRANSFER_TYPE_MARGIN_LOW, TRANSFER_TYPE_MARGIN_HIGH, TRANSFER_TYPE_MARGIN_CONFISCATED, TRANSFER_TYPE_MAKER_FEE_PAY, TRANSFER_TYPE_MAKER_FEE_RECEIVE, TRANSFER_TYPE_INFRASTRUCTURE_FEE_PAY, TRANSFER_TYPE_INFRASTRUCTURE_FEE_DISTRIBUTE, TRANSFER_TYPE_LIQUIDITY_FEE_PAY, TRANSFER_TYPE_LIQUIDITY_FEE_DISTRIBUTE, TRANSFER_TYPE_BOND_LOW, TRANSFER_TYPE_BOND_HIGH, TRANSFER_TYPE_WITHDRAW, TRANSFER_TYPE_DEPOSIT, TRANSFER_TYPE_BOND_SLASHING, TRANSFER_TYPE_REWARD_PAYOUT, TRANSFER_TYPE_TRANSFER_FUNDS_SEND, TRANSFER_TYPE_TRANSFER_FUNDS_DISTRIBUTE, TRANSFER_TYPE_CLEAR_ACCOUNT, TRANSFER_TYPE_CHECKPOINT_BALANCE_RESTORE, TRANSFER_TYPE_SPOT, TRANSFER_TYPE_HOLDING_LOCK, TRANSFER_TYPE_HOLDING_RELEASE, TRANSFER_TYPE_SUCCESSOR_INSURANCE_FRACTION, TRANSFER_TYPE_LIQUIDITY_FEE_ALLOCATE, TRANSFER_TYPE_LIQUIDITY_FEE_NET_DISTRIBUTE, TRANSFER_TYPE_SLA_PENALTY_BOND_APPLY, TRANSFER_TYPE_SLA_PENALTY_LP_FEE_APPLY, TRANSFER_TYPE_LIQUIDITY_FEE_UNPAID_COLLECT, TRANSFER_TYPE_SLA_PERFORMANCE_BONUS_DISTRIBUTE]
Default value: TRANSFER_TYPE_UNSPECIFIED
Transfer type for this entry.
]
]
liquidityProvision object
buys object[]
Set of liquidity buy orders to meet the liquidity provision obligation.
Array [
liquidityOrder object
Liquidity order from the original submission.
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
orderId string
Unique ID of the pegged order generated to fulfil this liquidity order.
]
commitmentAmount string
Specified as a unitless number that represents the amount of settlement asset of the market. This field is an unsigned integer scaled to the asset's decimal places.
createdAt int64
Timestamp in Unix nanoseconds for when the order was created.
fee string
Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market, as per setting fees and rewarding liquidity providers.
id string
Unique ID for the liquidity provision.
marketId string
Market ID for the order.
partyId string
Unique party ID for the creator of the provision.
reference string
Reference shared between this liquidity provision and all its orders.
sells object[]
Set of liquidity sell orders to meet the liquidity provision obligation.
Array [
liquidityOrder object
Liquidity order from the original submission.
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
orderId string
Unique ID of the pegged order generated to fulfil this liquidity order.
]
status vegaLiquidityProvisionStatus
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_STOPPED, STATUS_CANCELLED, STATUS_REJECTED, STATUS_UNDEPLOYED, STATUS_PENDING]
Default value: STATUS_UNSPECIFIED
Status of this liquidity provision order.
updatedAt int64
Timestamp in Unix nanoseconds for when the order was updated.
version uint64
Version of this liquidity provision order.
lossSocialization object
amount Amount distributed
marketId Market ID for the event
partyId Party ID (public key) for the event
marginLevels object
asset string
Asset ID for which the margin levels apply.
collateralReleaseLevel string
Collateral release level value. This field is an unsigned integer scaled to the asset's decimal places.
initialMargin string
Initial margin value. This field is an unsigned integer scaled to the asset's decimal places.
maintenanceMargin string
Maintenance margin value. This field is an unsigned integer scaled to the asset's decimal places.
marketId string
Market ID for which the margin levels apply.
partyId string
Party ID for whom the margin levels apply.
searchLevel string
Margin search level value. This field is an unsigned integer scaled to the asset's decimal places.
timestamp int64
Timestamp in Unix nanoseconds for when the ledger entry was created.
market object
marketId Market ID for the event
payload Payload is a unique information string
marketCreated object
decimalPlaces uint64
Number of decimal places that a price must be shifted by in order to get a correct price denominated in the currency of the market, for example: realPrice = price / 10^decimalPlaces.
fees object
Fees configuration that apply to the market.
factors object
Fee factors.
infrastructureFee string
Infrastructure fee charged network wide for staking and governance.
liquidityFee string
Liquidity fee applied per market for market making.
makerFee string
Market maker fee charged network wide.
id string
Unique ID for the market.
insurancePoolFraction string
The fraction of the parent market's insurance pool that this market inherits; range 0 through 1.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
LiquidityMonitoringParameters for the market.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
marketTimestamps object
Timestamps for when the market state changes.
close int64
Time when the market closed.
open int64
Time when the market has left the opening auction and is ready to accept trades.
pending int64
Time when the market has been voted in and began its opening auction.
proposed int64
Time when the market is first proposed.
openingAuction object
Auction duration specifies how long the opening auction will run (minimum duration and optionally a minimum traded volume).
duration int64
Duration of the auction in seconds.
volume uint64
Target uncrossing trading volume.
parentMarketId ID of the market this market succeeds
positionDecimalPlaces int64
The number of decimal places for a position.
priceMonitoringSettings object
PriceMonitoringSettings for the market.
parameters object
Specifies price monitoring parameters to be used for price monitoring purposes.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
state Current state of the market
Possible values: [STATE_UNSPECIFIED, STATE_PROPOSED, STATE_REJECTED, STATE_PENDING, STATE_CANCELLED, STATE_ACTIVE, STATE_SUSPENDED, STATE_CLOSED, STATE_TRADING_TERMINATED, STATE_SETTLED]
Default value: STATE_UNSPECIFIED
Current state of the market.
successorMarketId string
ID of the market that succeeds this market if it exists. This will be populated by the system when the successor market is enabled.
tradableInstrument object
Tradable instrument configuration.
instrument object
Details for the underlying instrument.
code string
Code for the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data spec and the data source.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
Data source specification that describes the settlement data source filter.
createdAt int64
data object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
id string
Hash generated from the DataSpec data.
status Status describes the status of the data source spec
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]
Default value: STATUS_UNSPECIFIED
• STATUS_UNSPECIFIED: Default value.
• STATUS_ACTIVE: STATUS_ACTIVE describes an active data source spec.
• STATUS_DEACTIVATED: STATUS_DEACTIVATED describes an data source spec that is not listening to data anymore.
updatedAt int64
dataSourceSpecForTradingTermination object
Data source specification that describes the trading termination data source filter.
createdAt int64
data object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
id string
Hash generated from the DataSpec data.
status Status describes the status of the data source spec
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]
Default value: STATUS_UNSPECIFIED
• STATUS_UNSPECIFIED: Default value.
• STATUS_ACTIVE: STATUS_ACTIVE describes an active data source spec.
• STATUS_DEACTIVATED: STATUS_DEACTIVATED describes an data source spec that is not listening to data anymore.
updatedAt int64
quoteName string
Quote name of the instrument.
settlementAsset string
Underlying asset for the future.
id string
Unique instrument ID.
metadata object
Collection of instrument meta-data.
tags string[]
List of 0 or more tags.
name string
Name of the instrument.
spot object
Spot.
baseAsset string
Asset ID of the underlying base asset for the spot product.
name string
Name of the instrument.
quoteAsset string
Asset ID of the underlying quote asset for the spot product.
logNormalRiskModel object
Log normal.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
marginCalculator object
Margin calculator for the instrument.
scalingFactors object
Scaling factors for margin calculation.
collateralRelease double
Collateral release level. If a trader has collateral above this level, the system will release collateral to a trader's general collateral account for the asset.
initialMargin double
Initial margin level. This is the minimum amount of collateral required to open a position in a market that requires margin.
searchLevel double
Collateral search level. If collateral dips below this value, the system will search for collateral to release.
simpleRiskModel object
Simple.
params object
Risk model params for simple modelling.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
tradingMode Trading mode the market is currently running, also referred to as 'market state'
Possible values: [TRADING_MODE_UNSPECIFIED, TRADING_MODE_CONTINUOUS, TRADING_MODE_BATCH_AUCTION, TRADING_MODE_OPENING_AUCTION, TRADING_MODE_MONITORING_AUCTION, TRADING_MODE_NO_TRADING]
Default value: TRADING_MODE_UNSPECIFIED
Current mode of execution of the market.
marketData object
auctionEnd int64
Time in seconds until the end of the auction (zero if currently not in auction period).
auctionStart int64
Time until next auction, or start time of the current auction if market is in auction period.
bestBidPrice string
Highest price level on an order book for buy orders, as an unsigned integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.
bestBidVolume uint64
Aggregated volume being bid at the best bid price, as an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market is configured to 5 decimal places.
bestOfferPrice string
Lowest price level on an order book for offer orders. This field is an unsigned integer scaled to the market's decimal places.
bestOfferVolume uint64
Aggregated volume being offered at the best offer price, as an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market is configured to 5 decimal places.
bestStaticBidPrice string
Highest price on the order book for buy orders not including pegged orders. This field is an unsigned integer scaled to the market's decimal places.
bestStaticBidVolume uint64
Total volume at the best static bid price excluding pegged orders.
bestStaticOfferPrice string
Lowest price on the order book for sell orders not including pegged orders. This field is an unsigned integer scaled to the market's decimal places.
bestStaticOfferVolume uint64
Total volume at the best static offer price, excluding pegged orders.
extensionTrigger Auction triggers indicate what condition triggered an auction (if market is in auction mode)
Possible values: [AUCTION_TRIGGER_UNSPECIFIED, AUCTION_TRIGGER_BATCH, AUCTION_TRIGGER_OPENING, AUCTION_TRIGGER_PRICE, AUCTION_TRIGGER_LIQUIDITY, AUCTION_TRIGGER_LIQUIDITY_TARGET_NOT_MET, AUCTION_TRIGGER_UNABLE_TO_DEPLOY_LP_ORDERS]
Default value: AUCTION_TRIGGER_UNSPECIFIED
When a market auction is extended, this field indicates what caused the extension.
indicativePrice string
Indicative price (zero if not in auction). This field is an unsigned scaled to the market's decimal places.
indicativeVolume uint64
Indicative volume (zero if not in auction).
lastTradedPrice string
Last traded price of the market. This field is an unsigned integer scaled to the market's decimal places.
liquidityProviderFeeShare object[]
Equity like share of liquidity fee for each liquidity provider.
Array [
averageEntryValuation string
Average entry valuation of the liquidity provider for the market.
averageScore string
Average liquidity score.
equityLikeShare string
Share own by this liquidity provider.
party string
Liquidity provider party ID.
virtualStake string
The virtual stake of this liquidity provider.
]
markPrice string
Mark price, as an unsigned integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.
market Market ID for the data
marketGrowth string
Market growth at the last market time window.
marketState Current state of the market
Possible values: [STATE_UNSPECIFIED, STATE_PROPOSED, STATE_REJECTED, STATE_PENDING, STATE_CANCELLED, STATE_ACTIVE, STATE_SUSPENDED, STATE_CLOSED, STATE_TRADING_TERMINATED, STATE_SETTLED]
Default value: STATE_UNSPECIFIED
Current state of the market.
marketTradingMode Trading mode the market is currently running, also referred to as 'market state'
Possible values: [TRADING_MODE_UNSPECIFIED, TRADING_MODE_CONTINUOUS, TRADING_MODE_BATCH_AUCTION, TRADING_MODE_OPENING_AUCTION, TRADING_MODE_MONITORING_AUCTION, TRADING_MODE_NO_TRADING]
Default value: TRADING_MODE_UNSPECIFIED
Current trading mode for the market.
marketValueProxy string
Market value proxy.
midPrice string
Arithmetic average of the best bid price and best offer price, as an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.
nextMarkToMarket int64
Time in Unix nanoseconds when the next mark-to-market calculation will occur.
openInterest uint64
Sum of the size of all positions greater than zero on the market.
priceMonitoringBounds object[]
One or more price monitoring bounds for the current timestamp.
Array [
maxValidPrice string
Maximum price that isn't currently breaching the specified price monitoring trigger. This field is an unsigned integer scaled to the market's decimal places.
minValidPrice string
Minimum price that isn't currently breaching the specified price monitoring trigger. This field is an unsigned integer scaled to the market's decimal places.
referencePrice string
Reference price used to calculate the valid price range. This field is an unsigned integer scaled to the market's decimal places.
trigger object
Price monitoring trigger associated with the bounds.
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
staticMidPrice string
Arithmetic average of the best static bid price and best static offer price. This field is an unsigned integer scaled to the market's decimal places.
suppliedStake string
Available stake for the given market. This field is an unsigned integer scaled to the settlement asset's decimal places.
targetStake string
Targeted stake for the given market. This field is an unsigned integer scaled to the settlement asset's decimal places.
timestamp int64
Timestamp in Unix nanoseconds at which this mark price was relevant.
trigger Auction triggers indicate what condition triggered an auction (if market is in auction mode)
Possible values: [AUCTION_TRIGGER_UNSPECIFIED, AUCTION_TRIGGER_BATCH, AUCTION_TRIGGER_OPENING, AUCTION_TRIGGER_PRICE, AUCTION_TRIGGER_LIQUIDITY, AUCTION_TRIGGER_LIQUIDITY_TARGET_NOT_MET, AUCTION_TRIGGER_UNABLE_TO_DEPLOY_LP_ORDERS]
Default value: AUCTION_TRIGGER_UNSPECIFIED
When a market is in an auction trading mode, this field indicates what triggered the auction.
marketTick object
id Market ID for the event
time int64
marketUpdated object
decimalPlaces uint64
Number of decimal places that a price must be shifted by in order to get a correct price denominated in the currency of the market, for example: realPrice = price / 10^decimalPlaces.
fees object
Fees configuration that apply to the market.
factors object
Fee factors.
infrastructureFee string
Infrastructure fee charged network wide for staking and governance.
liquidityFee string
Liquidity fee applied per market for market making.
makerFee string
Market maker fee charged network wide.
id string
Unique ID for the market.
insurancePoolFraction string
The fraction of the parent market's insurance pool that this market inherits; range 0 through 1.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
LiquidityMonitoringParameters for the market.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
marketTimestamps object
Timestamps for when the market state changes.
close int64
Time when the market closed.
open int64
Time when the market has left the opening auction and is ready to accept trades.
pending int64
Time when the market has been voted in and began its opening auction.
proposed int64
Time when the market is first proposed.
openingAuction object
Auction duration specifies how long the opening auction will run (minimum duration and optionally a minimum traded volume).
duration int64
Duration of the auction in seconds.
volume uint64
Target uncrossing trading volume.
parentMarketId ID of the market this market succeeds
positionDecimalPlaces int64
The number of decimal places for a position.
priceMonitoringSettings object
PriceMonitoringSettings for the market.
parameters object
Specifies price monitoring parameters to be used for price monitoring purposes.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
state Current state of the market
Possible values: [STATE_UNSPECIFIED, STATE_PROPOSED, STATE_REJECTED, STATE_PENDING, STATE_CANCELLED, STATE_ACTIVE, STATE_SUSPENDED, STATE_CLOSED, STATE_TRADING_TERMINATED, STATE_SETTLED]
Default value: STATE_UNSPECIFIED
Current state of the market.
successorMarketId string
ID of the market that succeeds this market if it exists. This will be populated by the system when the successor market is enabled.
tradableInstrument object
Tradable instrument configuration.
instrument object
Details for the underlying instrument.
code string
Code for the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data spec and the data source.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
Data source specification that describes the settlement data source filter.
createdAt int64
data object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
id string
Hash generated from the DataSpec data.
status Status describes the status of the data source spec
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]
Default value: STATUS_UNSPECIFIED
• STATUS_UNSPECIFIED: Default value.
• STATUS_ACTIVE: STATUS_ACTIVE describes an active data source spec.
• STATUS_DEACTIVATED: STATUS_DEACTIVATED describes an data source spec that is not listening to data anymore.
updatedAt int64
dataSourceSpecForTradingTermination object
Data source specification that describes the trading termination data source filter.
createdAt int64
data object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
id string
Hash generated from the DataSpec data.
status Status describes the status of the data source spec
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]
Default value: STATUS_UNSPECIFIED
• STATUS_UNSPECIFIED: Default value.
• STATUS_ACTIVE: STATUS_ACTIVE describes an active data source spec.
• STATUS_DEACTIVATED: STATUS_DEACTIVATED describes an data source spec that is not listening to data anymore.
updatedAt int64
quoteName string
Quote name of the instrument.
settlementAsset string
Underlying asset for the future.
id string
Unique instrument ID.
metadata object
Collection of instrument meta-data.
tags string[]
List of 0 or more tags.
name string
Name of the instrument.
spot object
Spot.
baseAsset string
Asset ID of the underlying base asset for the spot product.
name string
Name of the instrument.
quoteAsset string
Asset ID of the underlying quote asset for the spot product.
logNormalRiskModel object
Log normal.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
marginCalculator object
Margin calculator for the instrument.
scalingFactors object
Scaling factors for margin calculation.
collateralRelease double
Collateral release level. If a trader has collateral above this level, the system will release collateral to a trader's general collateral account for the asset.
initialMargin double
Initial margin level. This is the minimum amount of collateral required to open a position in a market that requires margin.
searchLevel double
Collateral search level. If collateral dips below this value, the system will search for collateral to release.
simpleRiskModel object
Simple.
params object
Risk model params for simple modelling.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
tradingMode Trading mode the market is currently running, also referred to as 'market state'
Possible values: [TRADING_MODE_UNSPECIFIED, TRADING_MODE_CONTINUOUS, TRADING_MODE_BATCH_AUCTION, TRADING_MODE_OPENING_AUCTION, TRADING_MODE_MONITORING_AUCTION, TRADING_MODE_NO_TRADING]
Default value: TRADING_MODE_UNSPECIFIED
Current mode of execution of the market.
networkLimits object
canProposeAsset boolean
Are asset proposals allowed at this point in time.
canProposeMarket boolean
Are market proposals allowed at this point in time.
genesisLoaded boolean
True once the genesis file is loaded.
proposeAssetEnabled boolean
Are asset proposals enabled on this chain.
proposeAssetEnabledFrom int64
Timestamp in Unix nanoseconds at which asset proposals will be enabled (0 indicates not set).
proposeMarketEnabled boolean
Are market proposals enabled on this chain.
proposeMarketEnabledFrom int64
Timestamp in Unix nanoseconds at which market proposals will be enabled (0 indicates not set).
networkParameter object
key string
Unique key of the network parameter.
value string
Value for the network parameter.
nodeSignature object
id string
ID of the resource being signed.
kind Kind of signature created by a node, for example, allow-listing a new asset, withdrawal etc
Possible values: [NODE_SIGNATURE_KIND_UNSPECIFIED, NODE_SIGNATURE_KIND_ASSET_NEW, NODE_SIGNATURE_KIND_ASSET_WITHDRAWAL, NODE_SIGNATURE_KIND_ERC20_MULTISIG_SIGNER_ADDED, NODE_SIGNATURE_KIND_ERC20_MULTISIG_SIGNER_REMOVED, NODE_SIGNATURE_KIND_ASSET_UPDATE]
Default value: NODE_SIGNATURE_KIND_UNSPECIFIED
Kind of resource being signed.
sig byte
The signature generated by the signer.
oracleData object
externalData object
data object
Data describes valid source data that has been received by the node. It represents both matched and unmatched data.
broadcastAt int64
Timestamp in Unix nanoseconds for when the data was broadcast to the markets with a matching spec. It has no value when the data did not match any spec.
data object[]
Array [
name string
Name of the property.
value string
Value of the property.
]
matchedSpecIds string[]
matched_specs_ids lists all the specs that matched this data. When the array is empty, it means no spec matched this data.
signers object[]
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
oracleSpec object
externalDataSourceSpec object
spec object
Data source spec describes the data source base that a product or a risk model wants to get from the data source engine. This message contains additional information used by the API.
createdAt int64
data object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
id string
Hash generated from the DataSpec data.
status Status describes the status of the data source spec
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_DEACTIVATED]
Default value: STATUS_UNSPECIFIED
• STATUS_UNSPECIFIED: Default value.
• STATUS_ACTIVE: STATUS_ACTIVE describes an active data source spec.
• STATUS_DEACTIVATED: STATUS_DEACTIVATED describes an data source spec that is not listening to data anymore.
updatedAt int64
order object
batchId uint64
Batch ID for the order, used internally for orders submitted during auctions to keep track of the auction batch this order falls under. Required for fees calculation.
createdAt int64
Timestamp for when the order was created at, in nanoseconds.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire.
icebergOrder object
minimumVisibleSize uint64
If the visible size of the order falls below this value, it will be replenished back to the peak size using the reserved amount.
peakSize uint64
Size of the order that will be made visible if the iceberg order is replenished after trading.
reservedRemaining uint64
Size of the order that is reserved and used to restore the iceberg's peak when it is refreshed.
id string
Unique ID generated for the order.
liquidityProvisionId string
Set if the order was created as part of a liquidity provision, will be empty if not.
marketId string
Market ID for the order.
partyId string
Party ID for the order.
peggedOrder object
Pegged order details, used only if the order represents a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.
reason OrderError codes are returned in the Order.reason field - If there is an issue with an order during its life-cycle, it will be marked with `status.ORDER_STATUS_REJECTED`
Possible values: [ORDER_ERROR_UNSPECIFIED, ORDER_ERROR_INVALID_MARKET_ID, ORDER_ERROR_INVALID_ORDER_ID, ORDER_ERROR_OUT_OF_SEQUENCE, ORDER_ERROR_INVALID_REMAINING_SIZE, ORDER_ERROR_TIME_FAILURE, ORDER_ERROR_REMOVAL_FAILURE, ORDER_ERROR_INVALID_EXPIRATION_DATETIME, ORDER_ERROR_INVALID_ORDER_REFERENCE, ORDER_ERROR_EDIT_NOT_ALLOWED, ORDER_ERROR_AMEND_FAILURE, ORDER_ERROR_NOT_FOUND, ORDER_ERROR_INVALID_PARTY_ID, ORDER_ERROR_MARKET_CLOSED, ORDER_ERROR_MARGIN_CHECK_FAILED, ORDER_ERROR_MISSING_GENERAL_ACCOUNT, ORDER_ERROR_INTERNAL_ERROR, ORDER_ERROR_INVALID_SIZE, ORDER_ERROR_INVALID_PERSISTENCE, ORDER_ERROR_INVALID_TYPE, ORDER_ERROR_SELF_TRADING, ORDER_ERROR_INSUFFICIENT_FUNDS_TO_PAY_FEES, ORDER_ERROR_INCORRECT_MARKET_TYPE, ORDER_ERROR_INVALID_TIME_IN_FORCE, ORDER_ERROR_CANNOT_SEND_GFN_ORDER_DURING_AN_AUCTION, ORDER_ERROR_CANNOT_SEND_GFA_ORDER_DURING_CONTINUOUS_TRADING, ORDER_ERROR_CANNOT_AMEND_TO_GTT_WITHOUT_EXPIRYAT, ORDER_ERROR_EXPIRYAT_BEFORE_CREATEDAT, ORDER_ERROR_CANNOT_HAVE_GTC_AND_EXPIRYAT, ORDER_ERROR_CANNOT_AMEND_TO_FOK_OR_IOC, ORDER_ERROR_CANNOT_AMEND_TO_GFA_OR_GFN, ORDER_ERROR_CANNOT_AMEND_FROM_GFA_OR_GFN, ORDER_ERROR_CANNOT_SEND_IOC_ORDER_DURING_AUCTION, ORDER_ERROR_CANNOT_SEND_FOK_ORDER_DURING_AUCTION, ORDER_ERROR_MUST_BE_LIMIT_ORDER, ORDER_ERROR_MUST_BE_GTT_OR_GTC, ORDER_ERROR_WITHOUT_REFERENCE_PRICE, ORDER_ERROR_BUY_CANNOT_REFERENCE_BEST_ASK_PRICE, ORDER_ERROR_OFFSET_MUST_BE_GREATER_OR_EQUAL_TO_ZERO, ORDER_ERROR_SELL_CANNOT_REFERENCE_BEST_BID_PRICE, ORDER_ERROR_OFFSET_MUST_BE_GREATER_THAN_ZERO, ORDER_ERROR_INSUFFICIENT_ASSET_BALANCE, ORDER_ERROR_CANNOT_AMEND_PEGGED_ORDER_DETAILS_ON_NON_PEGGED_ORDER, ORDER_ERROR_UNABLE_TO_REPRICE_PEGGED_ORDER, ORDER_ERROR_UNABLE_TO_AMEND_PRICE_ON_PEGGED_ORDER, ORDER_ERROR_NON_PERSISTENT_ORDER_OUT_OF_PRICE_BOUNDS, ORDER_ERROR_TOO_MANY_PEGGED_ORDERS, ORDER_ERROR_POST_ONLY_ORDER_WOULD_TRADE, ORDER_ERROR_REDUCE_ONLY_ORDER_WOULD_NOT_REDUCE_POSITION]
Default value: ORDER_ERROR_UNSPECIFIED
Futher details for why an order with status STATUS_REJECTED was rejected.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order.
remaining uint64
Size remaining, when this reaches 0 then the order is fully filled and status becomes STATUS_FILLED.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL.
size uint64
Size for the order, for example, in a futures market the size equals the number of contracts.
status Status values for an order
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_EXPIRED, STATUS_CANCELLED, STATUS_STOPPED, STATUS_FILLED, STATUS_REJECTED, STATUS_PARTIALLY_FILLED, STATUS_PARKED]
Default value: STATUS_UNSPECIFIED
Current status of the order.
timeInForce Time in force indicates how long an order will remain active before it is executed or expires. - See OrderTimeInForce
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
• TIME_IN_FORCE_UNSPECIFIED: Default value for TimeInForce, can be valid for an amend
• TIME_IN_FORCE_GTC: Good until cancelled, the order trades any amount and as much as possible and remains on the book until it either trades completely or is cancelled
• TIME_IN_FORCE_GTT: Good until specified time, this order type trades any amount and as much as possible and remains on the book until it either trades completely, is cancelled, or expires at a set time NOTE: this may in future be multiple types or have sub types for orders that provide different ways of specifying expiry
• TIME_IN_FORCE_IOC: Immediate or cancel, the order trades any amount and as much as possible but does not remain on the book (whether it trades or not)
• TIME_IN_FORCE_FOK: Fill or kill, the order either trades completely i.e. remainingSize == 0 after adding, or not at all, and does not remain on the book if it doesn't trade
• TIME_IN_FORCE_GFA: Good for auction, this order is only accepted during an auction period
• TIME_IN_FORCE_GFN: Good for normal, this order is only accepted during normal trading (that can be continuous trading or frequent batched auctions)
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order.
updatedAt int64
Timestamp in Unix nanoseconds for when the order was last updated.
version uint64
Version for the order, initial value is version 1 and is incremented after each successful amend.
party object
id string
Unique ID for the party, typically represented by a public key.
positionResolution object
closed int64
distressed int64
markPrice Mark price as a string representing a scaled price
marketId Market ID for the event
positionStateEvent object
marketId Market ID for this position update
partyId Party ID for this position update
potentialBuys int64
potentialSells int64
size int64
vwBuyPrice Volume weighted prices
vwSellPrice string
proposal object
errorDetails string
Detailed error associated to the reason.
id string
Unique proposal ID.
partyId string
Party ID i.e. public key of the party submitting the proposal.
rationale object
Rationale behind a proposal.
description string
Description to show a short title / something in case the link goes offline. This is to be between 0 and 20k unicode characters. This is mandatory for all proposals.
title string
Title to be used to give a short description of the proposal in lists. This is to be between 0 and 100 unicode characters. This is mandatory for all proposals.
reason List of possible errors that can cause a proposal to be in state rejected or failed
Possible values: [PROPOSAL_ERROR_UNSPECIFIED, PROPOSAL_ERROR_CLOSE_TIME_TOO_SOON, PROPOSAL_ERROR_CLOSE_TIME_TOO_LATE, PROPOSAL_ERROR_ENACT_TIME_TOO_SOON, PROPOSAL_ERROR_ENACT_TIME_TOO_LATE, PROPOSAL_ERROR_INSUFFICIENT_TOKENS, PROPOSAL_ERROR_INVALID_INSTRUMENT_SECURITY, PROPOSAL_ERROR_NO_PRODUCT, PROPOSAL_ERROR_UNSUPPORTED_PRODUCT, PROPOSAL_ERROR_NO_TRADING_MODE, PROPOSAL_ERROR_UNSUPPORTED_TRADING_MODE, PROPOSAL_ERROR_NODE_VALIDATION_FAILED, PROPOSAL_ERROR_MISSING_BUILTIN_ASSET_FIELD, PROPOSAL_ERROR_MISSING_ERC20_CONTRACT_ADDRESS, PROPOSAL_ERROR_INVALID_ASSET, PROPOSAL_ERROR_INCOMPATIBLE_TIMESTAMPS, PROPOSAL_ERROR_NO_RISK_PARAMETERS, PROPOSAL_ERROR_NETWORK_PARAMETER_INVALID_KEY, PROPOSAL_ERROR_NETWORK_PARAMETER_INVALID_VALUE, PROPOSAL_ERROR_NETWORK_PARAMETER_VALIDATION_FAILED, PROPOSAL_ERROR_OPENING_AUCTION_DURATION_TOO_SMALL, PROPOSAL_ERROR_OPENING_AUCTION_DURATION_TOO_LARGE, PROPOSAL_ERROR_COULD_NOT_INSTANTIATE_MARKET, PROPOSAL_ERROR_INVALID_FUTURE_PRODUCT, PROPOSAL_ERROR_INVALID_RISK_PARAMETER, PROPOSAL_ERROR_MAJORITY_THRESHOLD_NOT_REACHED, PROPOSAL_ERROR_PARTICIPATION_THRESHOLD_NOT_REACHED, PROPOSAL_ERROR_INVALID_ASSET_DETAILS, PROPOSAL_ERROR_UNKNOWN_TYPE, PROPOSAL_ERROR_UNKNOWN_RISK_PARAMETER_TYPE, PROPOSAL_ERROR_INVALID_FREEFORM, PROPOSAL_ERROR_INSUFFICIENT_EQUITY_LIKE_SHARE, PROPOSAL_ERROR_INVALID_MARKET, PROPOSAL_ERROR_TOO_MANY_MARKET_DECIMAL_PLACES, PROPOSAL_ERROR_TOO_MANY_PRICE_MONITORING_TRIGGERS, PROPOSAL_ERROR_ERC20_ADDRESS_ALREADY_IN_USE, PROPOSAL_ERROR_LP_PRICE_RANGE_NONPOSITIVE, PROPOSAL_ERROR_LP_PRICE_RANGE_TOO_LARGE, PROPOSAL_ERROR_LINEAR_SLIPPAGE_FACTOR_OUT_OF_RANGE, PROPOSAL_ERROR_QUADRATIC_SLIPPAGE_FACTOR_OUT_OF_RANGE, PROPOSAL_ERROR_INVALID_SPOT, PROPOSAL_ERROR_SPOT_PRODUCT_DISABLED, PROPOSAL_ERROR_INVALID_SUCCESSOR_MARKET, PROPOSAL_ERROR_GOVERNANCE_TRANSFER_PROPOSAL_FAILED, PROPOSAL_ERROR_GOVERNANCE_TRANSFER_PROPOSAL_INVALID, PROPOSAL_ERROR_GOVERNANCE_CANCEL_TRANSFER_PROPOSAL_INVALID]
Default value: PROPOSAL_ERROR_UNSPECIFIED
Reason for the current state of the proposal, this may be set in case of REJECTED and FAILED statuses.
reference string
Proposal reference.
requiredLiquidityProviderMajority string
Required majority from liquidity providers, optional but is required for market update proposal.
requiredLiquidityProviderParticipation string
Required participation from liquidity providers, optional but is required for market update proposal.
requiredMajority string
Required majority for this proposal.
requiredParticipation string
Required vote participation for this proposal.
state Proposal state transition: Open -> - Passed -> Enacted. - Passed -> Failed. - Declined Rejected Proposal can enter Failed state from any other state
Possible values: [STATE_UNSPECIFIED, STATE_FAILED, STATE_OPEN, STATE_PASSED, STATE_REJECTED, STATE_DECLINED, STATE_ENACTED, STATE_WAITING_FOR_NODE_VOTE]
Default value: STATE_UNSPECIFIED
Current state of the proposal, i.e. open, passed, failed etc.
terms object
Proposal configuration and the actual change that is meant to be executed when proposal is enacted.
cancelTransfer object
Cancel a governance transfer.
changes object
transferId string
ID of the governance transfer proposal.
closingTimestamp int64
Timestamp as Unix time in seconds when voting closes for this proposal, constrained by minClose and maxClose network parameters.
enactmentTimestamp int64
Timestamp as Unix time in seconds when proposal gets enacted if passed, constrained by minEnact and maxEnact network parameters.
newAsset object
Proposal change for creating new assets on Vega.
changes object
Configuration of the new asset.
builtinAsset object
Vega built-in asset.
maxFaucetAmountMint string
Maximum amount that can be requested by a party through the built-in asset faucet at a time.
decimals uint64
Number of decimal / precision handled by this asset.
erc20 object
Ethereum ERC20 asset.
contractAddress string
Address of the contract for the token, on the ethereum network.
lifetimeLimit string
Lifetime limits deposit per address note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
name string
Name of the asset (e.g: Great British Pound).
quantum string
Minimum economically meaningful amount in the asset.
symbol string
Symbol of the asset (e.g: GBP).
newFreeform object
Proposal change for a freeform request, which can be voted on but does not change the behaviour of the system, and can be used to gauge community sentiment.
newMarket object
Proposal change for creating new futures market on Vega.
changes object
Configuration of the new market.
decimalPlaces uint64
Decimal places used for the new futures market, sets the smallest price increment on the book.
instrument object
New futures market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Product quote name.
settlementAsset string
Asset ID for the product's settlement asset.
name string
Instrument name.
spot object
Spot.
baseAsset string
Base asset ID.
name string
Product name.
quoteAsset string
Quote asset ID.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
Liquidity monitoring parameters.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
metadata string[]
Optional new futures market metadata, tags.
positionDecimalPlaces int64
Decimal places for order sizes, sets what size the smallest order / position on the futures market can be.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
successor object
Successor configuration. If this proposal is meant to succeed a given market, then this should be set.
insurancePoolFraction string
A decimal value between or equal to 0 and 1, specifying the fraction of the insurance pool balance that is carried over from the parent market to the successor.
parentMarketId string
ID of the market that the successor should take over from.
newSpotMarket object
Proposal change for creating new spot market on Vega.
changes object
Configuration of the new spot market.
decimalPlaces uint64
Decimal places used for the new spot market, sets the smallest price increment on the book.
instrument object
New spot market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Product quote name.
settlementAsset string
Asset ID for the product's settlement asset.
name string
Instrument name.
spot object
Spot.
baseAsset string
Base asset ID.
name string
Product name.
quoteAsset string
Quote asset ID.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
metadata string[]
Optional new spot market metadata, tags.
positionDecimalPlaces int64
Decimal places for order sizes, sets what size the smallest order / position on the spot market can be.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
newTransfer object
Proposal change for a governance transfer.
changes object
Configuration for a new transfer.
amount Maximum amount to transfer
asset ID of asset to transfer
destination Specifies the account to transfer to, depending on the account type: Network treasury: leave empty Party: party's public key Market insurance pool: market ID
destinationType Specifies the account type to transfer to: reward pool, party, network insurance pool, market insurance pool
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
fractionOfBalance Maximum fraction of the source account's balance to transfer as a decimal - i.e. 0.1 = 10% of the balance
oneOff object
deliverOn int64
Timestamp in Unix nanoseconds for when the transfer should be delivered into the receiver's account.
recurring object
endEpoch uint64
Last epoch at which this transfer shall be paid.
startEpoch uint64
First epoch from which this transfer shall be paid.
source If network treasury, field is empty, otherwise uses the market ID
sourceType Source account type, such as network treasury, market insurance pool
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
transferType "All or nothing" or "best effort": All or nothing: Transfers the specified amount or does not transfer anything Best effort: Transfers the specified amount or the max allowable amount if this is less than the specified amount
Possible values: [GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED, GOVERNANCE_TRANSFER_TYPE_ALL_OR_NOTHING, GOVERNANCE_TRANSFER_TYPE_BEST_EFFORT]
Default value: GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED
updateAsset object
Proposal change for updating an asset.
assetId string
Asset ID the update is for.
changes object
Changes to apply on an existing asset.
erc20 object
Ethereum ERC20 asset update.
lifetimeLimit string
Lifetime limits deposit per address. This will be interpreted against the asset decimals. note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
quantum string
Minimum economically meaningful amount in the asset.
updateMarket object
Proposal change for modifying an existing futures market on Vega.
changes object
Updated configuration of the futures market.
instrument object
Updated futures market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
The binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Human-readable name/abbreviation of the quote name.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
Liquidity monitoring parameters.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
metadata string[]
Optional futures market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
marketId string
Market ID the update is for.
updateNetworkParameter object
Proposal change for updating Vega network parameters.
changes object
The network parameter to update.
key string
Unique key of the network parameter.
value string
Value for the network parameter.
updateSpotMarket object
Proposal change for modifying an existing spot market on Vega.
changes object
Updated configuration of the spot market.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
metadata string[]
Optional spot market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
marketId string
Market ID the update is for.
validationTimestamp int64
Validation timestamp as Unix time in seconds.
timestamp int64
Proposal timestamp for date and time as Unix time in nanoseconds when proposal was submitted to the network.
protocolUpgradeDataNodeReady object
lastBlockHeight uint64
protocolUpgradeEvent object
approvers string[]
status Status of the proposal
Possible values: [PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED, PROTOCOL_UPGRADE_PROPOSAL_STATUS_PENDING, PROTOCOL_UPGRADE_PROPOSAL_STATUS_APPROVED, PROTOCOL_UPGRADE_PROPOSAL_STATUS_REJECTED]
Default value: PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED
upgradeBlockHeight uint64
vegaReleaseTag Release tag for the vega binary
protocolUpgradeStarted object
lastBlockHeight uint64
rankingEvent object
epochSeq Epoch seq for which the status is valid
nextStatus Status of the validator in the next epoch
nodeId string
performanceScore Performance base score
previousStatus Status of the validator in the previous epoch
rankingScore Final score
stakeScore Stake based score - no anti-whaling
tmVotingPower int64
rewardPayout object
amount string
asset string
epochSeq string
market string
party string
percentOfTotalReward string
rewardType string
timestamp int64
riskFactor object
long string
Long Risk factor value.
market string
Market ID that relates to this risk factor.
short string
Short Risk factor value.
settleDistressed object
margin Margin value as an integer, for example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places
marketId Market ID for the event
partyId Party ID i.e. a party's public key for the event
price Price as an integer, for example `123456` is a correctly formatted price of `1.23456` assuming market configured to 5 decimal places
settleMarket object
marketId Market ID for the event
positionFactor Position factor - 10 ^ number of position decimal places
price Price of settlement as a string
settlePosition object
marketId Market ID for the event
partyId Party ID (public key) for the event
positionFactor Position factor - 10 ^ number of position decimal places
price Price of settlement as a string
tradeSettlements object[]
Array [
marketPrice Price of settlement as a string (in market decimals)
price Price of settlement as string (in asset decimals)
size int64
]
stakeLinking object
amount string
Amount of stake deposited or removed.
blockHeight uint64
Block when the event happened.
blockTime int64
Block time.
ethereumAddress string
Ethereum address from which the stake link was initiated.
finalizedAt int64
Time at which the Vega network finalised the state of the event.
id Internal ID for this staking event
logIndex uint64
Log index.
party string
Party to whom the event is directed at.
status - STATUS_UNSPECIFIED: Default value - STATUS_PENDING: Indicates an event waiting for confirmation from the Vega network - STATUS_ACCEPTED: Indicates an event accepted by the Vega network - STATUS_REJECTED: Indicates an event rejected by the Vega network
Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_ACCEPTED, STATUS_REJECTED]
Default value: STATUS_UNSPECIFIED
Status of the event.
ts int64
Timestamp in Unix nanoseconds of when the event was emitted by Ethereum.
txHash string
Hash of the transaction in which the event happened.
type - TYPE_UNSPECIFIED: Default value - TYPE_LINK: Indicate of a stake deposit instruction - TYPE_UNLINK: Indicate of a stake remove instruction
Possible values: [TYPE_UNSPECIFIED, TYPE_LINK, TYPE_UNLINK]
Default value: TYPE_UNSPECIFIED
Stake linking event type.
stateVar object
eventId string
id string
state string
stopOrder object
stopOrder object
createdAt int64
Creation time of the stop order.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
id ID of this stop order also the ID of the associated order if it is ever triggered
marketId string
ID of the market the stop order is submitted to.
ocoLinkId The ID of the 'other' part of the OCO if 2 stop orders were submitted at once
orderId string
ID of the order created once the trigger is hit.
partyId string
ID of the party that submitted this stop order.
price string
Fixed price at which the order will be submitted.
status - STATUS_UNSPECIFIED: Never valid - STATUS_PENDING: Pending to be executed once the trigger is breached - STATUS_CANCELLED: Cancelled by the user - STATUS_STOPPED: Stopped by the network, e.g: OCO on the other side has been triggered - STATUS_TRIGGERED: Stop order has been triggered and generated an order - STATUS_EXPIRED: Stop order has expired - STATUS_REJECTED: Stop order was rejected at submission
Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_CANCELLED, STATUS_STOPPED, STATUS_TRIGGERED, STATUS_EXPIRED, STATUS_REJECTED]
Default value: STATUS_UNSPECIFIED
Status of the stop order.
trailingPercentOffset Trailing percentage at which the order will be submitted. This should be expressed as a decimal value between 0 and 1, e.g. 0.01 for 1%
triggerDirection - TRIGGER_DIRECTION_UNSPECIFIED: Never valid - TRIGGER_DIRECTION_RISES_ABOVE: Stop order is triggered once the price rises above a certain level - TRIGGER_DIRECTION_FALLS_BELOW: Stop order is triggered once the price falls below a certain level
Possible values: [TRIGGER_DIRECTION_UNSPECIFIED, TRIGGER_DIRECTION_RISES_ABOVE, TRIGGER_DIRECTION_FALLS_BELOW]
Default value: TRIGGER_DIRECTION_UNSPECIFIED
Trigger direction for this stop order.
updatedAt int64
Last update of this stop order.
submission object
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
timeUpdate object
timestamp int64
trade object
aggressor Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Direction of the aggressive party e.g. SIDE_BUY or SIDE_SELL.
buyOrder string
Identifier of the order from the buy side.
buyer string
Unique party ID for the buyer.
buyerAuctionBatch uint64
Auction batch number that the buy side order was placed in.
buyerFee object
Fee amount charged to the buyer party for the trade.
infrastructureFee string
Fee amount paid for maintaining the Vega infrastructure. This field is an unsigned integer scaled using the asset's decimal places.
liquidityFee string
Fee amount paid to market makers. This field is an unsigned integer scaled to the asset's decimal places.
makerFee string
Fee amount paid to the non-aggressive party of the trade. This field is an unsigned integer scaled to the asset's decimal places.
id string
Unique ID for the trade.
marketId string
Market ID on which the trade occurred.
price string
Price for the trade, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.
sellOrder string
Identifier of the order from the sell side.
seller string
Unique party ID for the seller.
sellerAuctionBatch uint64
Auction batch number that the sell side order was placed in.
sellerFee object
Fee amount charged to the seller party for the trade.
infrastructureFee string
Fee amount paid for maintaining the Vega infrastructure. This field is an unsigned integer scaled using the asset's decimal places.
liquidityFee string
Fee amount paid to market makers. This field is an unsigned integer scaled to the asset's decimal places.
makerFee string
Fee amount paid to the non-aggressive party of the trade. This field is an unsigned integer scaled to the asset's decimal places.
size uint64
Size filled for the trade.
timestamp int64
Timestamp in Unix nanoseconds for when the trade occurred.
type Type values for a trade
Possible values: [TYPE_UNSPECIFIED, TYPE_DEFAULT, TYPE_NETWORK_CLOSE_OUT_GOOD, TYPE_NETWORK_CLOSE_OUT_BAD]
Default value: TYPE_UNSPECIFIED
Type for the trade.
transactionResult object
announceNode object
avatarUrl string
AvatarURL of the validator.
chainPubKey string
Public key for the blockchain, required field.
country string
Country code (ISO 3166-1 alpha-2) for the location of the node.
ethereumAddress string
Ethereum public key, required field.
ethereumSignature object
Signature from the validator made using the ethereum wallet.
algo string
Algorithm used to create the signature.
value string
Hex encoded bytes of the signature.
version int64
Version of the signature used to create the signature.
fromEpoch uint64
Epoch from which the validator is expected to be ready to validate blocks.
id string
Node ID of the validator, i.e. the node's public master key.
infoUrl string
URL with more info on the node.
name string
Name of the validator.
submitterAddress string
Ethereum public key to use as a submitter to allow automatic signature generation.
vegaPubKey string
Vega public key, required field.
vegaPubKeyIndex int64
Vega public key derivation index.
vegaSignature object
Signature from the validator made using the Vega wallet.
algo string
Algorithm used to create the signature.
value string
Hex encoded bytes of the signature.
version int64
Version of the signature used to create the signature.
batchMarketInstructions object
amendments object[]
List of order amendments to be processed sequentially.
Array [
expiresAt int64
Amend the expiry time for the order, if the Timestamp value is set, otherwise expiry time will remain unchanged.
marketId string
Market ID, this is required to find the order and will not be updated.
orderId string
Order ID, this is required to find the order and will not be updated, required field.
peggedOffset string
Amend the pegged order offset for the order. This field is an unsigned integer scaled to the market's decimal places.
peggedReference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Amend the pegged order reference for the order.
price string
Amend the price for the order if the price value is set, otherwise price will remain unchanged. This field is an unsigned integer scaled to the market's decimal places.
sizeDelta int64
Amend the size for the order by the delta specified:
• To reduce the size from the current value set a negative integer value
• To increase the size from the current value, set a positive integer value
• To leave the size unchanged set a value of zero This field needs to be scaled using the market's position decimal places.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Amend the time in force for the order, set to TIME_IN_FORCE_UNSPECIFIED to remain unchanged.
]
cancellations object[]
List of order cancellations to be processed sequentially.
Array [
marketId string
Market ID for the order, required field.
orderId string
Unique ID for the order. This is set by the system after consensus. Required field.
]
stopOrdersCancellation object[]
List of stop order cancellations to be processed sequentially.
Array [
marketId string
Optional market ID.
stopOrderId string
Optional order ID.
]
stopOrdersSubmission object[]
List of stop order submissions to be processed sequentially.
Array [
fallsBelow object
Stop order that will be triggered if the price falls below a given trigger price.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
orderSubmission object
Order to be submitted once the trigger is breached.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
price string
Fixed price at which the order will be submitted.
trailingPercentOffset string
Trailing percentage at which the order will be submitted.
risesAbove object
Stop order that will be triggered if the price rises above a given trigger price.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
orderSubmission object
Order to be submitted once the trigger is breached.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
price string
Fixed price at which the order will be submitted.
trailingPercentOffset string
Trailing percentage at which the order will be submitted.
]
submissions object[]
List of order submissions to be processed sequentially.
Array [
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
]
cancelTransfer object
transferId string
Transfer ID of the transfer to cancel.
delegateSubmission object
amount string
Amount of stake to delegate. This field is an unsigned integer scaled to the asset's decimal places.
nodeId string
Delegate to the specified node ID.
ethereumKeyRotateSubmission object
currentAddress string
Currently used public address.
ethereumSignature object
Signature that can be verified using the new ethereum address.
algo string
Algorithm used to create the signature.
value string
Hex encoded bytes of the signature.
version int64
Version of the signature used to create the signature.
newAddress string
New address to rotate to.
submitterAddress string
Ethereum public key to use as a submitter to allow automatic signature generation.
targetBlock uint64
Target block at which the key rotation will take effect on.
failure object
error Error message explaining the reason for the transaction failing processing
hash Hash of the transaction
issueSignatures object
kind Kind of signature created by a node, for example, allow-listing a new asset, withdrawal etc
Possible values: [NODE_SIGNATURE_KIND_UNSPECIFIED, NODE_SIGNATURE_KIND_ASSET_NEW, NODE_SIGNATURE_KIND_ASSET_WITHDRAWAL, NODE_SIGNATURE_KIND_ERC20_MULTISIG_SIGNER_ADDED, NODE_SIGNATURE_KIND_ERC20_MULTISIG_SIGNER_REMOVED, NODE_SIGNATURE_KIND_ASSET_UPDATE]
Default value: NODE_SIGNATURE_KIND_UNSPECIFIED
What kind of signatures to generate, namely for whether a signer is being added or removed.
submitter string
Ethereum address which will submit the signatures to the smart contract.
validatorNodeId string
Node ID of the validator node that will be signed in or out of the smart contract.
keyRotateSubmission object
currentPubKeyHash string
Hash of currently used public key.
newPubKey string
New public key to rotate to.
newPubKeyIndex int64
New Vega public key derivation index.
targetBlock uint64
Target block at which the key rotation will take effect on.
liquidityProvisionAmendment object
buys object[]
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
commitmentAmount string
From here at least one of the following is required to consider the command valid.
fee string
marketId string
Unique ID for the market with the liquidity provision to be amended.
reference string
sells object[]
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
liquidityProvisionCancellation object
marketId string
Unique ID for the market with the liquidity provision to be cancelled.
liquidityProvisionSubmission object
buys object[]
Set of liquidity buy orders to meet the liquidity provision obligation.
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
commitmentAmount string
Specified as a unitless number that represents the amount of settlement asset of the market. This field is an unsigned integer scaled using the asset's decimal places.
fee string
Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market, as per setting fees and rewarding liquidity providers.
marketId string
Market ID for the order.
reference string
Reference to be added to every order created out of this liquidity provision submission.
sells object[]
Set of liquidity sell orders to meet the liquidity provision obligation.
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
oracleDataSubmission object
payload byte
Data provided by the data source In the case of Open Oracle - it will be the entire object - it will contain messages, signatures and price data.
source Supported oracle sources
Possible values: [ORACLE_SOURCE_UNSPECIFIED, ORACLE_SOURCE_OPEN_ORACLE, ORACLE_SOURCE_JSON]
Default value: ORACLE_SOURCE_UNSPECIFIED
Source from which the data is coming from. Must be base64 encoded. Oracle data is a type of external data source data.
orderAmendment object
expiresAt int64
Amend the expiry time for the order, if the Timestamp value is set, otherwise expiry time will remain unchanged.
marketId string
Market ID, this is required to find the order and will not be updated.
orderId string
Order ID, this is required to find the order and will not be updated, required field.
peggedOffset string
Amend the pegged order offset for the order. This field is an unsigned integer scaled to the market's decimal places.
peggedReference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Amend the pegged order reference for the order.
price string
Amend the price for the order if the price value is set, otherwise price will remain unchanged. This field is an unsigned integer scaled to the market's decimal places.
sizeDelta int64
Amend the size for the order by the delta specified:
• To reduce the size from the current value set a negative integer value
• To increase the size from the current value, set a positive integer value
• To leave the size unchanged set a value of zero This field needs to be scaled using the market's position decimal places.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Amend the time in force for the order, set to TIME_IN_FORCE_UNSPECIFIED to remain unchanged.
orderCancellation object
marketId string
Market ID for the order, required field.
orderId string
Unique ID for the order. This is set by the system after consensus. Required field.
orderSubmission object
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
partyId Unique party ID for the related party
proposal object
rationale object
Rationale behind a proposal.
description string
Description to show a short title / something in case the link goes offline. This is to be between 0 and 20k unicode characters. This is mandatory for all proposals.
title string
Title to be used to give a short description of the proposal in lists. This is to be between 0 and 100 unicode characters. This is mandatory for all proposals.
reference string
Reference identifying the proposal.
terms object
Proposal configuration and the actual change that is meant to be executed when proposal is enacted.
cancelTransfer object
Cancel a governance transfer.
changes object
transferId string
ID of the governance transfer proposal.
closingTimestamp int64
Timestamp as Unix time in seconds when voting closes for this proposal, constrained by minClose and maxClose network parameters.
enactmentTimestamp int64
Timestamp as Unix time in seconds when proposal gets enacted if passed, constrained by minEnact and maxEnact network parameters.
newAsset object
Proposal change for creating new assets on Vega.
changes object
Configuration of the new asset.
builtinAsset object
Vega built-in asset.
maxFaucetAmountMint string
Maximum amount that can be requested by a party through the built-in asset faucet at a time.
decimals uint64
Number of decimal / precision handled by this asset.
erc20 object
Ethereum ERC20 asset.
contractAddress string
Address of the contract for the token, on the ethereum network.
lifetimeLimit string
Lifetime limits deposit per address note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
name string
Name of the asset (e.g: Great British Pound).
quantum string
Minimum economically meaningful amount in the asset.
symbol string
Symbol of the asset (e.g: GBP).
newFreeform object
Proposal change for a freeform request, which can be voted on but does not change the behaviour of the system, and can be used to gauge community sentiment.
newMarket object
Proposal change for creating new futures market on Vega.
changes object
Configuration of the new market.
decimalPlaces uint64
Decimal places used for the new futures market, sets the smallest price increment on the book.
instrument object
New futures market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Product quote name.
settlementAsset string
Asset ID for the product's settlement asset.
name string
Instrument name.
spot object
Spot.
baseAsset string
Base asset ID.
name string
Product name.
quoteAsset string
Quote asset ID.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
Liquidity monitoring parameters.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
metadata string[]
Optional new futures market metadata, tags.
positionDecimalPlaces int64
Decimal places for order sizes, sets what size the smallest order / position on the futures market can be.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
successor object
Successor configuration. If this proposal is meant to succeed a given market, then this should be set.
insurancePoolFraction string
A decimal value between or equal to 0 and 1, specifying the fraction of the insurance pool balance that is carried over from the parent market to the successor.
parentMarketId string
ID of the market that the successor should take over from.
newSpotMarket object
Proposal change for creating new spot market on Vega.
changes object
Configuration of the new spot market.
decimalPlaces uint64
Decimal places used for the new spot market, sets the smallest price increment on the book.
instrument object
New spot market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Product quote name.
settlementAsset string
Asset ID for the product's settlement asset.
name string
Instrument name.
spot object
Spot.
baseAsset string
Base asset ID.
name string
Product name.
quoteAsset string
Quote asset ID.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
metadata string[]
Optional new spot market metadata, tags.
positionDecimalPlaces int64
Decimal places for order sizes, sets what size the smallest order / position on the spot market can be.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
newTransfer object
Proposal change for a governance transfer.
changes object
Configuration for a new transfer.
amount Maximum amount to transfer
asset ID of asset to transfer
destination Specifies the account to transfer to, depending on the account type: Network treasury: leave empty Party: party's public key Market insurance pool: market ID
destinationType Specifies the account type to transfer to: reward pool, party, network insurance pool, market insurance pool
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
fractionOfBalance Maximum fraction of the source account's balance to transfer as a decimal - i.e. 0.1 = 10% of the balance
oneOff object
deliverOn int64
Timestamp in Unix nanoseconds for when the transfer should be delivered into the receiver's account.
recurring object
endEpoch uint64
Last epoch at which this transfer shall be paid.
startEpoch uint64
First epoch from which this transfer shall be paid.
source If network treasury, field is empty, otherwise uses the market ID
sourceType Source account type, such as network treasury, market insurance pool
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
transferType "All or nothing" or "best effort": All or nothing: Transfers the specified amount or does not transfer anything Best effort: Transfers the specified amount or the max allowable amount if this is less than the specified amount
Possible values: [GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED, GOVERNANCE_TRANSFER_TYPE_ALL_OR_NOTHING, GOVERNANCE_TRANSFER_TYPE_BEST_EFFORT]
Default value: GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED
updateAsset object
Proposal change for updating an asset.
assetId string
Asset ID the update is for.
changes object
Changes to apply on an existing asset.
erc20 object
Ethereum ERC20 asset update.
lifetimeLimit string
Lifetime limits deposit per address. This will be interpreted against the asset decimals. note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
quantum string
Minimum economically meaningful amount in the asset.
updateMarket object
Proposal change for modifying an existing futures market on Vega.
changes object
Updated configuration of the futures market.
instrument object
Updated futures market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
The binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Human-readable name/abbreviation of the quote name.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
Liquidity monitoring parameters.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
metadata string[]
Optional futures market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
marketId string
Market ID the update is for.
updateNetworkParameter object
Proposal change for updating Vega network parameters.
changes object
The network parameter to update.
key string
Unique key of the network parameter.
value string
Value for the network parameter.
updateSpotMarket object
Proposal change for modifying an existing spot market on Vega.
changes object
Updated configuration of the spot market.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
metadata string[]
Optional spot market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
marketId string
Market ID the update is for.
validationTimestamp int64
Validation timestamp as Unix time in seconds.
protocolUpgradeProposal object
upgradeBlockHeight uint64
Block height at which to perform the upgrade.
vegaReleaseTag string
Release tag for the Vega binary.
status boolean
Status of the transaction, did it succeed or an error was raised.
stopOrderCancellation object
marketId string
Optional market ID.
stopOrderId string
Optional order ID.
stopOrderSubmission object
fallsBelow object
Stop order that will be triggered if the price falls below a given trigger price.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
orderSubmission object
Order to be submitted once the trigger is breached.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
price string
Fixed price at which the order will be submitted.
trailingPercentOffset string
Trailing percentage at which the order will be submitted.
risesAbove object
Stop order that will be triggered if the price rises above a given trigger price.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
orderSubmission object
Order to be submitted once the trigger is breached.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
price string
Fixed price at which the order will be submitted.
trailingPercentOffset string
Trailing percentage at which the order will be submitted.
success object
transfer object
amount string
Amount to be taken from the source account. This field is an unsigned integer scaled to the asset's decimal places.
asset string
Asset ID of the asset to be transferred.
fromAccountType Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type from which the funds of the party should be taken.
oneOff object
deliverOn int64
Timestamp in Unix nanoseconds for when the transfer should be delivered into the receiver's account.
recurring object
dispatchStrategy object
Optional parameter defining how a transfer is dispatched.
assetForMetric string
Asset to use for metric.
markets string[]
Optional markets in scope.
metric - DISPATCH_METRIC_MAKER_FEES_PAID: Dispatch metric that is using the total maker fees paid in the market - DISPATCH_METRIC_MAKER_FEES_RECEIVED: Dispatch metric that is using the total maker fees received in the market - DISPATCH_METRIC_LP_FEES_RECEIVED: Dispatch metric that is using the total LP fees received in the market - DISPATCH_METRIC_MARKET_VALUE: Dispatch metric that is using total value of the market if above the required threshold and not paid given proposer bonus yet
Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE]
Default value: DISPATCH_METRIC_UNSPECIFIED
Metric to apply.
endEpoch uint64
Last epoch at which this transfer shall be paid.
factor string
Factor needs to be > 0.
startEpoch uint64
First epoch from which this transfer shall be paid.
reference string
Reference to be attached to the transfer.
to string
Public key of the destination account.
toAccountType Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Type of the destination account.
undelegateSubmission object
amount string
Optional, if not specified = ALL. If provided, this field must be an unsigned integer passed as a string and needs to be scaled using the asset decimal places for the token.
method UndelegateSubmissionMethod
Possible values: [METHOD_UNSPECIFIED, METHOD_NOW, METHOD_AT_END_OF_EPOCH]
Default value: METHOD_UNSPECIFIED
Method of delegation.
nodeId string
Node ID to delegate to.
voteSubmission object
Command to submit a new vote for a governance proposal.
proposalId string
Submit vote for the specified proposal ID.
value Vote value
Possible values: [VALUE_UNSPECIFIED, VALUE_NO, VALUE_YES]
Default value: VALUE_UNSPECIFIED
Actual value of the vote.
withdrawSubmission object
amount string
Amount to be withdrawn. This field is an unsigned integer scaled to the asset's decimal places.
asset string
Asset to be withdrawn.
ext object
Foreign chain specifics.
erc20 object
ERC20 withdrawal details.
receiverAddress string
Address into which the bridge will release the funds.
transfer object
amount string
asset string
from string
fromAccountType Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
id string
oneOff object
deliverOn int64
oneOffGovernance object
deliverOn int64
reason string
recurring object
dispatchStrategy object
assetForMetric string
Asset to use for metric.
markets string[]
Optional markets in scope.
metric - DISPATCH_METRIC_MAKER_FEES_PAID: Dispatch metric that is using the total maker fees paid in the market - DISPATCH_METRIC_MAKER_FEES_RECEIVED: Dispatch metric that is using the total maker fees received in the market - DISPATCH_METRIC_LP_FEES_RECEIVED: Dispatch metric that is using the total LP fees received in the market - DISPATCH_METRIC_MARKET_VALUE: Dispatch metric that is using total value of the market if above the required threshold and not paid given proposer bonus yet
Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE]
Default value: DISPATCH_METRIC_UNSPECIFIED
Metric to apply.
endEpoch uint64
factor string
startEpoch uint64
recurringGovernance object
endEpoch uint64
startEpoch uint64
reference string
status - STATUS_UNSPECIFIED: Default value - STATUS_PENDING: Indicates a transfer still being processed - STATUS_DONE: Indicates a transfer accepted by the Vega network - STATUS_REJECTED: Indicates a transfer rejected by the Vega network - STATUS_STOPPED: Indicates a transfer stopped by the Vega network e.g: no funds left to cover the transfer - STATUS_CANCELLED: Indicates a transfer cancelled by the user
Possible values: [STATUS_UNSPECIFIED, STATUS_PENDING, STATUS_DONE, STATUS_REJECTED, STATUS_STOPPED, STATUS_CANCELLED]
Default value: STATUS_UNSPECIFIED
timestamp int64
to string
toAccountType Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
txErrEvent object
announceNode object
avatarUrl string
AvatarURL of the validator.
chainPubKey string
Public key for the blockchain, required field.
country string
Country code (ISO 3166-1 alpha-2) for the location of the node.
ethereumAddress string
Ethereum public key, required field.
ethereumSignature object
Signature from the validator made using the ethereum wallet.
algo string
Algorithm used to create the signature.
value string
Hex encoded bytes of the signature.
version int64
Version of the signature used to create the signature.
fromEpoch uint64
Epoch from which the validator is expected to be ready to validate blocks.
id string
Node ID of the validator, i.e. the node's public master key.
infoUrl string
URL with more info on the node.
name string
Name of the validator.
submitterAddress string
Ethereum public key to use as a submitter to allow automatic signature generation.
vegaPubKey string
Vega public key, required field.
vegaPubKeyIndex int64
Vega public key derivation index.
vegaSignature object
Signature from the validator made using the Vega wallet.
algo string
Algorithm used to create the signature.
value string
Hex encoded bytes of the signature.
version int64
Version of the signature used to create the signature.
batchMarketInstructions object
amendments object[]
List of order amendments to be processed sequentially.
Array [
expiresAt int64
Amend the expiry time for the order, if the Timestamp value is set, otherwise expiry time will remain unchanged.
marketId string
Market ID, this is required to find the order and will not be updated.
orderId string
Order ID, this is required to find the order and will not be updated, required field.
peggedOffset string
Amend the pegged order offset for the order. This field is an unsigned integer scaled to the market's decimal places.
peggedReference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Amend the pegged order reference for the order.
price string
Amend the price for the order if the price value is set, otherwise price will remain unchanged. This field is an unsigned integer scaled to the market's decimal places.
sizeDelta int64
Amend the size for the order by the delta specified:
• To reduce the size from the current value set a negative integer value
• To increase the size from the current value, set a positive integer value
• To leave the size unchanged set a value of zero This field needs to be scaled using the market's position decimal places.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Amend the time in force for the order, set to TIME_IN_FORCE_UNSPECIFIED to remain unchanged.
]
cancellations object[]
List of order cancellations to be processed sequentially.
Array [
marketId string
Market ID for the order, required field.
orderId string
Unique ID for the order. This is set by the system after consensus. Required field.
]
stopOrdersCancellation object[]
List of stop order cancellations to be processed sequentially.
Array [
marketId string
Optional market ID.
stopOrderId string
Optional order ID.
]
stopOrdersSubmission object[]
List of stop order submissions to be processed sequentially.
Array [
fallsBelow object
Stop order that will be triggered if the price falls below a given trigger price.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
orderSubmission object
Order to be submitted once the trigger is breached.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
price string
Fixed price at which the order will be submitted.
trailingPercentOffset string
Trailing percentage at which the order will be submitted.
risesAbove object
Stop order that will be triggered if the price rises above a given trigger price.
expiresAt int64
Optional expiry timestamp.
expiryStrategy StopOrderExpiryStrategy
Possible values: [EXPIRY_STRATEGY_UNSPECIFIED, EXPIRY_STRATEGY_CANCELS, EXPIRY_STRATEGY_SUBMIT]
Default value: EXPIRY_STRATEGY_UNSPECIFIED
Strategy to adopt if the expiry time is reached.
orderSubmission object
Order to be submitted once the trigger is breached.
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
price string
Fixed price at which the order will be submitted.
trailingPercentOffset string
Trailing percentage at which the order will be submitted.
]
submissions object[]
List of order submissions to be processed sequentially.
Array [
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
]
cancelTransfer object
transferId string
Transfer ID of the transfer to cancel.
delegateSubmission object
amount string
Amount of stake to delegate. This field is an unsigned integer scaled to the asset's decimal places.
nodeId string
Delegate to the specified node ID.
errMsg Error message describing what went wrong
issueSignatures object
kind Kind of signature created by a node, for example, allow-listing a new asset, withdrawal etc
Possible values: [NODE_SIGNATURE_KIND_UNSPECIFIED, NODE_SIGNATURE_KIND_ASSET_NEW, NODE_SIGNATURE_KIND_ASSET_WITHDRAWAL, NODE_SIGNATURE_KIND_ERC20_MULTISIG_SIGNER_ADDED, NODE_SIGNATURE_KIND_ERC20_MULTISIG_SIGNER_REMOVED, NODE_SIGNATURE_KIND_ASSET_UPDATE]
Default value: NODE_SIGNATURE_KIND_UNSPECIFIED
What kind of signatures to generate, namely for whether a signer is being added or removed.
submitter string
Ethereum address which will submit the signatures to the smart contract.
validatorNodeId string
Node ID of the validator node that will be signed in or out of the smart contract.
liquidityProvisionAmendment object
buys object[]
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
commitmentAmount string
From here at least one of the following is required to consider the command valid.
fee string
marketId string
Unique ID for the market with the liquidity provision to be amended.
reference string
sells object[]
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
liquidityProvisionCancellation object
marketId string
Unique ID for the market with the liquidity provision to be cancelled.
liquidityProvisionSubmission object
buys object[]
Set of liquidity buy orders to meet the liquidity provision obligation.
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
commitmentAmount string
Specified as a unitless number that represents the amount of settlement asset of the market. This field is an unsigned integer scaled using the asset's decimal places.
fee string
Nominated liquidity fee factor, which is an input to the calculation of taker fees on the market, as per setting fees and rewarding liquidity providers.
marketId string
Market ID for the order.
reference string
Reference to be added to every order created out of this liquidity provision submission.
sells object[]
Set of liquidity sell orders to meet the liquidity provision obligation.
Array [
offset string
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
proportion int64
Relative proportion of the commitment to be allocated at a price level.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Pegged reference point for the order.
]
oracleDataSubmission object
payload byte
Data provided by the data source In the case of Open Oracle - it will be the entire object - it will contain messages, signatures and price data.
source Supported oracle sources
Possible values: [ORACLE_SOURCE_UNSPECIFIED, ORACLE_SOURCE_OPEN_ORACLE, ORACLE_SOURCE_JSON]
Default value: ORACLE_SOURCE_UNSPECIFIED
Source from which the data is coming from. Must be base64 encoded. Oracle data is a type of external data source data.
orderAmendment object
expiresAt int64
Amend the expiry time for the order, if the Timestamp value is set, otherwise expiry time will remain unchanged.
marketId string
Market ID, this is required to find the order and will not be updated.
orderId string
Order ID, this is required to find the order and will not be updated, required field.
peggedOffset string
Amend the pegged order offset for the order. This field is an unsigned integer scaled to the market's decimal places.
peggedReference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Amend the pegged order reference for the order.
price string
Amend the price for the order if the price value is set, otherwise price will remain unchanged. This field is an unsigned integer scaled to the market's decimal places.
sizeDelta int64
Amend the size for the order by the delta specified:
• To reduce the size from the current value set a negative integer value
• To increase the size from the current value, set a positive integer value
• To leave the size unchanged set a value of zero This field needs to be scaled using the market's position decimal places.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Amend the time in force for the order, set to TIME_IN_FORCE_UNSPECIFIED to remain unchanged.
orderCancellation object
marketId string
Market ID for the order, required field.
orderId string
Unique ID for the order. This is set by the system after consensus. Required field.
orderSubmission object
expiresAt int64
Timestamp in Unix nanoseconds for when the order will expire, required field only for Order.TimeInForce.TIME_IN_FORCE_GTT`.
icebergOpts object
Parameters used to specify an iceberg order.
minimumVisibleSize uint64
Minimum allowed remaining size of the order before it is replenished back to its peak size.
peakSize uint64
Size of the order that is made visible and can be traded with during the execution of a single order.
marketId string
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
offset string
Offset from the price reference.
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
Default value: PEGGED_REFERENCE_UNSPECIFIED
Price point the order is linked to.
postOnly boolean
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
price string
Price for the order, the price is an integer, for example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places, required field for limit orders, however it is not required for market orders. This field is an unsigned integer scaled to the market's decimal places.
reduceOnly boolean
Only valid for Non-Persistent orders. Cannot be True at the same time as Post-Only. If set, order will only be executed if the outcome of the trade moves the trader's position closer to 0.
reference string
Reference given for the order, this is typically used to retrieve an order submitted through consensus, currently set internally by the node to return a unique reference ID for the order submission.
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
Default value: SIDE_UNSPECIFIED
Side for the order, e.g. SIDE_BUY or SIDE_SELL, required field.
size uint64
Size for the order, for example, in a futures market the size equals the number of units, cannot be negative.
timeInForce Time In Force for an order
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
Default value: TIME_IN_FORCE_UNSPECIFIED
Time in force indicates how long an order will remain active before it is executed or expires, required field.
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
partyId Unique party ID for the related party
proposal object
rationale object
Rationale behind a proposal.
description string
Description to show a short title / something in case the link goes offline. This is to be between 0 and 20k unicode characters. This is mandatory for all proposals.
title string
Title to be used to give a short description of the proposal in lists. This is to be between 0 and 100 unicode characters. This is mandatory for all proposals.
reference string
Reference identifying the proposal.
terms object
Proposal configuration and the actual change that is meant to be executed when proposal is enacted.
cancelTransfer object
Cancel a governance transfer.
changes object
transferId string
ID of the governance transfer proposal.
closingTimestamp int64
Timestamp as Unix time in seconds when voting closes for this proposal, constrained by minClose and maxClose network parameters.
enactmentTimestamp int64
Timestamp as Unix time in seconds when proposal gets enacted if passed, constrained by minEnact and maxEnact network parameters.
newAsset object
Proposal change for creating new assets on Vega.
changes object
Configuration of the new asset.
builtinAsset object
Vega built-in asset.
maxFaucetAmountMint string
Maximum amount that can be requested by a party through the built-in asset faucet at a time.
decimals uint64
Number of decimal / precision handled by this asset.
erc20 object
Ethereum ERC20 asset.
contractAddress string
Address of the contract for the token, on the ethereum network.
lifetimeLimit string
Lifetime limits deposit per address note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
name string
Name of the asset (e.g: Great British Pound).
quantum string
Minimum economically meaningful amount in the asset.
symbol string
Symbol of the asset (e.g: GBP).
newFreeform object
Proposal change for a freeform request, which can be voted on but does not change the behaviour of the system, and can be used to gauge community sentiment.
newMarket object
Proposal change for creating new futures market on Vega.
changes object
Configuration of the new market.
decimalPlaces uint64
Decimal places used for the new futures market, sets the smallest price increment on the book.
instrument object
New futures market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Product quote name.
settlementAsset string
Asset ID for the product's settlement asset.
name string
Instrument name.
spot object
Spot.
baseAsset string
Base asset ID.
name string
Product name.
quoteAsset string
Quote asset ID.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
Liquidity monitoring parameters.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
metadata string[]
Optional new futures market metadata, tags.
positionDecimalPlaces int64
Decimal places for order sizes, sets what size the smallest order / position on the futures market can be.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
successor object
Successor configuration. If this proposal is meant to succeed a given market, then this should be set.
insurancePoolFraction string
A decimal value between or equal to 0 and 1, specifying the fraction of the insurance pool balance that is carried over from the parent market to the successor.
parentMarketId string
ID of the market that the successor should take over from.
newSpotMarket object
Proposal change for creating new spot market on Vega.
changes object
Configuration of the new spot market.
decimalPlaces uint64
Decimal places used for the new spot market, sets the smallest price increment on the book.
instrument object
New spot market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
Binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Product quote name.
settlementAsset string
Asset ID for the product's settlement asset.
name string
Instrument name.
spot object
Spot.
baseAsset string
Base asset ID.
name string
Product name.
quoteAsset string
Quote asset ID.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
metadata string[]
Optional new spot market metadata, tags.
positionDecimalPlaces int64
Decimal places for order sizes, sets what size the smallest order / position on the spot market can be.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
newTransfer object
Proposal change for a governance transfer.
changes object
Configuration for a new transfer.
amount Maximum amount to transfer
asset ID of asset to transfer
destination Specifies the account to transfer to, depending on the account type: Network treasury: leave empty Party: party's public key Market insurance pool: market ID
destinationType Specifies the account type to transfer to: reward pool, party, network insurance pool, market insurance pool
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
fractionOfBalance Maximum fraction of the source account's balance to transfer as a decimal - i.e. 0.1 = 10% of the balance
oneOff object
deliverOn int64
Timestamp in Unix nanoseconds for when the transfer should be delivered into the receiver's account.
recurring object
endEpoch uint64
Last epoch at which this transfer shall be paid.
startEpoch uint64
First epoch from which this transfer shall be paid.
source If network treasury, field is empty, otherwise uses the market ID
sourceType Source account type, such as network treasury, market insurance pool
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
• ACCOUNT_TYPE_UNSPECIFIED: Default value
• ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
• ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
• ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
Margin account funds will vary as margin requirements on positions change
• ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
• ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
• ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
• ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
• ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
• ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
• ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
• ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
• ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
• ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
• ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
• ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
• ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
• ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
• ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
• ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
transferType "All or nothing" or "best effort": All or nothing: Transfers the specified amount or does not transfer anything Best effort: Transfers the specified amount or the max allowable amount if this is less than the specified amount
Possible values: [GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED, GOVERNANCE_TRANSFER_TYPE_ALL_OR_NOTHING, GOVERNANCE_TRANSFER_TYPE_BEST_EFFORT]
Default value: GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED
updateAsset object
Proposal change for updating an asset.
assetId string
Asset ID the update is for.
changes object
Changes to apply on an existing asset.
erc20 object
Ethereum ERC20 asset update.
lifetimeLimit string
Lifetime limits deposit per address. This will be interpreted against the asset decimals. note: this is a temporary measure that can be changed by governance.
withdrawThreshold string
Maximum you can withdraw instantly. All withdrawals over the threshold will be delayed by the withdrawal delay. There’s no limit on the size of a withdrawal note: this is a temporary measure that can be changed by governance.
quantum string
Minimum economically meaningful amount in the asset.
updateMarket object
Proposal change for modifying an existing futures market on Vega.
changes object
Updated configuration of the futures market.
instrument object
Updated futures market instrument configuration.
code string
Instrument code, human-readable shortcode used to describe the instrument.
future object
Future.
dataSourceSpecBinding object
The binding between the data source spec and the settlement data.
settlementDataProperty string
Name of the property in the source data that should be used as settlement data. If it is set to "prices.BTC.value", then the Future will use the value of this property as settlement data.
tradingTerminationProperty string
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
dataSourceSpecForTradingTermination object
DataSourceDefinition represents the top level object that deals with data sources. DataSourceDefinition can be external or internal, with whatever number of data sources are defined for each type in the child objects below.
external object
DataSourceDefinitionExternal is the top level object used for all external data sources. It contains one of any of the defined SourceType variants.
ethCall object
Specifies a data source that derives its content from calling a read method on an Ethereum contract.
abi object[]
The ABI of that contract.
address string
Ethereum address of the contract to call.
args object[]
List of arguments to pass to method call. Protobuf 'Value' wraps an arbitrary JSON type that is mapped to an Ethereum type according to the ABI.
method string
Name of the method on the contract to call.
trigger object
Conditions for determining when to call the contract method.
timeTrigger object
Trigger for an Ethereum call based on the Ethereum block timestamp. Can be one-off or repeating.
every uint64
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
initial uint64
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
until uint64
If repeating, stop once Ethereum time is greater than this time, in Unix seconds. If not set, then repeat indefinitely.
oracle object
All types of external data sources use the same configuration set for meeting requirements in order for the data to be useful for Vega - valid signatures and matching filters.
filters object[]
Filters describes which source data are considered of interest or not for the product (or the risk model).
Array [
conditions object[]
Conditions that should be matched by the data to be considered of interest.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
key object
Data source's data property key targeted by the filter.
name string
Name of the property.
numberDecimalPlaces uint64
type v1PropertyKeyType
Possible values: [TYPE_UNSPECIFIED, TYPE_EMPTY, TYPE_INTEGER, TYPE_STRING, TYPE_BOOLEAN, TYPE_DECIMAL, TYPE_TIMESTAMP]
Default value: TYPE_UNSPECIFIED
Data type of the property.
]
signers object[]
Signers is the list of authorized signatures that signed the data for this source. All the signatures in the data source data should be contained in this external source. All the signatures in the data should be contained in this list.
Array [
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
address string
pubKey object
List of authorized public keys that signed the data for this source. All the public keys in the data should be contained in these public keys.
key string
]
internal object
DataSourceDefinitionInternal is the top level object used for all internal data sources. It contains one of any of the defined SourceType variants.
time object
DataSourceSpecConfigurationTime is the internal data source used for emitting timestamps.
conditions object[]
Conditions that the timestamps should meet in order to be considered.
Array [
operator ConditionOperator
Possible values: [OPERATOR_UNSPECIFIED, OPERATOR_EQUALS, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL]
Default value: OPERATOR_UNSPECIFIED
Type of comparison to make on the value.
value string
Value to be compared with by the operator.
]
quoteName string
Human-readable name/abbreviation of the quote name.
linearSlippageFactor string
Linear slippage factor is used to cap the slippage component of maintenance margin - it is applied to the slippage volume.
liquidityMonitoringParameters object
Liquidity monitoring parameters.
auctionExtension int64
Specifies by how many seconds an auction should be extended if leaving the auction were to trigger a liquidity auction.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
triggeringRatio string
Specifies the triggering ratio for entering liquidity auction.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
lpPriceRange string
Percentage move up and down from the mid price which specifies the range of price levels over which automated liquidity provision orders will be deployed.
metadata string[]
Optional futures market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
quadraticSlippageFactor string
Quadratic slippage factor is used to cap the slippage component of maintenance margin - it is applied to the square of the slippage volume.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
marketId string
Market ID the update is for.
updateNetworkParameter object
Proposal change for updating Vega network parameters.
changes object
The network parameter to update.
key string
Unique key of the network parameter.
value string
Value for the network parameter.
updateSpotMarket object
Proposal change for modifying an existing spot market on Vega.
changes object
Updated configuration of the spot market.
logNormal object
Log normal risk model parameters, valid only if MODEL_LOG_NORMAL is selected.
params object
Risk model parameters for log normal.
mu double
Mu parameter, annualised growth rate of the underlying asset.
r double
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
sigma double
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
riskAversionParameter double
Risk Aversion Parameter.
tau double
Tau parameter of the risk model, projection horizon measured as a year fraction used in the expected shortfall calculation to obtain the maintenance margin, must be a strictly non-negative real number.
metadata string[]
Optional spot market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Array [
auctionExtension int64
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
horizon int64
Price monitoring projection horizon τ in seconds.
probability string
Price monitoring probability level p.
]
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
factorLong double
Pre-defined risk factor value for long.
factorShort double
Pre-defined risk factor value for short.
maxMoveUp double
Pre-defined maximum price move up that the model considers as valid.
minMoveDown double
Pre-defined minimum price move down that the model considers as valid.
probabilityOfTrading double
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
scalingFactor double
Specifies scaling factors used in target stake calculation.
timeWindow int64
Specifies length of time window expressed in seconds for target stake calculation.
marketId string
Market ID the update is for.
validationTimestamp int64
Validation timestamp as Unix time in seconds.
protocolUpgradeProposal object
upgradeBlockHeight uint64
Block height at which to perform the upgrade.
vegaReleaseTag string
Release tag for the Vega binary.
transfer object
amount string
Amount to be taken from the source account. This field is an unsigned integer scaled to the asset's decimal places.
asset string
Asset ID of the asset to be transferred.
fromAccountType Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Account type from which the funds of the party should be taken.
oneOff object
deliverOn int64
Timestamp in Unix nanoseconds for when the transfer should be delivered into the receiver's account.
recurring object
dispatchStrategy object
Optional parameter defining how a transfer is dispatched.
assetForMetric string
Asset to use for metric.
markets string[]
Optional markets in scope.
metric - DISPATCH_METRIC_MAKER_FEES_PAID: Dispatch metric that is using the total maker fees paid in the market - DISPATCH_METRIC_MAKER_FEES_RECEIVED: Dispatch metric that is using the total maker fees received in the market - DISPATCH_METRIC_LP_FEES_RECEIVED: Dispatch metric that is using the total LP fees received in the market - DISPATCH_METRIC_MARKET_VALUE: Dispatch metric that is using total value of the market if above the required threshold and not paid given proposer bonus yet
Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE]
Default value: DISPATCH_METRIC_UNSPECIFIED
Metric to apply.
endEpoch uint64
Last epoch at which this transfer shall be paid.
factor string
Factor needs to be > 0.
startEpoch uint64
First epoch from which this transfer shall be paid.
reference string
Reference to be attached to the transfer.
to string
Public key of the destination account.
toAccountType Various collateral/account types as used by Vega
Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION]
Default value: ACCOUNT_TYPE_UNSPECIFIED
Type of the destination account.
undelegateSubmission object
amount string
Optional, if not specified = ALL. If provided, this field must be an unsigned integer passed as a string and needs to be scaled using the asset decimal places for the token.
method UndelegateSubmissionMethod
Possible values: [METHOD_UNSPECIFIED, METHOD_NOW, METHOD_AT_END_OF_EPOCH]
Default value: METHOD_UNSPECIFIED
Method of delegation.
nodeId string
Node ID to delegate to.
voteSubmission object
Command to submit a new vote for a governance proposal.
proposalId string
Submit vote for the specified proposal ID.
value Vote value
Possible values: [VALUE_UNSPECIFIED, VALUE_NO, VALUE_YES]
Default value: VALUE_UNSPECIFIED
Actual value of the vote.
withdrawSubmission object
amount string
Amount to be withdrawn. This field is an unsigned integer scaled to the asset's decimal places.
asset string
Asset to be withdrawn.
ext object
Foreign chain specifics.
erc20 object
ERC20 withdrawal details.
receiverAddress string
Address into which the bridge will release the funds.
txHash string
type The type of bus event. Must be one of the list below:
Possible values: [BUS_EVENT_TYPE_UNSPECIFIED, BUS_EVENT_TYPE_ALL, BUS_EVENT_TYPE_TIME_UPDATE, BUS_EVENT_TYPE_LEDGER_MOVEMENTS, BUS_EVENT_TYPE_POSITION_RESOLUTION, BUS_EVENT_TYPE_ORDER, BUS_EVENT_TYPE_ACCOUNT, BUS_EVENT_TYPE_PARTY, BUS_EVENT_TYPE_TRADE, BUS_EVENT_TYPE_MARGIN_LEVELS, BUS_EVENT_TYPE_PROPOSAL, BUS_EVENT_TYPE_VOTE, BUS_EVENT_TYPE_MARKET_DATA, BUS_EVENT_TYPE_NODE_SIGNATURE, BUS_EVENT_TYPE_LOSS_SOCIALIZATION, BUS_EVENT_TYPE_SETTLE_POSITION, BUS_EVENT_TYPE_SETTLE_DISTRESSED, BUS_EVENT_TYPE_MARKET_CREATED, BUS_EVENT_TYPE_ASSET, BUS_EVENT_TYPE_MARKET_TICK, BUS_EVENT_TYPE_WITHDRAWAL, BUS_EVENT_TYPE_DEPOSIT, BUS_EVENT_TYPE_AUCTION, BUS_EVENT_TYPE_RISK_FACTOR, BUS_EVENT_TYPE_NETWORK_PARAMETER, BUS_EVENT_TYPE_LIQUIDITY_PROVISION, BUS_EVENT_TYPE_MARKET_UPDATED, BUS_EVENT_TYPE_ORACLE_SPEC, BUS_EVENT_TYPE_ORACLE_DATA, BUS_EVENT_TYPE_DELEGATION_BALANCE, BUS_EVENT_TYPE_VALIDATOR_SCORE, BUS_EVENT_TYPE_EPOCH_UPDATE, BUS_EVENT_TYPE_VALIDATOR_UPDATE, BUS_EVENT_TYPE_STAKE_LINKING, BUS_EVENT_TYPE_REWARD_PAYOUT_EVENT, BUS_EVENT_TYPE_CHECKPOINT, BUS_EVENT_TYPE_STREAM_START, BUS_EVENT_TYPE_KEY_ROTATION, BUS_EVENT_TYPE_STATE_VAR, BUS_EVENT_TYPE_NETWORK_LIMITS, BUS_EVENT_TYPE_TRANSFER, BUS_EVENT_TYPE_VALIDATOR_RANKING, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_EVENT, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SET_THRESHOLD, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_ADDED, BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_REMOVED, BUS_EVENT_TYPE_POSITION_STATE, BUS_EVENT_TYPE_ETHEREUM_KEY_ROTATION, BUS_EVENT_TYPE_PROTOCOL_UPGRADE_PROPOSAL, BUS_EVENT_TYPE_BEGIN_BLOCK, BUS_EVENT_TYPE_END_BLOCK, BUS_EVENT_TYPE_PROTOCOL_UPGRADE_STARTED, BUS_EVENT_TYPE_SETTLE_MARKET, BUS_EVENT_TYPE_TRANSACTION_RESULT, BUS_EVENT_TYPE_SNAPSHOT_TAKEN, BUS_EVENT_TYPE_PROTOCOL_UPGRADE_DATA_NODE_READY, BUS_EVENT_TYPE_DISTRESSED_ORDERS_CLOSED, BUS_EVENT_TYPE_EXPIRED_ORDERS, BUS_EVENT_TYPE_DISTRESSED_POSITIONS, BUS_EVENT_TYPE_SPOT_LIQUIDITY_PROVISION, BUS_EVENT_TYPE_STOP_ORDER, BUS_EVENT_TYPE_MARKET, BUS_EVENT_TYPE_TX_ERROR]
Default value: BUS_EVENT_TYPE_UNSPECIFIED
• BUS_EVENT_TYPE_UNSPECIFIED: Default value, always invalid
• BUS_EVENT_TYPE_ALL: Events of ALL event types, used when filtering stream from event bus
• BUS_EVENT_TYPE_TIME_UPDATE: Event for blockchain time updates
• BUS_EVENT_TYPE_LEDGER_MOVEMENTS: Event for when a transfer happens internally, contains the transfer information
• BUS_EVENT_TYPE_POSITION_RESOLUTION: Event indicating position resolution has occurred
• BUS_EVENT_TYPE_ORDER: Event for order updates, both new and existing orders
• BUS_EVENT_TYPE_ACCOUNT: Event for account updates
• BUS_EVENT_TYPE_PARTY: Event for party updates
• BUS_EVENT_TYPE_TRADE: Event indicating a new trade has occurred
• BUS_EVENT_TYPE_MARGIN_LEVELS: Event indicating margin levels have changed for a party
• BUS_EVENT_TYPE_PROPOSAL: Event for proposal updates (for governance)
• BUS_EVENT_TYPE_VOTE: Event indicating a new vote has occurred (for governance)
• BUS_EVENT_TYPE_MARKET_DATA: Event for market data updates
• BUS_EVENT_TYPE_NODE_SIGNATURE: Event for a new signature for a Vega node
• BUS_EVENT_TYPE_LOSS_SOCIALIZATION: Event indicating loss socialisation occurred for a party
• BUS_EVENT_TYPE_SETTLE_POSITION: Event for when a position is being settled
• BUS_EVENT_TYPE_SETTLE_DISTRESSED: Event for when a position is distressed
• BUS_EVENT_TYPE_MARKET_CREATED: Event indicating a new market was created
• BUS_EVENT_TYPE_ASSET: Event for when an asset is added to Vega
• BUS_EVENT_TYPE_MARKET_TICK: Event indicating a market tick event
• BUS_EVENT_TYPE_WITHDRAWAL: Event for when a withdrawal occurs
• BUS_EVENT_TYPE_DEPOSIT: Event for when a deposit occurs
• BUS_EVENT_TYPE_AUCTION: Event indicating a change in auction state, for example starting or ending an auction
• BUS_EVENT_TYPE_RISK_FACTOR: Event indicating a risk factor has been updated
• BUS_EVENT_TYPE_NETWORK_PARAMETER: Event indicating a network parameter has been added or updated
• BUS_EVENT_TYPE_LIQUIDITY_PROVISION: Event indicating a liquidity provision has been created or updated
• BUS_EVENT_TYPE_MARKET_UPDATED: Event indicating a new market was created
• BUS_EVENT_TYPE_ORACLE_SPEC: Event indicating an oracle spec has been created or updated
• BUS_EVENT_TYPE_ORACLE_DATA: Event indicating that an oracle data has been broadcast
• BUS_EVENT_TYPE_DELEGATION_BALANCE: Event indicating that an delegation balance of a party to a node for current epoch has changed
• BUS_EVENT_TYPE_VALIDATOR_SCORE: Event indicating the validator score for the given epoch
• BUS_EVENT_TYPE_EPOCH_UPDATE: Event indicating the start or end of an epoch
• BUS_EVENT_TYPE_VALIDATOR_UPDATE: Event indicating that validator node has been updated
• BUS_EVENT_TYPE_STAKE_LINKING: Event indicating a new staking event have been processed by the network
• BUS_EVENT_TYPE_REWARD_PAYOUT_EVENT: Event indicating the payout of a reward has been initiated
• BUS_EVENT_TYPE_CHECKPOINT: Event indicating a new checkpoint was created
• BUS_EVENT_TYPE_STREAM_START: Event indicating stream is starting
• BUS_EVENT_TYPE_KEY_ROTATION: Event indicating key rotation took place
• BUS_EVENT_TYPE_STATE_VAR: Event indicating state transitions in state variable consensus
• BUS_EVENT_TYPE_NETWORK_LIMITS: Event indicating network limits set or updated
• BUS_EVENT_TYPE_TRANSFER: Event indicating a update for a transfer
• BUS_EVENT_TYPE_VALIDATOR_RANKING: Event indicating the ranking of validator and their status in Vega
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_EVENT: Event indicating a new multi sig signer event have been processed
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SET_THRESHOLD: Event indicating the erc20 multi sig threshold have been updated
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_ADDED: Event indicating a new signer has been added to the ERC-20 multisig
• BUS_EVENT_TYPE_ERC20_MULTI_SIG_SIGNER_REMOVED: Event indicating a signer has been removed from the ERC-20 multisig
• BUS_EVENT_TYPE_POSITION_STATE: Event indicating that a party's position has changed
• BUS_EVENT_TYPE_ETHEREUM_KEY_ROTATION: Event indicating Ethereum key rotation took place
• BUS_EVENT_TYPE_PROTOCOL_UPGRADE_PROPOSAL: Event indicating protocol upgrade proposal updates
• BUS_EVENT_TYPE_BEGIN_BLOCK: Event indicating the core is starting to process a new block
• BUS_EVENT_TYPE_END_BLOCK: Event indicating the core finished to process a block
• BUS_EVENT_TYPE_PROTOCOL_UPGRADE_STARTED: Event indicating the core is starting a protocol upgrade
• BUS_EVENT_TYPE_SETTLE_MARKET: Event indicating the market has stopped and settled
• BUS_EVENT_TYPE_TRANSACTION_RESULT: Event indicating the result of a transaction processed by the network
• BUS_EVENT_TYPE_SNAPSHOT_TAKEN: Event indicating a snapshot was taken at this block height
• BUS_EVENT_TYPE_PROTOCOL_UPGRADE_DATA_NODE_READY: Event data node uses to notify that it is ready to upgrade
• BUS_EVENT_TYPE_DISTRESSED_ORDERS_CLOSED: Event indicating parties had orders closed because they were distressed, but were not closed out.
• BUS_EVENT_TYPE_EXPIRED_ORDERS: Event indicating parties had orders closed because they were distressed, but were not closed out.
• BUS_EVENT_TYPE_DISTRESSED_POSITIONS: Event indicating parties have become, or were, distressed but still have an active position.
• BUS_EVENT_TYPE_SPOT_LIQUIDITY_PROVISION: Event indicating a spot liquidity provision has been created or updated.
• BUS_EVENT_TYPE_STOP_ORDER: Event indicating a stop order has been submitted or updated.
• BUS_EVENT_TYPE_MARKET: Event indicating a market related event, for example when a market opens
• BUS_EVENT_TYPE_TX_ERROR: Event used to report failed transactions back to a user, this is excluded from the ALL type
validatorScore object
epochSeq string
multisigScore string
nodeId string
normalisedScore string
rawValidatorScore string
validatorPerformance string
validatorScore string
validatorStatus string
validatorUpdate object
added Flag indicating if the validator has been added to or removed from vega
avatarUrl AvatarURL of the validator
country Country code (ISO 3166-1 alpha-2) for the location of the node
epochSeq uint64
ethereumAddress Ethereum public key of validator node
fromEpoch uint64
infoUrl URL with more info on the node
name Name of the validator
nodeId Node ID of the validator node
submitterAddress Ethereum public key being used as the submitter to allow automatic signature generation
tmPubKey Public key of Tendermint
vegaPubKey Vega public key of validator node
vegaPubKeyIndex int64
version int64
vote object
partyId string
Voter's party ID.
proposalId string
Proposal ID being voted on.
timestamp int64
Timestamp in Unix nanoseconds when the vote was acknowledged by the network.
totalEquityLikeShareWeight string
The weight of the vote compared to the total amount of equity-like share on the market.
totalGovernanceTokenBalance string
Total number of governance token for the party that cast the vote.
totalGovernanceTokenWeight string
The weight of this vote based on the total number of governance tokens.
value Vote value
Possible values: [VALUE_UNSPECIFIED, VALUE_NO, VALUE_YES]
Default value: VALUE_UNSPECIFIED
Which way the party voted.
withdrawal object
amount string
Amount to be withdrawn. This field is an unsigned integer scaled to the asset's decimal places.
asset string
Asset to withdraw funds from.
createdTimestamp int64
Timestamp for when the network started to process this withdrawal.
ext object
Foreign chain specifics.
erc20 object
ERC20 withdrawal details.
receiverAddress string
Address into which the bridge will release the funds.
id string
Unique ID for the withdrawal.
partyId string
Unique party ID of the user initiating the withdrawal.
ref string
Reference which is used by the foreign chain to refer to this withdrawal.
status Status of the withdrawal
Possible values: [STATUS_UNSPECIFIED, STATUS_OPEN, STATUS_REJECTED, STATUS_FINALIZED]
Default value: STATUS_UNSPECIFIED
Status of the withdrawal.
txHash string
Hash of the foreign chain for this transaction.
withdrawnTimestamp int64
Timestamp for when the withdrawal was finalised by the network.
]

{
  "error": {
    "code": 0,
    "details": [
      {
        "@type": "string"
      }
    ],
    "message": "string"
  },
  "result": {
    "events": [
      {
        "account": {
          "asset": "string",
          "balance": "string",
          "id": "string",
          "marketId": "string",
          "owner": "string",
          "type": "ACCOUNT_TYPE_UNSPECIFIED"
        },
        "asset": {
          "details": {
            "builtinAsset": {
              "maxFaucetAmountMint": "string"
            },
            "decimals": "string",
            "erc20": {
              "contractAddress": "string",
              "lifetimeLimit": "string",
              "withdrawThreshold": "string"
            },
            "name": "string",
            "quantum": "string",
            "symbol": "string"
          },
          "id": "string",
          "status": "STATUS_UNSPECIFIED"
        },
        "auction": {
          "end": "string",
          "extensionTrigger": "AUCTION_TRIGGER_UNSPECIFIED",
          "leave": true,
          "marketId": "string",
          "openingAuction": true,
          "start": "string",
          "trigger": "AUCTION_TRIGGER_UNSPECIFIED"
        },
        "beginBlock": {
          "hash": "string",
          "height": "string",
          "timestamp": "string"
        },
        "block": "string",
        "chainId": "string",
        "checkpoint": {
          "blockHash": "string",
          "blockHeight": "string",
          "hash": "string"
        },
        "coreSnapshotEvent": {
          "blockHash": "string",
          "blockHeight": "string",
          "coreVersion": "string",
          "protocolUpgradeBlock": true
        },
        "delegationBalance": {
          "amount": "string",
          "epochSeq": "string",
          "nodeId": "string",
          "party": "string"
        },
        "deposit": {
          "amount": "string",
          "asset": "string",
          "createdTimestamp": "string",
          "creditedTimestamp": "string",
          "id": "string",
          "partyId": "string",
          "status": "STATUS_UNSPECIFIED",
          "txHash": "string"
        },
        "distressedOrders": {
          "marketId": "string",
          "parties": [
            "string"
          ]
        },
        "distressedPositions": {
          "distressedParties": [
            "string"
          ],
          "marketId": "string",
          "safeParties": [
            "string"
          ]
        },
        "endBlock": {
          "height": "string"
        },
        "epochEvent": {
          "action": "EPOCH_ACTION_UNSPECIFIED",
          "endTime": "string",
          "expireTime": "string",
          "seq": "string",
          "startTime": "string"
        },
        "erc20MultisigSetThresholdEvent": {
          "blockNumber": "string",
          "blockTime": "string",
          "id": "string",
          "logIndex": "string",
          "newThreshold": 0,
          "nonce": "string",
          "txHash": "string"
        },
        "erc20MultisigSignerAdded": {
          "epochSeq": "string",
          "newSigner": "string",
          "nonce": "string",
          "signatureId": "string",
          "submitter": "string",
          "timestamp": "string",
          "validatorId": "string"
        },
        "erc20MultisigSignerEvent": {
          "blockNumber": "string",
          "blockTime": "string",
          "id": "string",
          "logIndex": "string",
          "nonce": "string",
          "signer": "string",
          "txHash": "string",
          "type": "TYPE_UNSPECIFIED"
        },
        "erc20MultisigSignerRemoved": {
          "epochSeq": "string",
          "nonce": "string",
          "oldSigner": "string",
          "signatureSubmitters": [
            {
              "signatureId": "string",
              "submitter": "string"
            }
          ],
          "timestamp": "string",
          "validatorId": "string"
        },
        "ethereumKeyRotation": {
          "blockHeight": "string",
          "newAddress": "string",
          "nodeId": "string",
          "oldAddress": "string"
        },
        "expiredOrders": {
          "marketId": "string",
          "orderIds": [
            "string"
          ]
        },
        "id": "string",
        "keyRotation": {
          "blockHeight": "string",
          "newPubKey": "string",
          "nodeId": "string",
          "oldPubKey": "string"
        },
        "ledgerMovements": {
          "ledgerMovements": [
            {
              "balances": [
                {
                  "account": {
                    "assetId": "string",
                    "marketId": "string",
                    "owner": "string",
                    "type": "ACCOUNT_TYPE_UNSPECIFIED"
                  },
                  "balance": "string"
                }
              ],
              "entries": [
                {
                  "amount": "string",
                  "fromAccount": {
                    "assetId": "string",
                    "marketId": "string",
                    "owner": "string",
                    "type": "ACCOUNT_TYPE_UNSPECIFIED"
                  },
                  "fromAccountBalance": "string",
                  "timestamp": "string",
                  "toAccount": {
                    "assetId": "string",
                    "marketId": "string",
                    "owner": "string",
                    "type": "ACCOUNT_TYPE_UNSPECIFIED"
                  },
                  "toAccountBalance": "string",
                  "type": "TRANSFER_TYPE_UNSPECIFIED"
                }
              ]
            }
          ]
        },
        "liquidityProvision": {
          "buys": [
            {
              "liquidityOrder": {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              },
              "orderId": "string"
            }
          ],
          "commitmentAmount": "string",
          "createdAt": "string",
          "fee": "string",
          "id": "string",
          "marketId": "string",
          "partyId": "string",
          "reference": "string",
          "sells": [
            {
              "liquidityOrder": {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              },
              "orderId": "string"
            }
          ],
          "status": "STATUS_UNSPECIFIED",
          "updatedAt": "string",
          "version": "string"
        },
        "lossSocialization": {
          "amount": "string",
          "marketId": "string",
          "partyId": "string"
        },
        "marginLevels": {
          "asset": "string",
          "collateralReleaseLevel": "string",
          "initialMargin": "string",
          "maintenanceMargin": "string",
          "marketId": "string",
          "partyId": "string",
          "searchLevel": "string",
          "timestamp": "string"
        },
        "market": {
          "marketId": "string",
          "payload": "string"
        },
        "marketCreated": {
          "decimalPlaces": "string",
          "fees": {
            "factors": {
              "infrastructureFee": "string",
              "liquidityFee": "string",
              "makerFee": "string"
            }
          },
          "id": "string",
          "insurancePoolFraction": "string",
          "linearSlippageFactor": "string",
          "liquidityMonitoringParameters": {
            "auctionExtension": "string",
            "targetStakeParameters": {
              "scalingFactor": 0,
              "timeWindow": "string"
            },
            "triggeringRatio": "string"
          },
          "lpPriceRange": "string",
          "marketTimestamps": {
            "close": "string",
            "open": "string",
            "pending": "string",
            "proposed": "string"
          },
          "openingAuction": {
            "duration": "string",
            "volume": "string"
          },
          "parentMarketId": "string",
          "positionDecimalPlaces": "string",
          "priceMonitoringSettings": {
            "parameters": {
              "triggers": [
                {
                  "auctionExtension": "string",
                  "horizon": "string",
                  "probability": "string"
                }
              ]
            }
          },
          "quadraticSlippageFactor": "string",
          "state": "STATE_UNSPECIFIED",
          "successorMarketId": "string",
          "tradableInstrument": {
            "instrument": {
              "code": "string",
              "future": {
                "dataSourceSpecBinding": {
                  "settlementDataProperty": "string",
                  "tradingTerminationProperty": "string"
                },
                "dataSourceSpecForSettlementData": {
                  "createdAt": "string",
                  "data": {
                    "external": {
                      "ethCall": {
                        "abi": [
                          {}
                        ],
                        "address": "string",
                        "args": [
                          {}
                        ],
                        "method": "string",
                        "trigger": {
                          "timeTrigger": {
                            "every": "string",
                            "initial": "string",
                            "until": "string"
                          }
                        }
                      },
                      "oracle": {
                        "filters": [
                          {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ],
                            "key": {
                              "name": "string",
                              "numberDecimalPlaces": "string",
                              "type": "TYPE_UNSPECIFIED"
                            }
                          }
                        ],
                        "signers": [
                          {
                            "ethAddress": {
                              "address": "string"
                            },
                            "pubKey": {
                              "key": "string"
                            }
                          }
                        ]
                      }
                    },
                    "internal": {
                      "time": {
                        "conditions": [
                          {
                            "operator": "OPERATOR_UNSPECIFIED",
                            "value": "string"
                          }
                        ]
                      }
                    }
                  },
                  "id": "string",
                  "status": "STATUS_UNSPECIFIED",
                  "updatedAt": "string"
                },
                "dataSourceSpecForTradingTermination": {
                  "createdAt": "string",
                  "data": {
                    "external": {
                      "ethCall": {
                        "abi": [
                          {}
                        ],
                        "address": "string",
                        "args": [
                          {}
                        ],
                        "method": "string",
                        "trigger": {
                          "timeTrigger": {
                            "every": "string",
                            "initial": "string",
                            "until": "string"
                          }
                        }
                      },
                      "oracle": {
                        "filters": [
                          {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ],
                            "key": {
                              "name": "string",
                              "numberDecimalPlaces": "string",
                              "type": "TYPE_UNSPECIFIED"
                            }
                          }
                        ],
                        "signers": [
                          {
                            "ethAddress": {
                              "address": "string"
                            },
                            "pubKey": {
                              "key": "string"
                            }
                          }
                        ]
                      }
                    },
                    "internal": {
                      "time": {
                        "conditions": [
                          {
                            "operator": "OPERATOR_UNSPECIFIED",
                            "value": "string"
                          }
                        ]
                      }
                    }
                  },
                  "id": "string",
                  "status": "STATUS_UNSPECIFIED",
                  "updatedAt": "string"
                },
                "quoteName": "string",
                "settlementAsset": "string"
              },
              "id": "string",
              "metadata": {
                "tags": [
                  "string"
                ]
              },
              "name": "string",
              "spot": {
                "baseAsset": "string",
                "name": "string",
                "quoteAsset": "string"
              }
            },
            "logNormalRiskModel": {
              "params": {
                "mu": 0,
                "r": 0,
                "sigma": 0
              },
              "riskAversionParameter": 0,
              "tau": 0
            },
            "marginCalculator": {
              "scalingFactors": {
                "collateralRelease": 0,
                "initialMargin": 0,
                "searchLevel": 0
              }
            },
            "simpleRiskModel": {
              "params": {
                "factorLong": 0,
                "factorShort": 0,
                "maxMoveUp": 0,
                "minMoveDown": 0,
                "probabilityOfTrading": 0
              }
            }
          },
          "tradingMode": "TRADING_MODE_UNSPECIFIED"
        },
        "marketData": {
          "auctionEnd": "string",
          "auctionStart": "string",
          "bestBidPrice": "string",
          "bestBidVolume": "string",
          "bestOfferPrice": "string",
          "bestOfferVolume": "string",
          "bestStaticBidPrice": "string",
          "bestStaticBidVolume": "string",
          "bestStaticOfferPrice": "string",
          "bestStaticOfferVolume": "string",
          "extensionTrigger": "AUCTION_TRIGGER_UNSPECIFIED",
          "indicativePrice": "string",
          "indicativeVolume": "string",
          "lastTradedPrice": "string",
          "liquidityProviderFeeShare": [
            {
              "averageEntryValuation": "string",
              "averageScore": "string",
              "equityLikeShare": "string",
              "party": "string",
              "virtualStake": "string"
            }
          ],
          "markPrice": "string",
          "market": "string",
          "marketGrowth": "string",
          "marketState": "STATE_UNSPECIFIED",
          "marketTradingMode": "TRADING_MODE_UNSPECIFIED",
          "marketValueProxy": "string",
          "midPrice": "string",
          "nextMarkToMarket": "string",
          "openInterest": "string",
          "priceMonitoringBounds": [
            {
              "maxValidPrice": "string",
              "minValidPrice": "string",
              "referencePrice": "string",
              "trigger": {
                "auctionExtension": "string",
                "horizon": "string",
                "probability": "string"
              }
            }
          ],
          "staticMidPrice": "string",
          "suppliedStake": "string",
          "targetStake": "string",
          "timestamp": "string",
          "trigger": "AUCTION_TRIGGER_UNSPECIFIED"
        },
        "marketTick": {
          "id": "string",
          "time": "string"
        },
        "marketUpdated": {
          "decimalPlaces": "string",
          "fees": {
            "factors": {
              "infrastructureFee": "string",
              "liquidityFee": "string",
              "makerFee": "string"
            }
          },
          "id": "string",
          "insurancePoolFraction": "string",
          "linearSlippageFactor": "string",
          "liquidityMonitoringParameters": {
            "auctionExtension": "string",
            "targetStakeParameters": {
              "scalingFactor": 0,
              "timeWindow": "string"
            },
            "triggeringRatio": "string"
          },
          "lpPriceRange": "string",
          "marketTimestamps": {
            "close": "string",
            "open": "string",
            "pending": "string",
            "proposed": "string"
          },
          "openingAuction": {
            "duration": "string",
            "volume": "string"
          },
          "parentMarketId": "string",
          "positionDecimalPlaces": "string",
          "priceMonitoringSettings": {
            "parameters": {
              "triggers": [
                {
                  "auctionExtension": "string",
                  "horizon": "string",
                  "probability": "string"
                }
              ]
            }
          },
          "quadraticSlippageFactor": "string",
          "state": "STATE_UNSPECIFIED",
          "successorMarketId": "string",
          "tradableInstrument": {
            "instrument": {
              "code": "string",
              "future": {
                "dataSourceSpecBinding": {
                  "settlementDataProperty": "string",
                  "tradingTerminationProperty": "string"
                },
                "dataSourceSpecForSettlementData": {
                  "createdAt": "string",
                  "data": {
                    "external": {
                      "ethCall": {
                        "abi": [
                          {}
                        ],
                        "address": "string",
                        "args": [
                          {}
                        ],
                        "method": "string",
                        "trigger": {
                          "timeTrigger": {
                            "every": "string",
                            "initial": "string",
                            "until": "string"
                          }
                        }
                      },
                      "oracle": {
                        "filters": [
                          {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ],
                            "key": {
                              "name": "string",
                              "numberDecimalPlaces": "string",
                              "type": "TYPE_UNSPECIFIED"
                            }
                          }
                        ],
                        "signers": [
                          {
                            "ethAddress": {
                              "address": "string"
                            },
                            "pubKey": {
                              "key": "string"
                            }
                          }
                        ]
                      }
                    },
                    "internal": {
                      "time": {
                        "conditions": [
                          {
                            "operator": "OPERATOR_UNSPECIFIED",
                            "value": "string"
                          }
                        ]
                      }
                    }
                  },
                  "id": "string",
                  "status": "STATUS_UNSPECIFIED",
                  "updatedAt": "string"
                },
                "dataSourceSpecForTradingTermination": {
                  "createdAt": "string",
                  "data": {
                    "external": {
                      "ethCall": {
                        "abi": [
                          {}
                        ],
                        "address": "string",
                        "args": [
                          {}
                        ],
                        "method": "string",
                        "trigger": {
                          "timeTrigger": {
                            "every": "string",
                            "initial": "string",
                            "until": "string"
                          }
                        }
                      },
                      "oracle": {
                        "filters": [
                          {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ],
                            "key": {
                              "name": "string",
                              "numberDecimalPlaces": "string",
                              "type": "TYPE_UNSPECIFIED"
                            }
                          }
                        ],
                        "signers": [
                          {
                            "ethAddress": {
                              "address": "string"
                            },
                            "pubKey": {
                              "key": "string"
                            }
                          }
                        ]
                      }
                    },
                    "internal": {
                      "time": {
                        "conditions": [
                          {
                            "operator": "OPERATOR_UNSPECIFIED",
                            "value": "string"
                          }
                        ]
                      }
                    }
                  },
                  "id": "string",
                  "status": "STATUS_UNSPECIFIED",
                  "updatedAt": "string"
                },
                "quoteName": "string",
                "settlementAsset": "string"
              },
              "id": "string",
              "metadata": {
                "tags": [
                  "string"
                ]
              },
              "name": "string",
              "spot": {
                "baseAsset": "string",
                "name": "string",
                "quoteAsset": "string"
              }
            },
            "logNormalRiskModel": {
              "params": {
                "mu": 0,
                "r": 0,
                "sigma": 0
              },
              "riskAversionParameter": 0,
              "tau": 0
            },
            "marginCalculator": {
              "scalingFactors": {
                "collateralRelease": 0,
                "initialMargin": 0,
                "searchLevel": 0
              }
            },
            "simpleRiskModel": {
              "params": {
                "factorLong": 0,
                "factorShort": 0,
                "maxMoveUp": 0,
                "minMoveDown": 0,
                "probabilityOfTrading": 0
              }
            }
          },
          "tradingMode": "TRADING_MODE_UNSPECIFIED"
        },
        "networkLimits": {
          "canProposeAsset": true,
          "canProposeMarket": true,
          "genesisLoaded": true,
          "proposeAssetEnabled": true,
          "proposeAssetEnabledFrom": "string",
          "proposeMarketEnabled": true,
          "proposeMarketEnabledFrom": "string"
        },
        "networkParameter": {
          "key": "string",
          "value": "string"
        },
        "nodeSignature": {
          "id": "string",
          "kind": "NODE_SIGNATURE_KIND_UNSPECIFIED",
          "sig": "string"
        },
        "oracleData": {
          "externalData": {
            "data": {
              "broadcastAt": "string",
              "data": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "matchedSpecIds": [
                "string"
              ],
              "signers": [
                {
                  "ethAddress": {
                    "address": "string"
                  },
                  "pubKey": {
                    "key": "string"
                  }
                }
              ]
            }
          }
        },
        "oracleSpec": {
          "externalDataSourceSpec": {
            "spec": {
              "createdAt": "string",
              "data": {
                "external": {
                  "ethCall": {
                    "abi": [
                      {}
                    ],
                    "address": "string",
                    "args": [
                      {}
                    ],
                    "method": "string",
                    "trigger": {
                      "timeTrigger": {
                        "every": "string",
                        "initial": "string",
                        "until": "string"
                      }
                    }
                  },
                  "oracle": {
                    "filters": [
                      {
                        "conditions": [
                          {
                            "operator": "OPERATOR_UNSPECIFIED",
                            "value": "string"
                          }
                        ],
                        "key": {
                          "name": "string",
                          "numberDecimalPlaces": "string",
                          "type": "TYPE_UNSPECIFIED"
                        }
                      }
                    ],
                    "signers": [
                      {
                        "ethAddress": {
                          "address": "string"
                        },
                        "pubKey": {
                          "key": "string"
                        }
                      }
                    ]
                  }
                },
                "internal": {
                  "time": {
                    "conditions": [
                      {
                        "operator": "OPERATOR_UNSPECIFIED",
                        "value": "string"
                      }
                    ]
                  }
                }
              },
              "id": "string",
              "status": "STATUS_UNSPECIFIED",
              "updatedAt": "string"
            }
          }
        },
        "order": {
          "batchId": "string",
          "createdAt": "string",
          "expiresAt": "string",
          "icebergOrder": {
            "minimumVisibleSize": "string",
            "peakSize": "string",
            "reservedRemaining": "string"
          },
          "id": "string",
          "liquidityProvisionId": "string",
          "marketId": "string",
          "partyId": "string",
          "peggedOrder": {
            "offset": "string",
            "reference": "PEGGED_REFERENCE_UNSPECIFIED"
          },
          "postOnly": true,
          "price": "string",
          "reason": "ORDER_ERROR_UNSPECIFIED",
          "reduceOnly": true,
          "reference": "string",
          "remaining": "string",
          "side": "SIDE_UNSPECIFIED",
          "size": "string",
          "status": "STATUS_UNSPECIFIED",
          "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
          "type": "TYPE_UNSPECIFIED",
          "updatedAt": "string",
          "version": "string"
        },
        "party": {
          "id": "string"
        },
        "positionResolution": {
          "closed": "string",
          "distressed": "string",
          "markPrice": "string",
          "marketId": "string"
        },
        "positionStateEvent": {
          "marketId": "string",
          "partyId": "string",
          "potentialBuys": "string",
          "potentialSells": "string",
          "size": "string",
          "vwBuyPrice": "string",
          "vwSellPrice": "string"
        },
        "proposal": {
          "errorDetails": "string",
          "id": "string",
          "partyId": "string",
          "rationale": {
            "description": "string",
            "title": "string"
          },
          "reason": "PROPOSAL_ERROR_UNSPECIFIED",
          "reference": "string",
          "requiredLiquidityProviderMajority": "string",
          "requiredLiquidityProviderParticipation": "string",
          "requiredMajority": "string",
          "requiredParticipation": "string",
          "state": "STATE_UNSPECIFIED",
          "terms": {
            "cancelTransfer": {
              "changes": {
                "transferId": "string"
              }
            },
            "closingTimestamp": "string",
            "enactmentTimestamp": "string",
            "newAsset": {
              "changes": {
                "builtinAsset": {
                  "maxFaucetAmountMint": "string"
                },
                "decimals": "string",
                "erc20": {
                  "contractAddress": "string",
                  "lifetimeLimit": "string",
                  "withdrawThreshold": "string"
                },
                "name": "string",
                "quantum": "string",
                "symbol": "string"
              }
            },
            "newFreeform": {},
            "newMarket": {
              "changes": {
                "decimalPlaces": "string",
                "instrument": {
                  "code": "string",
                  "future": {
                    "dataSourceSpecBinding": {
                      "settlementDataProperty": "string",
                      "tradingTerminationProperty": "string"
                    },
                    "dataSourceSpecForSettlementData": {
                      "external": {
                        "ethCall": {
                          "abi": [
                            {}
                          ],
                          "address": "string",
                          "args": [
                            {}
                          ],
                          "method": "string",
                          "trigger": {
                            "timeTrigger": {
                              "every": "string",
                              "initial": "string",
                              "until": "string"
                            }
                          }
                        },
                        "oracle": {
                          "filters": [
                            {
                              "conditions": [
                                {
                                  "operator": "OPERATOR_UNSPECIFIED",
                                  "value": "string"
                                }
                              ],
                              "key": {
                                "name": "string",
                                "numberDecimalPlaces": "string",
                                "type": "TYPE_UNSPECIFIED"
                              }
                            }
                          ],
                          "signers": [
                            {
                              "ethAddress": {
                                "address": "string"
                              },
                              "pubKey": {
                                "key": "string"
                              }
                            }
                          ]
                        }
                      },
                      "internal": {
                        "time": {
                          "conditions": [
                            {
                              "operator": "OPERATOR_UNSPECIFIED",
                              "value": "string"
                            }
                          ]
                        }
                      }
                    },
                    "dataSourceSpecForTradingTermination": {
                      "external": {
                        "ethCall": {
                          "abi": [
                            {}
                          ],
                          "address": "string",
                          "args": [
                            {}
                          ],
                          "method": "string",
                          "trigger": {
                            "timeTrigger": {
                              "every": "string",
                              "initial": "string",
                              "until": "string"
                            }
                          }
                        },
                        "oracle": {
                          "filters": [
                            {
                              "conditions": [
                                {
                                  "operator": "OPERATOR_UNSPECIFIED",
                                  "value": "string"
                                }
                              ],
                              "key": {
                                "name": "string",
                                "numberDecimalPlaces": "string",
                                "type": "TYPE_UNSPECIFIED"
                              }
                            }
                          ],
                          "signers": [
                            {
                              "ethAddress": {
                                "address": "string"
                              },
                              "pubKey": {
                                "key": "string"
                              }
                            }
                          ]
                        }
                      },
                      "internal": {
                        "time": {
                          "conditions": [
                            {
                              "operator": "OPERATOR_UNSPECIFIED",
                              "value": "string"
                            }
                          ]
                        }
                      }
                    },
                    "quoteName": "string",
                    "settlementAsset": "string"
                  },
                  "name": "string",
                  "spot": {
                    "baseAsset": "string",
                    "name": "string",
                    "quoteAsset": "string"
                  }
                },
                "linearSlippageFactor": "string",
                "liquidityMonitoringParameters": {
                  "auctionExtension": "string",
                  "targetStakeParameters": {
                    "scalingFactor": 0,
                    "timeWindow": "string"
                  },
                  "triggeringRatio": "string"
                },
                "logNormal": {
                  "params": {
                    "mu": 0,
                    "r": 0,
                    "sigma": 0
                  },
                  "riskAversionParameter": 0,
                  "tau": 0
                },
                "lpPriceRange": "string",
                "metadata": [
                  "string"
                ],
                "positionDecimalPlaces": "string",
                "priceMonitoringParameters": {
                  "triggers": [
                    {
                      "auctionExtension": "string",
                      "horizon": "string",
                      "probability": "string"
                    }
                  ]
                },
                "quadraticSlippageFactor": "string",
                "simple": {
                  "factorLong": 0,
                  "factorShort": 0,
                  "maxMoveUp": 0,
                  "minMoveDown": 0,
                  "probabilityOfTrading": 0
                },
                "successor": {
                  "insurancePoolFraction": "string",
                  "parentMarketId": "string"
                }
              }
            },
            "newSpotMarket": {
              "changes": {
                "decimalPlaces": "string",
                "instrument": {
                  "code": "string",
                  "future": {
                    "dataSourceSpecBinding": {
                      "settlementDataProperty": "string",
                      "tradingTerminationProperty": "string"
                    },
                    "dataSourceSpecForSettlementData": {
                      "external": {
                        "ethCall": {
                          "abi": [
                            {}
                          ],
                          "address": "string",
                          "args": [
                            {}
                          ],
                          "method": "string",
                          "trigger": {
                            "timeTrigger": {
                              "every": "string",
                              "initial": "string",
                              "until": "string"
                            }
                          }
                        },
                        "oracle": {
                          "filters": [
                            {
                              "conditions": [
                                {
                                  "operator": "OPERATOR_UNSPECIFIED",
                                  "value": "string"
                                }
                              ],
                              "key": {
                                "name": "string",
                                "numberDecimalPlaces": "string",
                                "type": "TYPE_UNSPECIFIED"
                              }
                            }
                          ],
                          "signers": [
                            {
                              "ethAddress": {
                                "address": "string"
                              },
                              "pubKey": {
                                "key": "string"
                              }
                            }
                          ]
                        }
                      },
                      "internal": {
                        "time": {
                          "conditions": [
                            {
                              "operator": "OPERATOR_UNSPECIFIED",
                              "value": "string"
                            }
                          ]
                        }
                      }
                    },
                    "dataSourceSpecForTradingTermination": {
                      "external": {
                        "ethCall": {
                          "abi": [
                            {}
                          ],
                          "address": "string",
                          "args": [
                            {}
                          ],
                          "method": "string",
                          "trigger": {
                            "timeTrigger": {
                              "every": "string",
                              "initial": "string",
                              "until": "string"
                            }
                          }
                        },
                        "oracle": {
                          "filters": [
                            {
                              "conditions": [
                                {
                                  "operator": "OPERATOR_UNSPECIFIED",
                                  "value": "string"
                                }
                              ],
                              "key": {
                                "name": "string",
                                "numberDecimalPlaces": "string",
                                "type": "TYPE_UNSPECIFIED"
                              }
                            }
                          ],
                          "signers": [
                            {
                              "ethAddress": {
                                "address": "string"
                              },
                              "pubKey": {
                                "key": "string"
                              }
                            }
                          ]
                        }
                      },
                      "internal": {
                        "time": {
                          "conditions": [
                            {
                              "operator": "OPERATOR_UNSPECIFIED",
                              "value": "string"
                            }
                          ]
                        }
                      }
                    },
                    "quoteName": "string",
                    "settlementAsset": "string"
                  },
                  "name": "string",
                  "spot": {
                    "baseAsset": "string",
                    "name": "string",
                    "quoteAsset": "string"
                  }
                },
                "logNormal": {
                  "params": {
                    "mu": 0,
                    "r": 0,
                    "sigma": 0
                  },
                  "riskAversionParameter": 0,
                  "tau": 0
                },
                "metadata": [
                  "string"
                ],
                "positionDecimalPlaces": "string",
                "priceMonitoringParameters": {
                  "triggers": [
                    {
                      "auctionExtension": "string",
                      "horizon": "string",
                      "probability": "string"
                    }
                  ]
                },
                "simple": {
                  "factorLong": 0,
                  "factorShort": 0,
                  "maxMoveUp": 0,
                  "minMoveDown": 0,
                  "probabilityOfTrading": 0
                },
                "targetStakeParameters": {
                  "scalingFactor": 0,
                  "timeWindow": "string"
                }
              }
            },
            "newTransfer": {
              "changes": {
                "amount": "string",
                "asset": "string",
                "destination": "string",
                "destinationType": "ACCOUNT_TYPE_UNSPECIFIED",
                "fractionOfBalance": "string",
                "oneOff": {
                  "deliverOn": "string"
                },
                "recurring": {
                  "endEpoch": "string",
                  "startEpoch": "string"
                },
                "source": "string",
                "sourceType": "ACCOUNT_TYPE_UNSPECIFIED",
                "transferType": "GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED"
              }
            },
            "updateAsset": {
              "assetId": "string",
              "changes": {
                "erc20": {
                  "lifetimeLimit": "string",
                  "withdrawThreshold": "string"
                },
                "quantum": "string"
              }
            },
            "updateMarket": {
              "changes": {
                "instrument": {
                  "code": "string",
                  "future": {
                    "dataSourceSpecBinding": {
                      "settlementDataProperty": "string",
                      "tradingTerminationProperty": "string"
                    },
                    "dataSourceSpecForSettlementData": {
                      "external": {
                        "ethCall": {
                          "abi": [
                            {}
                          ],
                          "address": "string",
                          "args": [
                            {}
                          ],
                          "method": "string",
                          "trigger": {
                            "timeTrigger": {
                              "every": "string",
                              "initial": "string",
                              "until": "string"
                            }
                          }
                        },
                        "oracle": {
                          "filters": [
                            {
                              "conditions": [
                                {
                                  "operator": "OPERATOR_UNSPECIFIED",
                                  "value": "string"
                                }
                              ],
                              "key": {
                                "name": "string",
                                "numberDecimalPlaces": "string",
                                "type": "TYPE_UNSPECIFIED"
                              }
                            }
                          ],
                          "signers": [
                            {
                              "ethAddress": {
                                "address": "string"
                              },
                              "pubKey": {
                                "key": "string"
                              }
                            }
                          ]
                        }
                      },
                      "internal": {
                        "time": {
                          "conditions": [
                            {
                              "operator": "OPERATOR_UNSPECIFIED",
                              "value": "string"
                            }
                          ]
                        }
                      }
                    },
                    "dataSourceSpecForTradingTermination": {
                      "external": {
                        "ethCall": {
                          "abi": [
                            {}
                          ],
                          "address": "string",
                          "args": [
                            {}
                          ],
                          "method": "string",
                          "trigger": {
                            "timeTrigger": {
                              "every": "string",
                              "initial": "string",
                              "until": "string"
                            }
                          }
                        },
                        "oracle": {
                          "filters": [
                            {
                              "conditions": [
                                {
                                  "operator": "OPERATOR_UNSPECIFIED",
                                  "value": "string"
                                }
                              ],
                              "key": {
                                "name": "string",
                                "numberDecimalPlaces": "string",
                                "type": "TYPE_UNSPECIFIED"
                              }
                            }
                          ],
                          "signers": [
                            {
                              "ethAddress": {
                                "address": "string"
                              },
                              "pubKey": {
                                "key": "string"
                              }
                            }
                          ]
                        }
                      },
                      "internal": {
                        "time": {
                          "conditions": [
                            {
                              "operator": "OPERATOR_UNSPECIFIED",
                              "value": "string"
                            }
                          ]
                        }
                      }
                    },
                    "quoteName": "string"
                  }
                },
                "linearSlippageFactor": "string",
                "liquidityMonitoringParameters": {
                  "auctionExtension": "string",
                  "targetStakeParameters": {
                    "scalingFactor": 0,
                    "timeWindow": "string"
                  },
                  "triggeringRatio": "string"
                },
                "logNormal": {
                  "params": {
                    "mu": 0,
                    "r": 0,
                    "sigma": 0
                  },
                  "riskAversionParameter": 0,
                  "tau": 0
                },
                "lpPriceRange": "string",
                "metadata": [
                  "string"
                ],
                "priceMonitoringParameters": {
                  "triggers": [
                    {
                      "auctionExtension": "string",
                      "horizon": "string",
                      "probability": "string"
                    }
                  ]
                },
                "quadraticSlippageFactor": "string",
                "simple": {
                  "factorLong": 0,
                  "factorShort": 0,
                  "maxMoveUp": 0,
                  "minMoveDown": 0,
                  "probabilityOfTrading": 0
                }
              },
              "marketId": "string"
            },
            "updateNetworkParameter": {
              "changes": {
                "key": "string",
                "value": "string"
              }
            },
            "updateSpotMarket": {
              "changes": {
                "logNormal": {
                  "params": {
                    "mu": 0,
                    "r": 0,
                    "sigma": 0
                  },
                  "riskAversionParameter": 0,
                  "tau": 0
                },
                "metadata": [
                  "string"
                ],
                "priceMonitoringParameters": {
                  "triggers": [
                    {
                      "auctionExtension": "string",
                      "horizon": "string",
                      "probability": "string"
                    }
                  ]
                },
                "simple": {
                  "factorLong": 0,
                  "factorShort": 0,
                  "maxMoveUp": 0,
                  "minMoveDown": 0,
                  "probabilityOfTrading": 0
                },
                "targetStakeParameters": {
                  "scalingFactor": 0,
                  "timeWindow": "string"
                }
              },
              "marketId": "string"
            },
            "validationTimestamp": "string"
          },
          "timestamp": "string"
        },
        "protocolUpgradeDataNodeReady": {
          "lastBlockHeight": "string"
        },
        "protocolUpgradeEvent": {
          "approvers": [
            "string"
          ],
          "status": "PROTOCOL_UPGRADE_PROPOSAL_STATUS_UNSPECIFIED",
          "upgradeBlockHeight": "string",
          "vegaReleaseTag": "string"
        },
        "protocolUpgradeStarted": {
          "lastBlockHeight": "string"
        },
        "rankingEvent": {
          "epochSeq": "string",
          "nextStatus": "string",
          "nodeId": "string",
          "performanceScore": "string",
          "previousStatus": "string",
          "rankingScore": "string",
          "stakeScore": "string",
          "tmVotingPower": 0
        },
        "rewardPayout": {
          "amount": "string",
          "asset": "string",
          "epochSeq": "string",
          "market": "string",
          "party": "string",
          "percentOfTotalReward": "string",
          "rewardType": "string",
          "timestamp": "string"
        },
        "riskFactor": {
          "long": "string",
          "market": "string",
          "short": "string"
        },
        "settleDistressed": {
          "margin": "string",
          "marketId": "string",
          "partyId": "string",
          "price": "string"
        },
        "settleMarket": {
          "marketId": "string",
          "positionFactor": "string",
          "price": "string"
        },
        "settlePosition": {
          "marketId": "string",
          "partyId": "string",
          "positionFactor": "string",
          "price": "string",
          "tradeSettlements": [
            {
              "marketPrice": "string",
              "price": "string",
              "size": "string"
            }
          ]
        },
        "stakeLinking": {
          "amount": "string",
          "blockHeight": "string",
          "blockTime": "string",
          "ethereumAddress": "string",
          "finalizedAt": "string",
          "id": "string",
          "logIndex": "string",
          "party": "string",
          "status": "STATUS_UNSPECIFIED",
          "ts": "string",
          "txHash": "string",
          "type": "TYPE_UNSPECIFIED"
        },
        "stateVar": {
          "eventId": "string",
          "id": "string",
          "state": "string"
        },
        "stopOrder": {
          "stopOrder": {
            "createdAt": "string",
            "expiresAt": "string",
            "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
            "id": "string",
            "marketId": "string",
            "ocoLinkId": "string",
            "orderId": "string",
            "partyId": "string",
            "price": "string",
            "status": "STATUS_UNSPECIFIED",
            "trailingPercentOffset": "string",
            "triggerDirection": "TRIGGER_DIRECTION_UNSPECIFIED",
            "updatedAt": "string"
          },
          "submission": {
            "expiresAt": "string",
            "icebergOpts": {
              "minimumVisibleSize": "string",
              "peakSize": "string"
            },
            "marketId": "string",
            "peggedOrder": {
              "offset": "string",
              "reference": "PEGGED_REFERENCE_UNSPECIFIED"
            },
            "postOnly": true,
            "price": "string",
            "reduceOnly": true,
            "reference": "string",
            "side": "SIDE_UNSPECIFIED",
            "size": "string",
            "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
            "type": "TYPE_UNSPECIFIED"
          }
        },
        "timeUpdate": {
          "timestamp": "string"
        },
        "trade": {
          "aggressor": "SIDE_UNSPECIFIED",
          "buyOrder": "string",
          "buyer": "string",
          "buyerAuctionBatch": "string",
          "buyerFee": {
            "infrastructureFee": "string",
            "liquidityFee": "string",
            "makerFee": "string"
          },
          "id": "string",
          "marketId": "string",
          "price": "string",
          "sellOrder": "string",
          "seller": "string",
          "sellerAuctionBatch": "string",
          "sellerFee": {
            "infrastructureFee": "string",
            "liquidityFee": "string",
            "makerFee": "string"
          },
          "size": "string",
          "timestamp": "string",
          "type": "TYPE_UNSPECIFIED"
        },
        "transactionResult": {
          "announceNode": {
            "avatarUrl": "string",
            "chainPubKey": "string",
            "country": "string",
            "ethereumAddress": "string",
            "ethereumSignature": {
              "algo": "string",
              "value": "string",
              "version": 0
            },
            "fromEpoch": "string",
            "id": "string",
            "infoUrl": "string",
            "name": "string",
            "submitterAddress": "string",
            "vegaPubKey": "string",
            "vegaPubKeyIndex": 0,
            "vegaSignature": {
              "algo": "string",
              "value": "string",
              "version": 0
            }
          },
          "batchMarketInstructions": {
            "amendments": [
              {
                "expiresAt": "string",
                "marketId": "string",
                "orderId": "string",
                "peggedOffset": "string",
                "peggedReference": "PEGGED_REFERENCE_UNSPECIFIED",
                "price": "string",
                "sizeDelta": "string",
                "timeInForce": "TIME_IN_FORCE_UNSPECIFIED"
              }
            ],
            "cancellations": [
              {
                "marketId": "string",
                "orderId": "string"
              }
            ],
            "stopOrdersCancellation": [
              {
                "marketId": "string",
                "stopOrderId": "string"
              }
            ],
            "stopOrdersSubmission": [
              {
                "fallsBelow": {
                  "expiresAt": "string",
                  "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
                  "orderSubmission": {
                    "expiresAt": "string",
                    "icebergOpts": {
                      "minimumVisibleSize": "string",
                      "peakSize": "string"
                    },
                    "marketId": "string",
                    "peggedOrder": {
                      "offset": "string",
                      "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                    },
                    "postOnly": true,
                    "price": "string",
                    "reduceOnly": true,
                    "reference": "string",
                    "side": "SIDE_UNSPECIFIED",
                    "size": "string",
                    "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                    "type": "TYPE_UNSPECIFIED"
                  },
                  "price": "string",
                  "trailingPercentOffset": "string"
                },
                "risesAbove": {
                  "expiresAt": "string",
                  "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
                  "orderSubmission": {
                    "expiresAt": "string",
                    "icebergOpts": {
                      "minimumVisibleSize": "string",
                      "peakSize": "string"
                    },
                    "marketId": "string",
                    "peggedOrder": {
                      "offset": "string",
                      "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                    },
                    "postOnly": true,
                    "price": "string",
                    "reduceOnly": true,
                    "reference": "string",
                    "side": "SIDE_UNSPECIFIED",
                    "size": "string",
                    "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                    "type": "TYPE_UNSPECIFIED"
                  },
                  "price": "string",
                  "trailingPercentOffset": "string"
                }
              }
            ],
            "submissions": [
              {
                "expiresAt": "string",
                "icebergOpts": {
                  "minimumVisibleSize": "string",
                  "peakSize": "string"
                },
                "marketId": "string",
                "peggedOrder": {
                  "offset": "string",
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "postOnly": true,
                "price": "string",
                "reduceOnly": true,
                "reference": "string",
                "side": "SIDE_UNSPECIFIED",
                "size": "string",
                "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                "type": "TYPE_UNSPECIFIED"
              }
            ]
          },
          "cancelTransfer": {
            "transferId": "string"
          },
          "delegateSubmission": {
            "amount": "string",
            "nodeId": "string"
          },
          "ethereumKeyRotateSubmission": {
            "currentAddress": "string",
            "ethereumSignature": {
              "algo": "string",
              "value": "string",
              "version": 0
            },
            "newAddress": "string",
            "submitterAddress": "string",
            "targetBlock": "string"
          },
          "failure": {
            "error": "string"
          },
          "hash": "string",
          "issueSignatures": {
            "kind": "NODE_SIGNATURE_KIND_UNSPECIFIED",
            "submitter": "string",
            "validatorNodeId": "string"
          },
          "keyRotateSubmission": {
            "currentPubKeyHash": "string",
            "newPubKey": "string",
            "newPubKeyIndex": 0,
            "targetBlock": "string"
          },
          "liquidityProvisionAmendment": {
            "buys": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ],
            "commitmentAmount": "string",
            "fee": "string",
            "marketId": "string",
            "reference": "string",
            "sells": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ]
          },
          "liquidityProvisionCancellation": {
            "marketId": "string"
          },
          "liquidityProvisionSubmission": {
            "buys": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ],
            "commitmentAmount": "string",
            "fee": "string",
            "marketId": "string",
            "reference": "string",
            "sells": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ]
          },
          "oracleDataSubmission": {
            "payload": "string",
            "source": "ORACLE_SOURCE_UNSPECIFIED"
          },
          "orderAmendment": {
            "expiresAt": "string",
            "marketId": "string",
            "orderId": "string",
            "peggedOffset": "string",
            "peggedReference": "PEGGED_REFERENCE_UNSPECIFIED",
            "price": "string",
            "sizeDelta": "string",
            "timeInForce": "TIME_IN_FORCE_UNSPECIFIED"
          },
          "orderCancellation": {
            "marketId": "string",
            "orderId": "string"
          },
          "orderSubmission": {
            "expiresAt": "string",
            "icebergOpts": {
              "minimumVisibleSize": "string",
              "peakSize": "string"
            },
            "marketId": "string",
            "peggedOrder": {
              "offset": "string",
              "reference": "PEGGED_REFERENCE_UNSPECIFIED"
            },
            "postOnly": true,
            "price": "string",
            "reduceOnly": true,
            "reference": "string",
            "side": "SIDE_UNSPECIFIED",
            "size": "string",
            "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
            "type": "TYPE_UNSPECIFIED"
          },
          "partyId": "string",
          "proposal": {
            "rationale": {
              "description": "string",
              "title": "string"
            },
            "reference": "string",
            "terms": {
              "cancelTransfer": {
                "changes": {
                  "transferId": "string"
                }
              },
              "closingTimestamp": "string",
              "enactmentTimestamp": "string",
              "newAsset": {
                "changes": {
                  "builtinAsset": {
                    "maxFaucetAmountMint": "string"
                  },
                  "decimals": "string",
                  "erc20": {
                    "contractAddress": "string",
                    "lifetimeLimit": "string",
                    "withdrawThreshold": "string"
                  },
                  "name": "string",
                  "quantum": "string",
                  "symbol": "string"
                }
              },
              "newFreeform": {},
              "newMarket": {
                "changes": {
                  "decimalPlaces": "string",
                  "instrument": {
                    "code": "string",
                    "future": {
                      "dataSourceSpecBinding": {
                        "settlementDataProperty": "string",
                        "tradingTerminationProperty": "string"
                      },
                      "dataSourceSpecForSettlementData": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "dataSourceSpecForTradingTermination": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "quoteName": "string",
                      "settlementAsset": "string"
                    },
                    "name": "string",
                    "spot": {
                      "baseAsset": "string",
                      "name": "string",
                      "quoteAsset": "string"
                    }
                  },
                  "linearSlippageFactor": "string",
                  "liquidityMonitoringParameters": {
                    "auctionExtension": "string",
                    "targetStakeParameters": {
                      "scalingFactor": 0,
                      "timeWindow": "string"
                    },
                    "triggeringRatio": "string"
                  },
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "lpPriceRange": "string",
                  "metadata": [
                    "string"
                  ],
                  "positionDecimalPlaces": "string",
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "quadraticSlippageFactor": "string",
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  },
                  "successor": {
                    "insurancePoolFraction": "string",
                    "parentMarketId": "string"
                  }
                }
              },
              "newSpotMarket": {
                "changes": {
                  "decimalPlaces": "string",
                  "instrument": {
                    "code": "string",
                    "future": {
                      "dataSourceSpecBinding": {
                        "settlementDataProperty": "string",
                        "tradingTerminationProperty": "string"
                      },
                      "dataSourceSpecForSettlementData": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "dataSourceSpecForTradingTermination": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "quoteName": "string",
                      "settlementAsset": "string"
                    },
                    "name": "string",
                    "spot": {
                      "baseAsset": "string",
                      "name": "string",
                      "quoteAsset": "string"
                    }
                  },
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "metadata": [
                    "string"
                  ],
                  "positionDecimalPlaces": "string",
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  },
                  "targetStakeParameters": {
                    "scalingFactor": 0,
                    "timeWindow": "string"
                  }
                }
              },
              "newTransfer": {
                "changes": {
                  "amount": "string",
                  "asset": "string",
                  "destination": "string",
                  "destinationType": "ACCOUNT_TYPE_UNSPECIFIED",
                  "fractionOfBalance": "string",
                  "oneOff": {
                    "deliverOn": "string"
                  },
                  "recurring": {
                    "endEpoch": "string",
                    "startEpoch": "string"
                  },
                  "source": "string",
                  "sourceType": "ACCOUNT_TYPE_UNSPECIFIED",
                  "transferType": "GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED"
                }
              },
              "updateAsset": {
                "assetId": "string",
                "changes": {
                  "erc20": {
                    "lifetimeLimit": "string",
                    "withdrawThreshold": "string"
                  },
                  "quantum": "string"
                }
              },
              "updateMarket": {
                "changes": {
                  "instrument": {
                    "code": "string",
                    "future": {
                      "dataSourceSpecBinding": {
                        "settlementDataProperty": "string",
                        "tradingTerminationProperty": "string"
                      },
                      "dataSourceSpecForSettlementData": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "dataSourceSpecForTradingTermination": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "quoteName": "string"
                    }
                  },
                  "linearSlippageFactor": "string",
                  "liquidityMonitoringParameters": {
                    "auctionExtension": "string",
                    "targetStakeParameters": {
                      "scalingFactor": 0,
                      "timeWindow": "string"
                    },
                    "triggeringRatio": "string"
                  },
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "lpPriceRange": "string",
                  "metadata": [
                    "string"
                  ],
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "quadraticSlippageFactor": "string",
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  }
                },
                "marketId": "string"
              },
              "updateNetworkParameter": {
                "changes": {
                  "key": "string",
                  "value": "string"
                }
              },
              "updateSpotMarket": {
                "changes": {
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "metadata": [
                    "string"
                  ],
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  },
                  "targetStakeParameters": {
                    "scalingFactor": 0,
                    "timeWindow": "string"
                  }
                },
                "marketId": "string"
              },
              "validationTimestamp": "string"
            }
          },
          "protocolUpgradeProposal": {
            "upgradeBlockHeight": "string",
            "vegaReleaseTag": "string"
          },
          "status": true,
          "stopOrderCancellation": {
            "marketId": "string",
            "stopOrderId": "string"
          },
          "stopOrderSubmission": {
            "fallsBelow": {
              "expiresAt": "string",
              "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
              "orderSubmission": {
                "expiresAt": "string",
                "icebergOpts": {
                  "minimumVisibleSize": "string",
                  "peakSize": "string"
                },
                "marketId": "string",
                "peggedOrder": {
                  "offset": "string",
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "postOnly": true,
                "price": "string",
                "reduceOnly": true,
                "reference": "string",
                "side": "SIDE_UNSPECIFIED",
                "size": "string",
                "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                "type": "TYPE_UNSPECIFIED"
              },
              "price": "string",
              "trailingPercentOffset": "string"
            },
            "risesAbove": {
              "expiresAt": "string",
              "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
              "orderSubmission": {
                "expiresAt": "string",
                "icebergOpts": {
                  "minimumVisibleSize": "string",
                  "peakSize": "string"
                },
                "marketId": "string",
                "peggedOrder": {
                  "offset": "string",
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "postOnly": true,
                "price": "string",
                "reduceOnly": true,
                "reference": "string",
                "side": "SIDE_UNSPECIFIED",
                "size": "string",
                "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                "type": "TYPE_UNSPECIFIED"
              },
              "price": "string",
              "trailingPercentOffset": "string"
            }
          },
          "success": {},
          "transfer": {
            "amount": "string",
            "asset": "string",
            "fromAccountType": "ACCOUNT_TYPE_UNSPECIFIED",
            "oneOff": {
              "deliverOn": "string"
            },
            "recurring": {
              "dispatchStrategy": {
                "assetForMetric": "string",
                "markets": [
                  "string"
                ],
                "metric": "DISPATCH_METRIC_UNSPECIFIED"
              },
              "endEpoch": "string",
              "factor": "string",
              "startEpoch": "string"
            },
            "reference": "string",
            "to": "string",
            "toAccountType": "ACCOUNT_TYPE_UNSPECIFIED"
          },
          "undelegateSubmission": {
            "amount": "string",
            "method": "METHOD_UNSPECIFIED",
            "nodeId": "string"
          },
          "voteSubmission": {
            "proposalId": "string",
            "value": "VALUE_UNSPECIFIED"
          },
          "withdrawSubmission": {
            "amount": "string",
            "asset": "string",
            "ext": {
              "erc20": {
                "receiverAddress": "string"
              }
            }
          }
        },
        "transfer": {
          "amount": "string",
          "asset": "string",
          "from": "string",
          "fromAccountType": "ACCOUNT_TYPE_UNSPECIFIED",
          "id": "string",
          "oneOff": {
            "deliverOn": "string"
          },
          "oneOffGovernance": {
            "deliverOn": "string"
          },
          "reason": "string",
          "recurring": {
            "dispatchStrategy": {
              "assetForMetric": "string",
              "markets": [
                "string"
              ],
              "metric": "DISPATCH_METRIC_UNSPECIFIED"
            },
            "endEpoch": "string",
            "factor": "string",
            "startEpoch": "string"
          },
          "recurringGovernance": {
            "endEpoch": "string",
            "startEpoch": "string"
          },
          "reference": "string",
          "status": "STATUS_UNSPECIFIED",
          "timestamp": "string",
          "to": "string",
          "toAccountType": "ACCOUNT_TYPE_UNSPECIFIED"
        },
        "txErrEvent": {
          "announceNode": {
            "avatarUrl": "string",
            "chainPubKey": "string",
            "country": "string",
            "ethereumAddress": "string",
            "ethereumSignature": {
              "algo": "string",
              "value": "string",
              "version": 0
            },
            "fromEpoch": "string",
            "id": "string",
            "infoUrl": "string",
            "name": "string",
            "submitterAddress": "string",
            "vegaPubKey": "string",
            "vegaPubKeyIndex": 0,
            "vegaSignature": {
              "algo": "string",
              "value": "string",
              "version": 0
            }
          },
          "batchMarketInstructions": {
            "amendments": [
              {
                "expiresAt": "string",
                "marketId": "string",
                "orderId": "string",
                "peggedOffset": "string",
                "peggedReference": "PEGGED_REFERENCE_UNSPECIFIED",
                "price": "string",
                "sizeDelta": "string",
                "timeInForce": "TIME_IN_FORCE_UNSPECIFIED"
              }
            ],
            "cancellations": [
              {
                "marketId": "string",
                "orderId": "string"
              }
            ],
            "stopOrdersCancellation": [
              {
                "marketId": "string",
                "stopOrderId": "string"
              }
            ],
            "stopOrdersSubmission": [
              {
                "fallsBelow": {
                  "expiresAt": "string",
                  "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
                  "orderSubmission": {
                    "expiresAt": "string",
                    "icebergOpts": {
                      "minimumVisibleSize": "string",
                      "peakSize": "string"
                    },
                    "marketId": "string",
                    "peggedOrder": {
                      "offset": "string",
                      "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                    },
                    "postOnly": true,
                    "price": "string",
                    "reduceOnly": true,
                    "reference": "string",
                    "side": "SIDE_UNSPECIFIED",
                    "size": "string",
                    "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                    "type": "TYPE_UNSPECIFIED"
                  },
                  "price": "string",
                  "trailingPercentOffset": "string"
                },
                "risesAbove": {
                  "expiresAt": "string",
                  "expiryStrategy": "EXPIRY_STRATEGY_UNSPECIFIED",
                  "orderSubmission": {
                    "expiresAt": "string",
                    "icebergOpts": {
                      "minimumVisibleSize": "string",
                      "peakSize": "string"
                    },
                    "marketId": "string",
                    "peggedOrder": {
                      "offset": "string",
                      "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                    },
                    "postOnly": true,
                    "price": "string",
                    "reduceOnly": true,
                    "reference": "string",
                    "side": "SIDE_UNSPECIFIED",
                    "size": "string",
                    "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                    "type": "TYPE_UNSPECIFIED"
                  },
                  "price": "string",
                  "trailingPercentOffset": "string"
                }
              }
            ],
            "submissions": [
              {
                "expiresAt": "string",
                "icebergOpts": {
                  "minimumVisibleSize": "string",
                  "peakSize": "string"
                },
                "marketId": "string",
                "peggedOrder": {
                  "offset": "string",
                  "reference": "PEGGED_REFERENCE_UNSPECIFIED"
                },
                "postOnly": true,
                "price": "string",
                "reduceOnly": true,
                "reference": "string",
                "side": "SIDE_UNSPECIFIED",
                "size": "string",
                "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
                "type": "TYPE_UNSPECIFIED"
              }
            ]
          },
          "cancelTransfer": {
            "transferId": "string"
          },
          "delegateSubmission": {
            "amount": "string",
            "nodeId": "string"
          },
          "errMsg": "string",
          "issueSignatures": {
            "kind": "NODE_SIGNATURE_KIND_UNSPECIFIED",
            "submitter": "string",
            "validatorNodeId": "string"
          },
          "liquidityProvisionAmendment": {
            "buys": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ],
            "commitmentAmount": "string",
            "fee": "string",
            "marketId": "string",
            "reference": "string",
            "sells": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ]
          },
          "liquidityProvisionCancellation": {
            "marketId": "string"
          },
          "liquidityProvisionSubmission": {
            "buys": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ],
            "commitmentAmount": "string",
            "fee": "string",
            "marketId": "string",
            "reference": "string",
            "sells": [
              {
                "offset": "string",
                "proportion": 0,
                "reference": "PEGGED_REFERENCE_UNSPECIFIED"
              }
            ]
          },
          "oracleDataSubmission": {
            "payload": "string",
            "source": "ORACLE_SOURCE_UNSPECIFIED"
          },
          "orderAmendment": {
            "expiresAt": "string",
            "marketId": "string",
            "orderId": "string",
            "peggedOffset": "string",
            "peggedReference": "PEGGED_REFERENCE_UNSPECIFIED",
            "price": "string",
            "sizeDelta": "string",
            "timeInForce": "TIME_IN_FORCE_UNSPECIFIED"
          },
          "orderCancellation": {
            "marketId": "string",
            "orderId": "string"
          },
          "orderSubmission": {
            "expiresAt": "string",
            "icebergOpts": {
              "minimumVisibleSize": "string",
              "peakSize": "string"
            },
            "marketId": "string",
            "peggedOrder": {
              "offset": "string",
              "reference": "PEGGED_REFERENCE_UNSPECIFIED"
            },
            "postOnly": true,
            "price": "string",
            "reduceOnly": true,
            "reference": "string",
            "side": "SIDE_UNSPECIFIED",
            "size": "string",
            "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
            "type": "TYPE_UNSPECIFIED"
          },
          "partyId": "string",
          "proposal": {
            "rationale": {
              "description": "string",
              "title": "string"
            },
            "reference": "string",
            "terms": {
              "cancelTransfer": {
                "changes": {
                  "transferId": "string"
                }
              },
              "closingTimestamp": "string",
              "enactmentTimestamp": "string",
              "newAsset": {
                "changes": {
                  "builtinAsset": {
                    "maxFaucetAmountMint": "string"
                  },
                  "decimals": "string",
                  "erc20": {
                    "contractAddress": "string",
                    "lifetimeLimit": "string",
                    "withdrawThreshold": "string"
                  },
                  "name": "string",
                  "quantum": "string",
                  "symbol": "string"
                }
              },
              "newFreeform": {},
              "newMarket": {
                "changes": {
                  "decimalPlaces": "string",
                  "instrument": {
                    "code": "string",
                    "future": {
                      "dataSourceSpecBinding": {
                        "settlementDataProperty": "string",
                        "tradingTerminationProperty": "string"
                      },
                      "dataSourceSpecForSettlementData": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "dataSourceSpecForTradingTermination": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "quoteName": "string",
                      "settlementAsset": "string"
                    },
                    "name": "string",
                    "spot": {
                      "baseAsset": "string",
                      "name": "string",
                      "quoteAsset": "string"
                    }
                  },
                  "linearSlippageFactor": "string",
                  "liquidityMonitoringParameters": {
                    "auctionExtension": "string",
                    "targetStakeParameters": {
                      "scalingFactor": 0,
                      "timeWindow": "string"
                    },
                    "triggeringRatio": "string"
                  },
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "lpPriceRange": "string",
                  "metadata": [
                    "string"
                  ],
                  "positionDecimalPlaces": "string",
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "quadraticSlippageFactor": "string",
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  },
                  "successor": {
                    "insurancePoolFraction": "string",
                    "parentMarketId": "string"
                  }
                }
              },
              "newSpotMarket": {
                "changes": {
                  "decimalPlaces": "string",
                  "instrument": {
                    "code": "string",
                    "future": {
                      "dataSourceSpecBinding": {
                        "settlementDataProperty": "string",
                        "tradingTerminationProperty": "string"
                      },
                      "dataSourceSpecForSettlementData": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "dataSourceSpecForTradingTermination": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "quoteName": "string",
                      "settlementAsset": "string"
                    },
                    "name": "string",
                    "spot": {
                      "baseAsset": "string",
                      "name": "string",
                      "quoteAsset": "string"
                    }
                  },
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "metadata": [
                    "string"
                  ],
                  "positionDecimalPlaces": "string",
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  },
                  "targetStakeParameters": {
                    "scalingFactor": 0,
                    "timeWindow": "string"
                  }
                }
              },
              "newTransfer": {
                "changes": {
                  "amount": "string",
                  "asset": "string",
                  "destination": "string",
                  "destinationType": "ACCOUNT_TYPE_UNSPECIFIED",
                  "fractionOfBalance": "string",
                  "oneOff": {
                    "deliverOn": "string"
                  },
                  "recurring": {
                    "endEpoch": "string",
                    "startEpoch": "string"
                  },
                  "source": "string",
                  "sourceType": "ACCOUNT_TYPE_UNSPECIFIED",
                  "transferType": "GOVERNANCE_TRANSFER_TYPE_UNSPECIFIED"
                }
              },
              "updateAsset": {
                "assetId": "string",
                "changes": {
                  "erc20": {
                    "lifetimeLimit": "string",
                    "withdrawThreshold": "string"
                  },
                  "quantum": "string"
                }
              },
              "updateMarket": {
                "changes": {
                  "instrument": {
                    "code": "string",
                    "future": {
                      "dataSourceSpecBinding": {
                        "settlementDataProperty": "string",
                        "tradingTerminationProperty": "string"
                      },
                      "dataSourceSpecForSettlementData": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "dataSourceSpecForTradingTermination": {
                        "external": {
                          "ethCall": {
                            "abi": [
                              {}
                            ],
                            "address": "string",
                            "args": [
                              {}
                            ],
                            "method": "string",
                            "trigger": {
                              "timeTrigger": {
                                "every": "string",
                                "initial": "string",
                                "until": "string"
                              }
                            }
                          },
                          "oracle": {
                            "filters": [
                              {
                                "conditions": [
                                  {
                                    "operator": "OPERATOR_UNSPECIFIED",
                                    "value": "string"
                                  }
                                ],
                                "key": {
                                  "name": "string",
                                  "numberDecimalPlaces": "string",
                                  "type": "TYPE_UNSPECIFIED"
                                }
                              }
                            ],
                            "signers": [
                              {
                                "ethAddress": {
                                  "address": "string"
                                },
                                "pubKey": {
                                  "key": "string"
                                }
                              }
                            ]
                          }
                        },
                        "internal": {
                          "time": {
                            "conditions": [
                              {
                                "operator": "OPERATOR_UNSPECIFIED",
                                "value": "string"
                              }
                            ]
                          }
                        }
                      },
                      "quoteName": "string"
                    }
                  },
                  "linearSlippageFactor": "string",
                  "liquidityMonitoringParameters": {
                    "auctionExtension": "string",
                    "targetStakeParameters": {
                      "scalingFactor": 0,
                      "timeWindow": "string"
                    },
                    "triggeringRatio": "string"
                  },
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "lpPriceRange": "string",
                  "metadata": [
                    "string"
                  ],
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "quadraticSlippageFactor": "string",
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  }
                },
                "marketId": "string"
              },
              "updateNetworkParameter": {
                "changes": {
                  "key": "string",
                  "value": "string"
                }
              },
              "updateSpotMarket": {
                "changes": {
                  "logNormal": {
                    "params": {
                      "mu": 0,
                      "r": 0,
                      "sigma": 0
                    },
                    "riskAversionParameter": 0,
                    "tau": 0
                  },
                  "metadata": [
                    "string"
                  ],
                  "priceMonitoringParameters": {
                    "triggers": [
                      {
                        "auctionExtension": "string",
                        "horizon": "string",
                        "probability": "string"
                      }
                    ]
                  },
                  "simple": {
                    "factorLong": 0,
                    "factorShort": 0,
                    "maxMoveUp": 0,
                    "minMoveDown": 0,
                    "probabilityOfTrading": 0
                  },
                  "targetStakeParameters": {
                    "scalingFactor": 0,
                    "timeWindow": "string"
                  }
                },
                "marketId": "string"
              },
              "validationTimestamp": "string"
            }
          },
          "protocolUpgradeProposal": {
            "upgradeBlockHeight": "string",
            "vegaReleaseTag": "string"
          },
          "transfer": {
            "amount": "string",
            "asset": "string",
            "fromAccountType": "ACCOUNT_TYPE_UNSPECIFIED",
            "oneOff": {
              "deliverOn": "string"
            },
            "recurring": {
              "dispatchStrategy": {
                "assetForMetric": "string",
                "markets": [
                  "string"
                ],
                "metric": "DISPATCH_METRIC_UNSPECIFIED"
              },
              "endEpoch": "string",
              "factor": "string",
              "startEpoch": "string"
            },
            "reference": "string",
            "to": "string",
            "toAccountType": "ACCOUNT_TYPE_UNSPECIFIED"
          },
          "undelegateSubmission": {
            "amount": "string",
            "method": "METHOD_UNSPECIFIED",
            "nodeId": "string"
          },
          "voteSubmission": {
            "proposalId": "string",
            "value": "VALUE_UNSPECIFIED"
          },
          "withdrawSubmission": {
            "amount": "string",
            "asset": "string",
            "ext": {
              "erc20": {
                "receiverAddress": "string"
              }
            }
          }
        },
        "txHash": "string",
        "type": "BUS_EVENT_TYPE_UNSPECIFIED",
        "validatorScore": {
          "epochSeq": "string",
          "multisigScore": "string",
          "nodeId": "string",
          "normalisedScore": "string",
          "rawValidatorScore": "string",
          "validatorPerformance": "string",
          "validatorScore": "string",
          "validatorStatus": "string"
        },
        "validatorUpdate": {
          "added": true,
          "avatarUrl": "string",
          "country": "string",
          "epochSeq": "string",
          "ethereumAddress": "string",
          "fromEpoch": "string",
          "infoUrl": "string",
          "name": "string",
          "nodeId": "string",
          "submitterAddress": "string",
          "tmPubKey": "string",
          "vegaPubKey": "string",
          "vegaPubKeyIndex": 0
        },
        "version": 0,
        "vote": {
          "partyId": "string",
          "proposalId": "string",
          "timestamp": "string",
          "totalEquityLikeShareWeight": "string",
          "totalGovernanceTokenBalance": "string",
          "totalGovernanceTokenWeight": "string",
          "value": "VALUE_UNSPECIFIED"
        },
        "withdrawal": {
          "amount": "string",
          "asset": "string",
          "createdTimestamp": "string",
          "ext": {
            "erc20": {
              "receiverAddress": "string"
            }
          },
          "id": "string",
          "partyId": "string",
          "ref": "string",
          "status": "STATUS_UNSPECIFIED",
          "txHash": "string",
          "withdrawnTimestamp": "string"
        }
      }
    ]
  }
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
Array [
@type string
]
message string

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

Loading...