Future of Financial Services

Search

Helpful Terminology

Term	Meaning
Wallet	Wallets store private keys to keep tokens/assets safe, accessible, and authorizes movement of value.
Wallet ID	The wallet’s address on a specific ledger. This may have a slightly different format for EVM vs. other non-EVM ledgers.
External ID	A LedgerScan specific attribute of a token or wallet which is user defined at the point of configuring the object. This may be used for establishing a common identifier (account, or asset identifier) of a wallet or token which is represented in a new or existing financial system that has been integrated with LedgerScan.
Priced As	When specifying pricing for a token, the Priced As is the base asset symbol that is being priced. For BTC/USD – BTC is the priced asset.
Priced In	When specifying pricing for a token, the Priced In is the asset used to express price. For BTC/USD – USD is the priced in asset. In the initial release of LedgerScan, Priced In defaults to USD.
Cap Table	The master shareholder registry which shows all wallets holding a specified asset, their % ownership of the asset, quantity of tokens held, and value of tokens held.
Wallet Positions / Wallet Balances	The list of holdings within a wallet to include token, quantity held, and value. Wallet balances are a reference to the quantity of tokens held by a wallet.
Transactions	A ledger transaction can represent any state change, transfer of value, or any other change which occurs on the blockchain.
Ledger	A ledger is a reference to a specific blockchain network. Examples include Ethereum Mainnet, Polygon, Avalanche, HyperLedger Besu, Stellar, etc.

Tracking Wallets

Adding and tracking a wallet involves the same sequence as tracking tokens. Once a wallet is added and tracking is enabled, LedgerScan begins aggregating data from the ledger 24x7 until wallet tracking is disabled. To aggregate data for a wallet of interest, follow the steps in the table below.

1
get
/v1/networks/ledgers
Retrieves the list of supported ledgers within the tenancy. This endpoint may be optionally used in advance of adding a token or wallet as a ledger must be specified for both.
2
get
/v1/wallets
Retrieve the list of all wallets currently being tracked. Includes wallet addresses, ledgers, and tracking status.
3
put
/v1/tokens/{tokenId}/tracking
Enables tracking status causing data aggregation on the wallet to begin. This same endpoint may be used for disabling tracking as well.
4
get
/v1/wallets
Retrieve the list of all wallets currently being tracked. Includes wallet addresses, ledgers, and tracking status.

Adding a wallet will involve providing the following attributes

Term	Meaning
Wallet Name	This is a discretionary name of the wallet. This name will be included in the response to GET v1/wallets as well as other wallet endpoints where wallet details are required.
Ledger	The ledger on which the wallet has been issued.
Ledger ID	The address of the wallet on the ledger.
External ID	Discretionary field that you can use to insert any ID to correlate this wallet with externally integrated systems.

The point at which wallet data is aggregated from the ledger is the point when tracking is enabled. No historical data prior to the point of tracking will be automatically collected. However, historical ledger data can be requested (coming soon).

Caution

When a user toggles a wallet from enabled to disabled, data aggregation will stop. At some point in the future, if the tracking status of the wallet is enabled again, data aggregation will resume. However, this will create a gap in your data. Filling this gap will require requesting historical data for the wallet during the period of the gap. Ensure only authorized administrators have permissions to toggle tracking status.

Once the sequence of steps are complete you may begin calling other wallet endpoints to view data such as wallet positions, activities and value history.

Search

Wallet analytics

Overview

Wallet Management

Transaction Tracking

Historical Data Import

Balance Review (Current & Historic)

Wallet Value History

Helpful Terminology

Tracking Wallets

/v1/networks/ledgers

/v1/wallets

/v1/tokens/{tokenId}/tracking

/v1/wallets

Caution

Retrieving Wallet Data

/v1/wallets

/v1/wallets/{walletId}

/v1/wallets/{walletId}/value-history

/v1/wallets/{walletId}/activities

/v1/tokens/{tokenId}/market-capitalization