List ledger entries

GET 
/api/v2/ledgerentry/history

Get a list of ledger entries within the given date range. The date range is restricted to a maximum of 5 days. This query requests and sums the number of ledger entries from a given subset of accounts, specified via the 'filter' argument. It returns a time series - implemented as a list of AggregateLedgerEntry structs - with a row for every time the summed ledger entries of the set of specified accounts changes. Each account filter must contain no more than one party ID. At least one party ID must be specified in the from or to account filter.

Entries can be filtered by:

• the sending account (market ID, asset ID, account type)
• receiving account (market ID, asset ID, account type)
• sending AND receiving account
• transfer type either in addition to the above filters or as a standalone option Note: The date range is restricted to any 5 days. If no start or end date is provided, only ledger entries from the last 5 days will be returned. If a start and end date are provided, but the end date is more than 5 days after the start date, only data up to 5 days after the start date will be returned. If a start date is provided but no end date, the end date will be set to 5 days after the start date. If no start date is provided, but the end date is, the start date will be set to 5 days before the end date.

Request

Query Parameters

filter.closeOnAccountFilters boolean

Determines whether an entry must have accounts matching both the account_from_filter and the account_to_filter. If set to 'true', entries must have matches in both filters. If set to false, entries matching only the account_from_filter or the account_to_filter will also be included.

filter.fromAccountFilter.assetId string

Restrict accounts to those holding balances in this asset ID.

filter.fromAccountFilter.partyIds string[]

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

filter.fromAccountFilter.marketIds string[]

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

filter.fromAccountFilter.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, 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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES]
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
• 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_NETWORK_TREASURY: Network controlled treasury
• ACCOUNT_TYPE_VESTING_REWARDS: Account holding user's rewards for the vesting period
• ACCOUNT_TYPE_VESTED_REWARDS: Account holding user's rewards after the vesting period
• ACCOUNT_TYPE_REWARD_RELATIVE_RETURN: Per asset market reward account given for relative return
• ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY: Per asset market reward account given for return volatility
• ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING: Per asset market reward account given to validators by their ranking
• ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD: Per asset account for pending fee referral reward payouts
• ACCOUNT_TYPE_ORDER_MARGIN: Per asset market account for party in isolated margin mode
• ACCOUNT_TYPE_REWARD_REALISED_RETURN: Per asset market reward account for realised return
• ACCOUNT_TYPE_BUY_BACK_FEES: Per asset account for paid buy-back fees
• ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL: Per asset market reward account given for average notional
• ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES: Reward account for the eligible entities metric.
filter.toAccountFilter.assetId string

Restrict accounts to those holding balances in this asset ID.

filter.toAccountFilter.partyIds string[]

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

filter.toAccountFilter.marketIds string[]

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

filter.toAccountFilter.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, 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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES]
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
• 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_NETWORK_TREASURY: Network controlled treasury
• ACCOUNT_TYPE_VESTING_REWARDS: Account holding user's rewards for the vesting period
• ACCOUNT_TYPE_VESTED_REWARDS: Account holding user's rewards after the vesting period
• ACCOUNT_TYPE_REWARD_RELATIVE_RETURN: Per asset market reward account given for relative return
• ACCOUNT_TYPE_REWARD_RETURN_VOLATILITY: Per asset market reward account given for return volatility
• ACCOUNT_TYPE_REWARD_VALIDATOR_RANKING: Per asset market reward account given to validators by their ranking
• ACCOUNT_TYPE_PENDING_FEE_REFERRAL_REWARD: Per asset account for pending fee referral reward payouts
• ACCOUNT_TYPE_ORDER_MARGIN: Per asset market account for party in isolated margin mode
• ACCOUNT_TYPE_REWARD_REALISED_RETURN: Per asset market reward account for realised return
• ACCOUNT_TYPE_BUY_BACK_FEES: Per asset account for paid buy-back fees
• ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL: Per asset market reward account given for average notional
• ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES: Reward account for the eligible entities metric.
filter.transferTypes 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, TRANSFER_TYPE_TREASURY_FEE_PAY, TRANSFER_TYPE_BUY_BACK_FEE_PAY, TRANSFER_TYPE_HIGH_MAKER_FEE_REBATE_PAY, TRANSFER_TYPE_HIGH_MAKER_FEE_REBATE_RECEIVE]
List of transfer types that is used for filtering sender and receiver accounts.
• TRANSFER_TYPE_UNSPECIFIED: Default value, always invalid
• TRANSFER_TYPE_LOSS: Funds deducted after final settlement loss
• TRANSFER_TYPE_WIN: Funds added to general account after final settlement gain
• TRANSFER_TYPE_MTM_LOSS: Funds deducted from margin account after mark to market loss
• TRANSFER_TYPE_MTM_WIN: Funds added to margin account after mark to market gain
• TRANSFER_TYPE_MARGIN_LOW: Funds transferred from general account to meet margin requirement
• TRANSFER_TYPE_MARGIN_HIGH: Excess margin amount returned to general account
• TRANSFER_TYPE_MARGIN_CONFISCATED: Margin confiscated from margin account to fulfil closeout
• TRANSFER_TYPE_MAKER_FEE_PAY: Maker fee paid from general account
• TRANSFER_TYPE_MAKER_FEE_RECEIVE: Maker fee received into general account
• TRANSFER_TYPE_INFRASTRUCTURE_FEE_PAY: Infrastructure fee paid from general account
• TRANSFER_TYPE_INFRASTRUCTURE_FEE_DISTRIBUTE: Infrastructure fee received into general account
• TRANSFER_TYPE_LIQUIDITY_FEE_PAY: Liquidity fee paid from general account
• TRANSFER_TYPE_LIQUIDITY_FEE_DISTRIBUTE: Liquidity fee received into general account
• TRANSFER_TYPE_BOND_LOW: Bond account funded from general account to meet required bond amount
• TRANSFER_TYPE_BOND_HIGH: Bond returned to general account after liquidity commitment was reduced
• TRANSFER_TYPE_WITHDRAW: Funds withdrawn from general account
• TRANSFER_TYPE_DEPOSIT: Funds deposited to general account
• TRANSFER_TYPE_BOND_SLASHING: Bond account penalised when liquidity commitment not met
• TRANSFER_TYPE_REWARD_PAYOUT: Reward payout received
• TRANSFER_TYPE_TRANSFER_FUNDS_SEND: Internal Vega network instruction for the collateral engine to move funds from a user's general account into the pending transfers pool
• TRANSFER_TYPE_TRANSFER_FUNDS_DISTRIBUTE: Internal Vega network instruction for the collateral engine to move funds from the pending transfers pool account into the destination account
• TRANSFER_TYPE_CLEAR_ACCOUNT: Market-related accounts emptied because market has closed
• TRANSFER_TYPE_CHECKPOINT_BALANCE_RESTORE: Balances restored after network restart
• TRANSFER_TYPE_SPOT: Spot trade delivery
• TRANSFER_TYPE_HOLDING_LOCK: An internal instruction to transfer a quantity corresponding to an active spot order from a general account into a party holding account.
• TRANSFER_TYPE_HOLDING_RELEASE: An internal instruction to transfer an excess quantity corresponding to an active spot order from a holding account into a party general account.
• TRANSFER_TYPE_SUCCESSOR_INSURANCE_FRACTION: Insurance pool fraction transfer from parent to successor market.
• TRANSFER_TYPE_LIQUIDITY_FEE_ALLOCATE: Allocates liquidity fee earnings to each liquidity provider's network controlled liquidity fee account.
• TRANSFER_TYPE_LIQUIDITY_FEE_NET_DISTRIBUTE: Distributes net fee earnings from liquidity provider's fee account to their general account.
• TRANSFER_TYPE_SLA_PENALTY_BOND_APPLY: Applies SLA penalty by moving funds from party's bond account to market's insurance pool.
• TRANSFER_TYPE_SLA_PENALTY_LP_FEE_APPLY: Applies SLA penalty by moving funds from the liquidity provider's fee account to market insurance pool.
• TRANSFER_TYPE_LIQUIDITY_FEE_UNPAID_COLLECT: Collects penalties from the liquidity provider's fee account before the fee revenue is paid, and transfers it to the market's bonus distribution account.
• TRANSFER_TYPE_SLA_PERFORMANCE_BONUS_DISTRIBUTE: Distributes performance bonus from market bonus to liquidity provider's general account.
• TRANSFER_TYPE_PERPETUALS_FUNDING_LOSS: Funds deducted from margin account after a perpetuals funding loss.
• TRANSFER_TYPE_PERPETUALS_FUNDING_WIN: Funds added to margin account after a perpetuals funding gain.
• TRANSFER_TYPE_REWARDS_VESTED: Funds moved from the vesting account to the vested account once the vesting period is reached.
• TRANSFER_TYPE_FEE_REFERRER_REWARD_PAY: Fee referrer reward paid from general account.
• TRANSFER_TYPE_FEE_REFERRER_REWARD_DISTRIBUTE: Fee referrer reward received into general account of the referrer.
• TRANSFER_TYPE_ORDER_MARGIN_LOW: Funds transferred from general account to meet order margin requirement in isolated margin mode.
• TRANSFER_TYPE_ORDER_MARGIN_HIGH: Excess order margin amount returned to general account.
• TRANSFER_TYPE_ISOLATED_MARGIN_LOW: Transfer from order margin account to margin account due to increase of position.
• TRANSFER_TYPE_ISOLATED_MARGIN_HIGH: Transfer from excess order margin account to general account.
• TRANSFER_TYPE_AMM_LOW: Transfer from a party's general account to their AMM's general account.
• TRANSFER_TYPE_AMM_HIGH: Transfer from an AMM's general account to their owner's general account.
• TRANSFER_TYPE_AMM_RELEASE: Transfer releasing an AMM's general account upon closure.
• TRANSFER_TYPE_TREASURY_FEE_PAY: Treasury fee paid from party's general account.
• TRANSFER_TYPE_BUY_BACK_FEE_PAY: Buy-back fee paid into network buy-back account.
• TRANSFER_TYPE_HIGH_MAKER_FEE_REBATE_PAY: High-volume maker fee paid from general account
• TRANSFER_TYPE_HIGH_MAKER_FEE_REBATE_RECEIVE: Maker fee received into general account
filter.transferId string

List ledger entries that are associated with a specific transfer ID. If provided, all other filters are ignored.

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

Whether to order the results with the newest records first. If not set, the default value is true.

dateRange.startTimestamp int64

Timestamp in Unix nanoseconds indicating the start of the date range.

dateRange.endTimestamp int64

Timestamp in Unix nanoseconds indicating the end of the date range.

Responses

200

A successful response.

application/json

Schema

Schema

ledgerEntries object

Page of aggregated ledger entries data and corresponding page information.

edges object[]

Page of 'AggregatedLedgerEntry' data and their corresponding cursors.

Array [

cursor string

Cursor that can be used to fetch further pages.

node object

'AggregatedLedgerEntry' data.

assetId string

Asset ID for the asset associated with the entry.

fromAccountBalance string

Sender account balance after the transfer.

fromAccountMarketId string

Sender market ID.

fromAccountPartyId string

Sender's party ID.

fromAccountType 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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES]

Default value: ACCOUNT_TYPE_UNSPECIFIED

Type of account sent from.

quantity string

Amount of ledger entries for the set of requested accounts at the time above.

timestamp int64

Timestamp in Unix nanoseconds of the block in which the result is referring to.

toAccountBalance string

Receiver account balance after the transfer.

toAccountMarketId string

Receiver market ID.

toAccountPartyId string

Receiver's party ID.

toAccountType 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_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, ACCOUNT_TYPE_BUY_BACK_FEES, ACCOUNT_TYPE_REWARD_AVERAGE_NOTIONAL, ACCOUNT_TYPE_REWARD_ELIGIBLE_ENTITIES]

Default value: ACCOUNT_TYPE_UNSPECIFIED

Type of account received to.

transferId string

Transfer ID associated with the ledger entry.

transferType 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, TRANSFER_TYPE_TREASURY_FEE_PAY, TRANSFER_TYPE_BUY_BACK_FEE_PAY, TRANSFER_TYPE_HIGH_MAKER_FEE_REBATE_PAY, TRANSFER_TYPE_HIGH_MAKER_FEE_REBATE_RECEIVE]

Default value: TRANSFER_TYPE_UNSPECIFIED

Transfer type.

]

pageInfo object

Page information that is used for fetching further pages.

endCursor string

End cursor.

hasNextPage boolean

Indicator if there is a next page.

hasPreviousPage boolean

Indicator if there is a previous page.

startCursor string

Start cursor.

Example (from schema)

{
  "ledgerEntries": {
    "edges": [
      {
        "cursor": "string",
        "node": {
          "assetId": "string",
          "fromAccountBalance": "string",
          "fromAccountMarketId": "string",
          "fromAccountPartyId": "string",
          "fromAccountType": "ACCOUNT_TYPE_UNSPECIFIED",
          "quantity": "string",
          "timestamp": "string",
          "toAccountBalance": "string",
          "toAccountMarketId": "string",
          "toAccountPartyId": "string",
          "toAccountType": "ACCOUNT_TYPE_UNSPECIFIED",
          "transferId": "string",
          "transferType": "TRANSFER_TYPE_UNSPECIFIED"
        }
      }
    ],
    "pageInfo": {
      "endCursor": "string",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

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

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

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

Example (from schema)

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

Loading...