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

List balance changes​

Get a list of the changes in account balances over a period of time.

An account is defined as a set of asset_id, type, party_id, and market_id.

  • Every account has an associated asset and type.
  • Certain account types such as the global reward pool for example, do not have an associated party. These are denoted by the special party ID 'network'
  • Certain account types do not have an associated market such as the general party accounts, for example. These are denoted by the special market ID '' (the empty string)

ListBalanceChangesRequest will return a list of AggregatedBalance records, with a row for each block at which a given account's balance changes.

Query Parameters
    filter.assetId string

    Restrict accounts to those holding balances in this asset ID.

    filter.partyIds string[]

    Restrict accounts to those owned by the parties in this list. Pass an empty list for no filter.

    filter.marketIds string[]

    Restrict accounts to those connected to the markets in this list. Pass an empty list for no filter.

    filter.accountTypes 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]

    Restrict accounts to those connected to any of the types in this list. Pass an empty list for no filter.

    • ACCOUNT_TYPE_UNSPECIFIED: Default value
    • ACCOUNT_TYPE_INSURANCE: Insurance pool accounts contain insurance pool funds for a market
    • ACCOUNT_TYPE_SETTLEMENT: Settlement accounts exist only during settlement or mark-to-market
    • ACCOUNT_TYPE_MARGIN: Margin accounts contain funds set aside for the margin needed to support a party's open positions. Each party will have a margin account for each market they have traded in. Required initial margin is allocated to each market from user's general account. Collateral in the margin account can't be withdrawn or used as margin on another market until it is released back to the general account. Vega protocol uses an internal accounting system to segregate funds held as margin from other funds to ensure they are never lost or 'double spent'

    Margin account funds will vary as margin requirements on positions change

    • ACCOUNT_TYPE_GENERAL: General accounts contain the collateral for a party that is not otherwise allocated. A party will have multiple general accounts, one for each asset they want to trade with

    General accounts are where funds are initially deposited or withdrawn from, it is also the account where funds are taken to fulfil fees and initial margin requirements

    • ACCOUNT_TYPE_FEES_INFRASTRUCTURE: Infrastructure accounts contain fees earned by providing infrastructure on Vega
    • ACCOUNT_TYPE_FEES_LIQUIDITY: Liquidity accounts contain fees earned by providing liquidity on Vega markets
    • ACCOUNT_TYPE_FEES_MAKER: This account is created to hold fees earned by placing orders that sit on the book and are then matched with an incoming order to create a trade - These fees reward parties who provide the best priced liquidity that actually allows trading to take place
    • ACCOUNT_TYPE_BOND: This account is created to maintain liquidity providers funds commitments
    • ACCOUNT_TYPE_EXTERNAL: External account represents an external source (deposit/withdrawal)
    • ACCOUNT_TYPE_GLOBAL_INSURANCE: Global insurance account for the asset
    • ACCOUNT_TYPE_GLOBAL_REWARD: Global reward account for the asset
    • ACCOUNT_TYPE_PENDING_TRANSFERS: Per asset account used to store pending transfers (if any)
    • ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES: Per asset reward account for fees paid to makers
    • ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES: Per asset reward account for fees received by makers
    • ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES: Per asset reward account for fees received by liquidity providers
    • ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS: Per asset reward account for market proposers when the market goes above some trading threshold
    pagination.first int32

    Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

    pagination.after string

    If paging forwards, the cursor string for the last row of the previous page.

    pagination.last int32

    Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

    pagination.before string

    If paging forwards, the cursor string for the first row of the previous page.

    pagination.newestFirst boolean

    Newest records first, older records last, default is true.

    dateRange.startTimestamp int64
    dateRange.endTimestamp int64
Responses

A successful response.

Schema
    balances object

    Page of aggregated balances data and corresponding page information.

    edges object[]

    Page of aggregated balance data and their corresponding cursors.

    cursor string
    node object

    Balance of the set of requested accounts.

    accountType Various collateral/account types as used by Vega

    Possible values: [ACCOUNT_TYPE_UNSPECIFIED, ACCOUNT_TYPE_INSURANCE, ACCOUNT_TYPE_SETTLEMENT, ACCOUNT_TYPE_MARGIN, ACCOUNT_TYPE_GENERAL, ACCOUNT_TYPE_FEES_INFRASTRUCTURE, ACCOUNT_TYPE_FEES_LIQUIDITY, ACCOUNT_TYPE_FEES_MAKER, ACCOUNT_TYPE_BOND, ACCOUNT_TYPE_EXTERNAL, ACCOUNT_TYPE_GLOBAL_INSURANCE, ACCOUNT_TYPE_GLOBAL_REWARD, ACCOUNT_TYPE_PENDING_TRANSFERS, ACCOUNT_TYPE_REWARD_MAKER_PAID_FEES, ACCOUNT_TYPE_REWARD_MAKER_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_LP_RECEIVED_FEES, ACCOUNT_TYPE_REWARD_MARKET_PROPOSERS]

    assetId string
    balance string
    marketId If grouping by market, the market ID
    partyId string
    timestamp int64
    pageInfo object

    Page information that is used for fetching further pages.

    endCursor string
    hasNextPage boolean
    hasPreviousPage boolean
    startCursor string
Loading...