Future of Financial Services

Search

Helpful terminology

Term	Meaning
Token	A digitized asset allowing information and value to be transferred, stored, and verified in an efficient & secure manner.
Token ID	The token’s address on a specific ledger. This may have a slightly different format for EVM vs. other non-EVM ledgers.
Tracking Status	Tracking Status
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 will default 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.
Transactions	A ledger transaction can represent any state change, transfer of value, or any other change which occurs on the blockchain.
Activities	An activity is a transaction from the perspective of the Wallet or Token of interest.
Ledger	A ledger is a reference to a specific blockchain network. Examples include Ethereum Mainnet, Polygon, Avalanche, HyperLedger Besu, Stellar, etc.

Tracking tokens

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/tokens
Retrieves a list of all tokens currently being tracked and the associated token summary data.
3
put
/v1/tokens/{tokenId}/tracking
Enables tracking status causing data aggregation on the token to begin. This same endpoint may be used for disabling tracking as well.
4
get
/v1/tokens
Retrieves a list of all tokens currently being tracked and the associated token summary data.

Adding a token will involve providing the following attributes of the token:

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

The point at which token 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 token from enabled to disabled, data aggregation will stop. At some point in the future, if the tracking status of the token 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 token 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 token endpoints to view data such as token activities and cap tables. Note however, the data will only show the quantity of tokens associated with activities and cap tables. To enrich with pricing and value, see the pricing administration guide.

Search

Token analytics

Overview

Token Management

Transaction Tracking

Historical Transaction Import

Capitalization Table Review

Token Price History

Market Capitalization History

Helpful terminology

Tracking tokens

/v1/networks/ledgers

/v1/tokens

/v1/tokens/{tokenId}/tracking

/v1/tokens

Caution

Retrieving Token Data

/v1/tokens

/v1/tokens/{tokenId}

/v1/tokens/{tokenId}/activities

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