List transactions
List transactions from the Vega blockchain
Query Parameters
Number of transactions to be returned from the blockchain. This is deprecated, use first and last instead.
Optional cursor to paginate the request.
Optional cursor to paginate the request.
Transaction command types filter, for listing transactions with specified command types.
Transaction command types exclusion filter, for listing all the transactions except the ones with specified command types.
Party IDs filter, can be sender or receiver.
Number of transactions to be returned from the blockchain. Use in conjunction with the after cursor to paginate forwards.
On its own, this will return the first first transactions.
Number of transactions to be returned from the blockchain. Use in conjunction with the before cursor to paginate backwards.
On its own, this will return the last last transactions.
- 200
- default
A successful response.
Schema
- Array [
- Array [
- 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.
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- 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.
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ACCOUNT_TYPE_UNSPECIFIED: Default value
- ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
- ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
- ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
- ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
- ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
- ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
- ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
- ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
- ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
- ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
- ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
- ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
- ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
- ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
- ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
- ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
- ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
- ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
- ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
- ACCOUNT_TYPE_UNSPECIFIED: Default value
- ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
- ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
- ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'
- ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with
- ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
- ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
- ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
- ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
- ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
- ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
- ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
- ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
- ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
- ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
- ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
- ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
- ACCOUNT_TYPE_HOLDING: Per asset account for holding in-flight unfilled orders' funds
- ACCOUNT_TYPE_LP_LIQUIDITY_FEES: Network controlled liquidity provider's account, per market, to hold accrued liquidity fees.
- ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION: Network controlled liquidity fees bonus distribution account, per market.
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- ]
transactions object[]
command object
announceNode object
Command used by a node operator to announce its node as a pending validator.
AvatarURL of the validator.
Public key for the blockchain, required field.
Country code (ISO 3166-1 alpha-2) for the location of the node.
Ethereum public key, required field.
ethereumSignature object
Signature from the validator made using the ethereum wallet.
Algorithm used to create the signature.
Hex encoded bytes of the signature.
Version of the signature used to create the signature.
Epoch from which the validator is expected to be ready to validate blocks.
Node ID of the validator, i.e. the node's public master key.
URL with more info on the node.
Name of the validator.
Ethereum public key to use as a submitter to allow automatic signature generation.
Vega public key, required field.
Vega public key derivation index.
vegaSignature object
Signature from the validator made using the Vega wallet.
Algorithm used to create the signature.
Hex encoded bytes of the signature.
Version of the signature used to create the signature.
batchMarketInstructions object
Command to submit a batch of order instructions to a market.
amendments object[]
List of order amendments to be processed sequentially.
Amend the expiry time for the order, if the Timestamp value is set, otherwise expiry time will remain unchanged.
Market ID, this is required to find the order and will not be updated.
Order ID, this is required to find the order and will not be updated, required field.
Amend the pegged order offset for the order. This field is an unsigned integer scaled to the market's decimal places.
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.
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.
Amend the size for the order by the delta specified:
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.
Market ID for the order, required field.
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.
Optional market ID.
Optional order ID.
stopOrdersSubmission object[]
List of stop order submissions to be processed sequentially.
fallsBelow object
Stop order that will be triggered if the price falls below a given trigger price.
Optional expiry timestamp.
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.
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.
Minimum allowed remaining size of the order before it is replenished back to its peak size.
Size of the order that is made visible and can be traded with during the execution of a single order.
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
Offset from the price reference.
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.
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
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.
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 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.
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 for the order, for example, in a futures market the size equals the number of units, cannot be negative.
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.
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
Fixed price at which the order will be submitted.
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.
Optional expiry timestamp.
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.
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.
Minimum allowed remaining size of the order before it is replenished back to its peak size.
Size of the order that is made visible and can be traded with during the execution of a single order.
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
Offset from the price reference.
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.
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
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.
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 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.
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 for the order, for example, in a futures market the size equals the number of units, cannot be negative.
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.
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
Fixed price at which the order will be submitted.
Trailing percentage at which the order will be submitted.
submissions object[]
List of order submissions to be processed sequentially.
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.
Minimum allowed remaining size of the order before it is replenished back to its peak size.
Size of the order that is made visible and can be traded with during the execution of a single order.
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
Offset from the price reference.
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.
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
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.
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 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.
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 for the order, for example, in a futures market the size equals the number of units, cannot be negative.
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.
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
Block height at which the transaction was made.
This should be the current block height. The transaction will be valid
from the block and up to the tolerance block height.
Example: If the network has a tolerance of 150 blocks and block_height
is set to 200, then the transaction will be valid until block 350.
Note that a block_height that is ahead of the real block height will be
rejected. The tolerance can be queried from the chain's network parameters.
block_height prevents replay attacks in conjunction with nonce (see above).
cancelTransfer object
Command to request cancelling a recurring transfer.
Transfer ID of the transfer to cancel.
chainEvent object
Command used by a validator to submit an event forwarded to the Vega network to provide information on events happening on other networks, to be used by a foreign chain to recognise a decision taken by the Vega network.
builtin object
Built-in asset event.
deposit object
Built-in asset deposit.
Amount to be deposited. This field is an unsigned integer scaled to the asset's decimal places.
Vega party ID i.e. public key.
Vega network internal asset ID.
withdrawal object
Built-in asset withdrawal.
The amount to be withdrawn. This field is an unsigned integer scaled to the asset's decimal places.
Vega network party ID i.e. public key.
Vega network internal asset ID.
contractCall object
Ethereum block height.
Ethereum block time in Unix seconds.
Result of contract call, packed according to the ABI stored in the associated data source spec.
ID of the data source spec that triggered this contract call.
erc20 object
Ethereum ERC20 event.
assetDelist object
De-list an ERC20 asset.
Vega network internal asset ID.
assetLimitsUpdated object
Update an ERC20 asset.
Updated lifetime limits.
Ethereum wallet that initiated the deposit.
Vega network internal asset ID.
Updated withdrawal threshold.
assetList object
List an ERC20 asset.
Ethereum address of the asset.
Vega network internal asset ID.
Block in which the transaction was added.
Bridge operations has been resumed.
Bridge operations has been stopped.
deposit object
Deposit ERC20 asset.
Amount to be deposited.
Ethereum wallet that initiated the deposit.
Vega party ID i.e. public key that is the target of the deposit.
Vega network internal asset ID.
Index of the log in the transaction.
withdrawal object
Withdraw ERC20 asset.
Reference nonce used for the transaction.
Target Ethereum wallet address.
Vega network internal asset ID.
erc20Multisig object
Ethereum ERC20 multisig event.
signerAdded object
Time at which the block was produced will be used to inform the core at what time the stake was made unavailable.
signerRemoved object
Time at which the block was produced. Will be used to inform the core at what time the stake was made unavailable.
thresholdSet object
Time at which the block was produced. Will be used to inform the core at what time the stake was made unavailable.
Arbitrary one-time integer used to prevent replay attacks.
stakingEvent object
Ethereum Staking event.
Block in which the transaction was added.
Index of the log in the transaction.
stakeDeposited object
Amount deposited as an unsigned base 10 integer scaled to the asset's decimal places.
Time at which the block was produced. Will be used to inform the core at what time the stake started to be available.
Hex encoded public key of the party receiving the stake deposit.
stakeRemoved object
Amount removed as a base 10 unsigned integer scaled to the asset's decimal places.
The time at which the block was produced will be used to inform the core at what time the stake was made unavailable.
Ethereum address of the user removing stake. This should be hex encoded with 0x prefix.
Hex encoded public key of the party from which to remove stake.
totalSupply object
Total supply observed for the token as an unsigned based 10 integer scaled to the asset's decimal places.
Transaction ID of the transaction in which the events happened, usually a hash.
delegateSubmission object
Command to delegate tokens to a validator.
Amount of stake to delegate. This field is an unsigned integer scaled to the asset's decimal places.
Delegate to the specified node ID.
ethereumKeyRotateSubmission object
Command used by a validator to allow given validator to rotate their Ethereum keys.
Currently used public address.
ethereumSignature object
Signature that can be verified using the new ethereum address.
Algorithm used to create the signature.
Hex encoded bytes of the signature.
Version of the signature used to create the signature.
New address to rotate to.
Ethereum public key to use as a submitter to allow automatic signature generation.
Target block at which the key rotation will take effect on.
issueSignatures object
Command used by a validator to submit signatures to a smart contract.
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.
Ethereum address which will submit the signatures to the smart contract.
Node ID of the validator node that will be signed in or out of the smart contract.
keyRotateSubmission object
Command used by a validator to allow given validator to rotate their Vega keys.
Hash of currently used public key.
New public key to rotate to.
New Vega public key derivation index.
Target block at which the key rotation will take effect on.
liquidityProvisionAmendment object
Command to request amending a liquidity commitment.
buys object[]
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
Relative proportion of the commitment to be allocated at a price level.
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.
From here at least one of the following is required to consider the command valid.
Unique ID for the market with the liquidity provision to be amended.
sells object[]
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
Relative proportion of the commitment to be allocated at a price level.
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
Command to request cancelling a liquidity commitment.
Unique ID for the market with the liquidity provision to be cancelled.
liquidityProvisionSubmission object
Command to submit a liquidity commitment.
buys object[]
Set of liquidity buy orders to meet the liquidity provision obligation.
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
Relative proportion of the commitment to be allocated at a price level.
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.
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.
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.
Market ID for the order.
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.
Offset/amount of units away for the order. This field is an unsigned integer scaled using the market's decimal places.
Relative proportion of the commitment to be allocated at a price level.
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.
nodeSignature object
Command used by a validator to submit a signature, to be used by a foreign chain to recognise a decision taken by the Vega network.
ID of the resource being signed.
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.
The signature generated by the signer.
nodeVote object
Command used by a validator when a node votes for validating that a given resource exists or is valid, for example, an ERC20 deposit is valid and exists on ethereum.
Reference identifying the resource making the vote, required field.
Possible values: [TYPE_UNSPECIFIED, TYPE_STAKE_DEPOSITED, TYPE_STAKE_REMOVED, TYPE_FUNDS_DEPOSITED, TYPE_SIGNER_ADDED, TYPE_SIGNER_REMOVED, TYPE_BRIDGE_STOPPED, TYPE_BRIDGE_RESUMED, TYPE_ASSET_LISTED, TYPE_LIMITS_UPDATED, TYPE_STAKE_TOTAL_SUPPLY, TYPE_SIGNER_THRESHOLD_SET, TYPE_GOVERNANCE_VALIDATE_ASSET]
Default value: TYPE_UNSPECIFIED
Type of NodeVote, also required.
Number to provide uniqueness to prevent accidental replays and,
in combination with block_height, deliberate attacks.
A nonce provides uniqueness for otherwise identical transactions,
ensuring that the transaction hash uniquely identifies a specific transaction.
Granted all other fields are equal, the nonce can either be a counter
or generated at random to submit multiple transactions within the same
block (see below), without being identified as replays.
Please note that Protocol Buffers do not have a canonical, unique encoding
and therefore different libraries or binaries may encode the same message
slightly differently, causing a different hash.
oracleDataSubmission object
Command to submit new oracle data from third party providers.
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.
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
Command to amend an order.
Amend the expiry time for the order, if the Timestamp value is set, otherwise expiry time will remain unchanged.
Market ID, this is required to find the order and will not be updated.
Order ID, this is required to find the order and will not be updated, required field.
Amend the pegged order offset for the order. This field is an unsigned integer scaled to the market's decimal places.
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.
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.
Amend the size for the order by the delta specified:
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
Command to cancel an order.
Market ID for the order, required field.
Unique ID for the order. This is set by the system after consensus. Required field.
orderSubmission object
Command for submitting an order.
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.
Minimum allowed remaining size of the order before it is replenished back to its peak size.
Size of the order that is made visible and can be traded with during the execution of a single order.
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
Offset from the price reference.
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.
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
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.
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 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.
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 for the order, for example, in a futures market the size equals the number of units, cannot be negative.
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.
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
proposalSubmission object
Command to submit a governance proposal.
rationale object
Rationale behind a proposal.
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 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 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
ID of the governance transfer proposal.
Timestamp as Unix time in seconds when voting closes for this proposal,
constrained by minClose and maxClose network parameters.
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.
Maximum amount that can be requested by a party through the built-in asset faucet at a time.
Number of decimal / precision handled by this asset.
erc20 object
Ethereum ERC20 asset.
Address of the contract for the token, on the ethereum network.
Lifetime limits deposit per address note: this is a temporary measure that can be changed by governance.
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 of the asset (e.g: Great British Pound).
Minimum economically meaningful amount in the asset.
Symbol of the asset (e.g: GBP).
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.
Decimal places used for the new futures market, sets the smallest price increment on the book.
instrument object
New futures market instrument configuration.
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.
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.
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
Data source spec describing the data source for settlement.
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.
The ABI of that contract.
Ethereum address of the contract to call.
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.
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.
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
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).
conditions object[]
Conditions that should be matched by the data to be considered of interest.
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 to be compared with by the operator.
key object
Data source's data property key targeted by the filter.
Name of the property.
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.
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
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.
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.
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 to be compared with by the operator.
dataSourceSpecForTradingTermination object
The external data source spec describing the data source of trading termination.
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.
The ABI of that contract.
Ethereum address of the contract to call.
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.
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.
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
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).
conditions object[]
Conditions that should be matched by the data to be considered of interest.
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 to be compared with by the operator.
key object
Data source's data property key targeted by the filter.
Name of the property.
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.
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
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.
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.
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 to be compared with by the operator.
Product quote name.
Asset ID for the product's settlement asset.
Instrument name.
spot object
Spot.
Base asset ID.
Product name.
Quote asset ID.
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.
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.
Specifies scaling factors used in target stake calculation.
Specifies length of time window expressed in seconds for target stake calculation.
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 parameter, annualised growth rate of the underlying asset.
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
Risk Aversion Parameter.
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.
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.
Optional new futures market metadata, tags.
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[]
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
Price monitoring projection horizon τ in seconds.
Price monitoring probability level p.
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.
Pre-defined risk factor value for long.
Pre-defined risk factor value for short.
Pre-defined maximum price move up that the model considers as valid.
Pre-defined minimum price move down that the model considers as valid.
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.
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.
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.
Decimal places used for the new spot market, sets the smallest price increment on the book.
instrument object
New spot market instrument configuration.
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.
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.
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
Data source spec describing the data source for settlement.
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.
The ABI of that contract.
Ethereum address of the contract to call.
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.
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.
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
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).
conditions object[]
Conditions that should be matched by the data to be considered of interest.
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 to be compared with by the operator.
key object
Data source's data property key targeted by the filter.
Name of the property.
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.
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
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.
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.
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 to be compared with by the operator.
dataSourceSpecForTradingTermination object
The external data source spec describing the data source of trading termination.
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.
The ABI of that contract.
Ethereum address of the contract to call.
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.
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.
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
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).
conditions object[]
Conditions that should be matched by the data to be considered of interest.
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 to be compared with by the operator.
key object
Data source's data property key targeted by the filter.
Name of the property.
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.
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
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.
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.
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 to be compared with by the operator.
Product quote name.
Asset ID for the product's settlement asset.
Instrument name.
spot object
Spot.
Base asset ID.
Product name.
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 parameter, annualised growth rate of the underlying asset.
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
Risk Aversion Parameter.
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.
Optional new spot market metadata, tags.
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[]
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
Price monitoring projection horizon τ in seconds.
Price monitoring probability level p.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
Pre-defined risk factor value for long.
Pre-defined risk factor value for short.
Pre-defined maximum price move up that the model considers as valid.
Pre-defined minimum price move down that the model considers as valid.
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
Specifies scaling factors used in target stake calculation.
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.
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
Margin account funds will vary as margin requirements on positions change
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
oneOff object
Timestamp in Unix nanoseconds for when the transfer should be delivered into the receiver's account.
recurring object
Last epoch at which this transfer shall be paid.
First epoch from which this transfer shall be paid.
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
Margin account funds will vary as margin requirements on positions change
General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements
Possible values: [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.
Asset ID the update is for.
changes object
Changes to apply on an existing asset.
erc20 object
Ethereum ERC20 asset update.
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.
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.
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.
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.
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.
Name of the property in the data source data that signals termination of trading.
dataSourceSpecForSettlementData object
The data source spec describing the data of settlement data.
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.
The ABI of that contract.
Ethereum address of the contract to call.
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.
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.
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
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).
conditions object[]
Conditions that should be matched by the data to be considered of interest.
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 to be compared with by the operator.
key object
Data source's data property key targeted by the filter.
Name of the property.
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.
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
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.
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.
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 to be compared with by the operator.
dataSourceSpecForTradingTermination object
The data source spec describing the data source for trading termination.
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.
The ABI of that contract.
Ethereum address of the contract to call.
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.
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.
Repeat the call every n seconds after the inital call. If no time for initial call was specified, begin repeating immediately.
Trigger when the Ethereum time is greater or equal to this time, in Unix seconds.
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).
conditions object[]
Conditions that should be matched by the data to be considered of interest.
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 to be compared with by the operator.
key object
Data source's data property key targeted by the filter.
Name of the property.
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.
ethAddress object
In case of an open oracle - Ethereum address will be submitted.
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.
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.
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 to be compared with by the operator.
Human-readable name/abbreviation of the quote name.
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.
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.
Specifies scaling factors used in target stake calculation.
Specifies length of time window expressed in seconds for target stake calculation.
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 parameter, annualised growth rate of the underlying asset.
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
Risk Aversion Parameter.
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.
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.
Optional futures market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
Price monitoring projection horizon τ in seconds.
Price monitoring probability level p.
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.
Pre-defined risk factor value for long.
Pre-defined risk factor value for short.
Pre-defined maximum price move up that the model considers as valid.
Pre-defined minimum price move down that the model considers as valid.
Pre-defined constant probability of trading.
Market ID the update is for.
updateNetworkParameter object
Proposal change for updating Vega network parameters.
changes object
The network parameter to update.
Unique key of the network parameter.
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 parameter, annualised growth rate of the underlying asset.
R parameter, annualised growth rate of the risk-free asset, used for discounting of future cash flows, can be any real number.
Sigma parameter, annualised volatility of the underlying asset, must be a strictly non-negative real number.
Risk Aversion Parameter.
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.
Optional spot market metadata, tags.
priceMonitoringParameters object
Price monitoring parameters.
triggers object[]
Price monitoring auction extension duration in seconds should the price breach its theoretical level over the specified horizon at the specified probability level.
Price monitoring projection horizon τ in seconds.
Price monitoring probability level p.
simple object
Simple risk model parameters, valid only if MODEL_SIMPLE is selected.
Pre-defined risk factor value for long.
Pre-defined risk factor value for short.
Pre-defined maximum price move up that the model considers as valid.
Pre-defined minimum price move down that the model considers as valid.
Pre-defined constant probability of trading.
targetStakeParameters object
Specifies parameters related to target stake calculation.
Specifies scaling factors used in target stake calculation.
Specifies length of time window expressed in seconds for target stake calculation.
Market ID the update is for.
Validation timestamp as Unix time in seconds.
protocolUpgradeProposal object
Command used by a validator to propose a protocol upgrade.
Block height at which to perform the upgrade.
Release tag for the Vega binary.
stateVariableProposal object
Command used by a validator to submit a floating point value.
proposal object
State value proposal details.
Event ID.
kvb object[]
Key value tolerance triplets.
value object
matrixVal object
value object[]
scalarVal object
vectorVal object
State variable ID.
stopOrdersCancellation object
Command to cancel stop orders.
Optional market ID.
Optional order ID.
stopOrdersSubmission object
Command to submit a pair of stop orders.
fallsBelow object
Stop order that will be triggered if the price falls below a given trigger price.
Optional expiry timestamp.
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.
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.
Minimum allowed remaining size of the order before it is replenished back to its peak size.
Size of the order that is made visible and can be traded with during the execution of a single order.
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
Offset from the price reference.
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.
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
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.
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 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.
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 for the order, for example, in a futures market the size equals the number of units, cannot be negative.
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.
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
Fixed price at which the order will be submitted.
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.
Optional expiry timestamp.
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.
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.
Minimum allowed remaining size of the order before it is replenished back to its peak size.
Size of the order that is made visible and can be traded with during the execution of a single order.
Market ID for the order, required field.
peggedOrder object
Used to specify the details for a pegged order.
Offset from the price reference.
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.
Only valid for Limit orders. Cannot be True at the same time as Reduce-Only.
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.
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 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.
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 for the order, for example, in a futures market the size equals the number of units, cannot be negative.
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.
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
Default value: TYPE_UNSPECIFIED
Type for the order, required field - See Order.Type.
Fixed price at which the order will be submitted.
Trailing percentage at which the order will be submitted.
transfer object
Command to submit a transfer.
Amount to be taken from the source account. This field is an unsigned integer scaled to the asset's decimal places.
Asset ID of the asset to be transferred.
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
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.
Asset to use for metric.
Optional markets in scope.
Possible values: [DISPATCH_METRIC_UNSPECIFIED, DISPATCH_METRIC_MAKER_FEES_PAID, DISPATCH_METRIC_MAKER_FEES_RECEIVED, DISPATCH_METRIC_LP_FEES_RECEIVED, DISPATCH_METRIC_MARKET_VALUE]
Default value: DISPATCH_METRIC_UNSPECIFIED
Metric to apply.
Last epoch at which this transfer shall be paid.
Factor needs to be > 0.
First epoch from which this transfer shall be paid.
Reference to be attached to the transfer.
Public key of the destination account.
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
Command to remove tokens delegated to a validator.
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.
Possible values: [METHOD_UNSPECIFIED, METHOD_NOW, METHOD_AT_END_OF_EPOCH]
Default value: METHOD_UNSPECIFIED
Method of delegation.
Node ID to delegate to.
validatorHeartbeat object
Command used by a validator to signal they are still online and validating blocks or ready to validate blocks when they are still a pending validator.
ethereumSignature object
Signature from the validator made using the ethereum wallet.
Algorithm used to create the signature.
Hex encoded bytes of the signature.
Version of the signature used to create the signature.
Message which has been signed.
Node ID of the validator emitting the heartbeat.
vegaSignature object
Signature from the validator made using the vega wallet.
Algorithm used to create the signature.
Hex encoded bytes of the signature.
Version of the signature used to create the signature.
voteSubmission object
Command to submit a vote on a governance proposal.
Submit vote for the specified proposal ID.
Possible values: [VALUE_UNSPECIFIED, VALUE_NO, VALUE_YES]
Default value: VALUE_UNSPECIFIED
Actual value of the vote.
withdrawSubmission object
Command to submit a withdrawal.
Amount to be withdrawn. This field is an unsigned integer scaled to the asset's decimal places.
Asset to be withdrawn.
ext object
Foreign chain specifics.
erc20 object
ERC20 withdrawal details.
Address into which the bridge will release the funds.
signature object
Signature to authenticate a transaction and to be verified by the Vega network.
Algorithm used to create the signature.
Hex encoded bytes of the signature.
Version of the signature used to create the signature.
{
"transactions": [
{
"block": "string",
"code": 0,
"command": {
"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"
}
]
},
"blockHeight": "string",
"cancelTransfer": {
"transferId": "string"
},
"chainEvent": {
"builtin": {
"deposit": {
"amount": "string",
"partyId": "string",
"vegaAssetId": "string"
},
"withdrawal": {
"amount": "string",
"partyId": "string",
"vegaAssetId": "string"
}
},
"contractCall": {
"blockHeight": "string",
"blockTime": "string",
"result": "string",
"specId": "string"
},
"erc20": {
"assetDelist": {
"vegaAssetId": "string"
},
"assetLimitsUpdated": {
"lifetimeLimits": "string",
"sourceEthereumAddress": "string",
"vegaAssetId": "string",
"withdrawThreshold": "string"
},
"assetList": {
"assetSource": "string",
"vegaAssetId": "string"
},
"block": "string",
"bridgeResumed": true,
"bridgeStopped": true,
"deposit": {
"amount": "string",
"sourceEthereumAddress": "string",
"targetPartyId": "string",
"vegaAssetId": "string"
},
"index": "string",
"withdrawal": {
"referenceNonce": "string",
"targetEthereumAddress": "string",
"vegaAssetId": "string"
}
},
"erc20Multisig": {
"block": "string",
"index": "string",
"signerAdded": {
"blockTime": "string",
"newSigner": "string",
"nonce": "string"
},
"signerRemoved": {
"blockTime": "string",
"nonce": "string",
"oldSigner": "string"
},
"thresholdSet": {
"blockTime": "string",
"newThreshold": 0,
"nonce": "string"
}
},
"nonce": "string",
"stakingEvent": {
"block": "string",
"index": "string",
"stakeDeposited": {
"amount": "string",
"blockTime": "string",
"ethereumAddress": "string",
"vegaPublicKey": "string"
},
"stakeRemoved": {
"amount": "string",
"blockTime": "string",
"ethereumAddress": "string",
"vegaPublicKey": "string"
},
"totalSupply": {
"tokenAddress": "string",
"totalSupply": "string"
}
},
"txId": "string"
},
"delegateSubmission": {
"amount": "string",
"nodeId": "string"
},
"ethereumKeyRotateSubmission": {
"currentAddress": "string",
"ethereumSignature": {
"algo": "string",
"value": "string",
"version": 0
},
"newAddress": "string",
"submitterAddress": "string",
"targetBlock": "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"
}
]
},
"nodeSignature": {
"id": "string",
"kind": "NODE_SIGNATURE_KIND_UNSPECIFIED",
"sig": "string"
},
"nodeVote": {
"reference": "string",
"type": "TYPE_UNSPECIFIED"
},
"nonce": "string",
"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"
},
"proposalSubmission": {
"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"
},
"stateVariableProposal": {
"proposal": {
"eventId": "string",
"kvb": [
{
"key": "string",
"tolerance": "string",
"value": {
"matrixVal": {
"value": [
{
"value": [
"string"
]
}
]
},
"scalarVal": {
"value": "string"
},
"vectorVal": {
"value": [
"string"
]
}
}
}
],
"stateVarId": "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"
}
},
"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"
},
"validatorHeartbeat": {
"ethereumSignature": {
"algo": "string",
"value": "string",
"version": 0
},
"message": "string",
"nodeId": "string",
"vegaSignature": {
"algo": "string",
"value": "string",
"version": 0
}
},
"voteSubmission": {
"proposalId": "string",
"value": "VALUE_UNSPECIFIED"
},
"withdrawSubmission": {
"amount": "string",
"asset": "string",
"ext": {
"erc20": {
"receiverAddress": "string"
}
}
}
},
"cursor": "string",
"error": "string",
"hash": "string",
"index": 0,
"signature": {
"algo": "string",
"value": "string",
"version": 0
},
"submitter": "string",
"type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}