Skip to main content
Version: release (v0.77)

Observe ledger movements

GET 
/api/v2/stream/ledger/movements

Subscribe to a stream of transfer responses

Responses​

A successful response.(streaming responses)

Schema
    error object
    code int32
    details object[]
  • Array [
    • @type string

    A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

    In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

    • If no scheme is provided, https is assumed.
    • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
    • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

    Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

    Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • ]
    • message string
    result object
    ledgerMovement object

    Ledger movements data with list of ledger entries and post-transfer balances.

    balances object[]

    Resulting balances once the ledger movement are applied.

  • Array [
    • account object

    Account relating to the transfer.

    assetId string

    Asset ID of the asset for this account.

    marketId string

    Not specified if account is not related to a market.

    owner string

    Not specified if network account.

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

    Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION, ACCOUNT_TYPE_NETWORK_TREASURY, ACCOUNT_TYPE_VESTING_REWARDS, ACCOUNT_TYPE_VESTED_REWARDS, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD, ACCOUNT_TYPE_ORDER_MARGIN, ACCOUNT_TYPE_REWARD_REALISED_RETURN]

    Default value: ACCOUNT_TYPE_UNSPECIFIED

    Type of the account.

    balance string

    Balance relating to the transfer. This field is an unsigned integer scaled to the asset's decimal places.

  • ]
    • entries object[]

    All the entries for these ledger movements.

  • Array [
    • amount string

    Amount to transfer. This field is an unsigned integer scaled to the asset's decimal places.

    fromAccount object

    One or more accounts to transfer from.

    assetId string

    Asset ID of the asset for this account.

    marketId string

    Not specified if account is not related to a market.

    owner string

    Not specified if network account.

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

    Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION, ACCOUNT_TYPE_NETWORK_TREASURY, ACCOUNT_TYPE_VESTING_REWARDS, ACCOUNT_TYPE_VESTED_REWARDS, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD, ACCOUNT_TYPE_ORDER_MARGIN, ACCOUNT_TYPE_REWARD_REALISED_RETURN]

    Default value: ACCOUNT_TYPE_UNSPECIFIED

    Type of the account.

    fromAccountBalance string

    Sender account balance after the transfer. This field is an unsigned integer scaled to the asset's decimal places.

    timestamp int64

    Timestamp in nanoseconds of when the ledger entry was created.

    toAccount object

    One or more accounts to transfer to.

    assetId string

    Asset ID of the asset for this account.

    marketId string

    Not specified if account is not related to a market.

    owner string

    Not specified if network account.

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

    Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS, ACCOUNT_TYPE_HOLDING, ACCOUNT_TYPE_LP_LIQUIDITY_FEES, ACCOUNT_TYPE_LIQUIDITY_FEES_BONUS_DISTRIBUTION, ACCOUNT_TYPE_NETWORK_TREASURY, ACCOUNT_TYPE_VESTING_REWARDS, ACCOUNT_TYPE_VESTED_REWARDS, ACCOUNT_TYPE_REWARD_AVERAGE_POSITION, ACCOUNT_TYPE_REWARD_RELATIVE_RETURN, ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY, ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING, ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD, ACCOUNT_TYPE_ORDER_MARGIN, ACCOUNT_TYPE_REWARD_REALISED_RETURN]

    Default value: ACCOUNT_TYPE_UNSPECIFIED

    Type of the account.

    toAccountBalance string

    Receiver account balance after the transfer. This field is an unsigned integer scaled to the asset's decimal places.

    transferId string

    Transfer ID the ledger entry relates to.

    type Transfers can occur between parties on Vega, these are the types that indicate why a transfer took place (string)

    Possible values: [TRANSFER_TYPE_UNSPECIFIED, TRANSFER_TYPE_LOSS, TRANSFER_TYPE_WIN, TRANSFER_TYPE_MTM_LOSS, TRANSFER_TYPE_MTM_WIN, TRANSFER_TYPE_MARGIN_LOW, TRANSFER_TYPE_MARGIN_HIGH, TRANSFER_TYPE_MARGIN_CONFISCATED, TRANSFER_TYPE_MAKER_FEE_PAY, TRANSFER_TYPE_MAKER_FEE_RECEIVE, TRANSFER_TYPE_INFRASTRUCTURE_FEE_PAY, TRANSFER_TYPE_INFRASTRUCTURE_FEE_DISTRIBUTE, TRANSFER_TYPE_LIQUIDITY_FEE_PAY, TRANSFER_TYPE_LIQUIDITY_FEE_DISTRIBUTE, TRANSFER_TYPE_BOND_LOW, TRANSFER_TYPE_BOND_HIGH, TRANSFER_TYPE_WITHDRAW, TRANSFER_TYPE_DEPOSIT, TRANSFER_TYPE_BOND_SLASHING, TRANSFER_TYPE_REWARD_PAYOUT, TRANSFER_TYPE_TRANSFER_FUNDS_SEND, TRANSFER_TYPE_TRANSFER_FUNDS_DISTRIBUTE, TRANSFER_TYPE_CLEAR_ACCOUNT, TRANSFER_TYPE_CHECKPOINT_BALANCE_RESTORE, TRANSFER_TYPE_SPOT, TRANSFER_TYPE_HOLDING_LOCK, TRANSFER_TYPE_HOLDING_RELEASE, TRANSFER_TYPE_SUCCESSOR_INSURANCE_FRACTION, TRANSFER_TYPE_LIQUIDITY_FEE_ALLOCATE, TRANSFER_TYPE_LIQUIDITY_FEE_NET_DISTRIBUTE, TRANSFER_TYPE_SLA_PENALTY_BOND_APPLY, TRANSFER_TYPE_SLA_PENALTY_LP_FEE_APPLY, TRANSFER_TYPE_LIQUIDITY_FEE_UNPAID_COLLECT, TRANSFER_TYPE_SLA_PERFORMANCE_BONUS_DISTRIBUTE, TRANSFER_TYPE_PERPETUALS_FUNDING_LOSS, TRANSFER_TYPE_PERPETUALS_FUNDING_WIN, TRANSFER_TYPE_REWARDS_VESTED, TRANSFER_TYPE_FEE_REFERRER_REWARD_PAY, TRANSFER_TYPE_FEE_REFERRER_REWARD_DISTRIBUTE, TRANSFER_TYPE_ORDER_MARGIN_LOW, TRANSFER_TYPE_ORDER_MARGIN_HIGH, TRANSFER_TYPE_ISOLATED_MARGIN_LOW, TRANSFER_TYPE_ISOLATED_MARGIN_HIGH, TRANSFER_TYPE_AMM_LOW, TRANSFER_TYPE_AMM_HIGH, TRANSFER_TYPE_AMM_RELEASE]

    Default value: TRANSFER_TYPE_UNSPECIFIED

    Transfer type for this entry.

  • ]
Loading...