Developer Guide

Price Administration

Overview

Pricing administration allows users to manage and retrieve prices for various assets and asset classes, including currencies, cryptocurrencies, commodities, and more. Designed with flexibility and precision, the platform offers powerful tools for real-time and historical price tracking.

  • 1

    Priced Item Creation and Configuration

    Create and configure priced items such as currencies (USD, EUR), cryptocurrencies (BTC, ETH), and commodities (GOLD, SILVER). Define specific properties and attributes for each asset type.

  • 2

    Price Pair Creation and Configuration

    Establish pricing pairs (e.g., USD/EUR, BTC/USD) to track comparative asset performance.

  • 3

    Pricing Source Configuration & Real-Time Data Retrieval

    Set up and integrate with our preconfigured pricing sources. Retrieve real-time prices for specific asset pairs from these providers, enabling up-to-the-minute insights into market movements.

  • 4

    Historical Price Import

    Import historical price data for selected asset pairs from designated providers. Analyze trends over time, perform backtesting, and utilize historical insights for informed decision-making.

Helpful terminology

TermMeaning
Priced Item / SymbolThe symbol of an asset to be used to construct a price pair.
Priced AsWhen 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 InWhen 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.
Price PairA pair consists of a combination of Priced As and Priced In.
Price TypeAn attribute of a price pair which defines whether the requested price is ask, bid, trade, market, or NAV. Note that some price sources may not support all of these price types.
System PriceEnables the ability to have redundant price sources whereby one goes down a switch to another price source would occur.
Price SourceGiven a price pair, a price source will provide a stream of price updates as well as allow for batch request of historical price data.

Price Pair Configuration

Configuring price pairs are essential to unlocking real-time and historical pricing within LedgerScan. Once price pairs are configured, these pairs can be linked to a token so that automated value calculations can be made to enrich token transactions, cap tables, and market cap history.

Even when not linked to a token which is configured for tracking in LedgerScan, the existence of price pairs for common tokens will serve to automate the value calculations of the respective positions held by a wallet; thus given the wallet a value history. Note that if a wallet holds a token that does not have a price pair, then that token’s position will not be reflected in the overall wallet’s current nor historical value.

The high level configuration steps include:

  1. Configure Symbols to be used in the price pair. Symbols are also known as Priced Items'
  2. Configure the Price Pairs. This will involve setting the price type, price source, and other parameters. The configuration of price type and prioritized price sources will create a system price for that specific price type.
  3. Link the Token to the Price Pair. This triggers the automation of value calculations for cap tables, market cap, transactions for the token it is linked to.
  4. Import historical price data for selected asset pairs from designated providers. Analyze trends over time, perform backtesting, and utilize historical insights for informed decision-making.

The following sequence of API endpoints can be used to configure the price pairs and link to a token (if desired).

  • 1
    post

    /v1/priced-items

    Add a new symbol (aka priced item). The request body should include symbol details like name, symbol, and class.Repeat this endpoint call for each symbol you wish to create. For example, if you need a price pair such as BTC/USD, you will need to create both of these symbols first with 2 separate api endpoint calls

  • 2
    get

    /v1/priced-items

    Optional: Retrieves the list of all symbols which have been configured including the Name (Bitcoin), Symbol (BTC), and Class (Crpto).

  • 3
    put

    /v1/priced-items/{symbol}/mapping-symbols

    Optional: Creates mapping for specific Symbol. If custom mapping is not configured, system will auto-search for symbols in the price source.

  • 4
    get

    /v1/priced-items/{symbol}

    Optional: Retrieves the details of a Symbol such as its name, class, mappings, etc.

  • 5
    post

    /v2/pairs

    Creates a new pair to include the

    • Priced As (symbol to be priced such as BTC)
    • Priced In (Symbol to express price such as USD)
    • Price Type (Ask, Bid, Trade, Market, NAV)
    • Price Source

    See the API reference for Pricing Administration for details.

  • 6
    get

    /v2/pairs

    Optional: Get list of all pricing pairs that have been configured.

  • 7
    get

    /v2/pairs/{pairId}

    Optional: Get details of a specified price pair.

The price pair is now created and is ready to be linked to a token by the following steps:

  • 1
    put

    /v1/tokens/{tokenId}/priced-as

    Links the specified token to the Priced As Symbol. Only Priced-As is required since the initial release defaults to USD for Priced-In. Setting USD for Priced-In is an automatic process that happens during enabling tracking of the token.

Now that the token is linked to the price pair, LedgerScan will enrich the transaction data with pricing & value.

Import Price History

As a part of the pair configuration process the user sets which Price Source they prefer to use for importing history. To initiate the import process, the user should specify the date range, window size (day, week, month, etc) and multiplayer (decimal value).

The user will receive status updates on the process, indicating whether it was successful or if it encountered any errors.

  • 1
    post

    /v2/pairs/{pairId}/prices/discovery

    Initiates discovery historical prices process.

  • 2
    get

    /v2/pairs/{pairId}/prices/async-operations

    Get collection of discovery historical price events with their status.

The price pair is now created and is ready to be linked to a token by the following steps:

Manual Pricing

Not all tokenized assets will have a price type of ask, bid, trade, or market. Instead, they may require a NAV to be set daily, or for less liquid assets they may need to have pricing manually applied (Real Estate as an example). In these cases, LedgerScans offers a means to ingest the pricing for such assets.

  • 1
    post

    v2/price-sources

    Creates a Manual Price Source. The request body includes only name.

  • 2
    patch

    v2/price-sources/{id}/enable

    Enables Price Source. Once Price Source is enabled it can be used in Pair Configuration.

  • 3
    post

    /v2/price-sources/{id}/pairs

    Creates Supported Pair for the Price Source. This option is available only for Manual Pricing Sources.

  • 4
    post

    /v2/price-sources/{id}/pairs/{pairId}/prices

    Creates Price for Supported Pair.

  • 5
    get

    /v2/price-sources/{id}/pairs/{pairId}/prices

    Retrieves prices that were created for a particular Supported Pair.

  • 6
    get

    /v2/price-sources

    Review list of Price Sources that are in Pricing Administration.

  • 7
    patch

    /v2/price-sources/{id}/disable

    Disables Price Source. Disabled price Source can not be used in pair creation.

Interested in third-party integrations?

Contact our sales team for more information

Contact Sales
Have questions?

View answers to the most common questions about our platforms and services

Informative FAQs

Search