1.0.0 • Published 6 months ago

amberdata_api v1.0.0

Weekly downloads
-
License
-
Repository
-
Last release
6 months ago

amberdata_api typescript

At Amberdata.io we provide a rich set of high quality, real-time, raw & augmented blockchain data. Web3api enables you to easily gain access to this data.

You can access the data in different ways:

REST - Access comprehensive historical data with our RESTful APIs, designed for seamless integration and retrieval of extensive time-series information.

Websockets - Connect to our Websockets API for instantaneous, real-time data streaming, ensuring minimal latency for dynamic and responsive applications.

FIX - Leverage the robustness of the FIX protocol to obtain reliable and secure Market Data, facilitating swift and standardized financial information exchange.

RPC - Utilize our RPC interface for direct and efficient queries to our blockchain nodes, offering you unfettered access to decentralized data with precision.

Amazon S3 - Access and download vast archives of historical data, systematically organized and delivered daily in the highly efficient Apache Parquet format via Amazon S3.

Snowflake - Harness the power of Snowflake for dynamic data analysis within a cloud-native platform, offering advanced SQL querying capabilities and seamless scalability.

BigQuery - Utilize BigQuery for comprehensive data analysis, leveraging Google's advanced infrastructure and smart analytics with interactive SQL queries.

Authentication

import Client from "amberdata_api"
const client = new Client('API_KEY');

get_all_addresses

Retrieves every address that has been seen on the network. Without any parameters, returns all the known addresses on the blockchain, order by time of first appearance (ie when they first transacted) in reverse order, meaning the most recent addresses first. When used with a specific address, returns information about the address and the first time (block and transaction hash) it appeared on the blockchain.

const response = await client.getAllAddresses({
})

address_balances_batch

Retrieves the latest account and token balances for the specified addresses. This is super useful if you want to get an entire portfolio's summary in a single call. Get totals for ETH & all token amounts with market prices.

const response = await client.addressBalancesBatch({
    addresses: "string",
})

extended_public_key

Generates derived addresses based an x,y,z public address and a path.

const response = await client.extendedPublicKey({
    address: "string",
})

all_address_metrics

Get a rolling 24 hour active address count for a given blockchain. Default metrics are for Ethereum.

const response = await client.allAddressMetrics()

get_historical_account_balances

Retrieves the historical (time series) account balances for the specified address.

const response = await client.getHistoricalAccountBalances({
    hash: "string",
})

get_current_account_balance

Retrieves the current account balance for the specified address.

const response = await client.getCurrentAccountBalance({
    hash: "string",
})

get_address_adoption

Retrieves the historical adoption for the specified address on ethereum-mainnet.

Adoption is defined by the number of unique addresses interacting with this contract for the entire span of time. Example: If an address makes a transaction to a contract in June, then again in July, this address will only be counted once for the adoption totals.

const response = await client.getAddressAdoption({
    hash: "string",
})

address_balances

Retrieves the latest account and token balances for the specified address.

const response = await client.addressBalances({
    hash: "string",
})

addresses_converter

Converts the specified address in the Bitcoin Cash & Legacy formats.

const response = await client.addressesConverter({
    hash: "string",
})

get_internal_messages

Retrieves internal messages where this address is either the originator or a recipient.

If you intend to traverse all the internal-messages, it is recommended to specify the flag direction=ascending, which will guarantee that the pagination is stable and will not change with the arrival of new internal messages.

Please note that the returned payload can sometimes contain less records than the requested size - this is due to duplicates that can occur when the from and the to of a transaction are identical. In order to terminate the pagination effectively, please paginate until the returned payload is empty, do no rely on the size of the payload itself.

const response = await client.getInternalMessages({
    hash: "string",
})

get_account_information

Retrieves information about the specified address: network(s) and blockchain(s) this address exist within.

const response = await client.getAccountInformation({
    hash: "string",
})

get_address_logs

Retrieves the logs for the transactions where this address is either the originator or a recipient.

const response = await client.getAddressLogs({
    hash: "string",
})

get_address_metadata

Retrieves statistics about the specified address: balances, holdings, etc.

const response = await client.getAddressMetadata({
    hash: "string",
})

get_token_balances

Retrieves the historical (time series) token balances for the specified address.

const response = await client.getTokenBalances({
    hash: "string",
})

get_address_tokens

Retrieves the tokens this address is holding.

const response = await client.getAddressTokens({
    hash: "string",
})

token_transfers_by_address_pro

Retrieves all token transfers involving the specified address.

If you intend to traverse all the token-transfers, it is recommended to specify the flag direction=ascending, which will guarantee that the pagination is stable and will not change with the arrival of new token-transfers.

const response = await client.tokenTransfersByAddressPro({
    hash: "string",
})

get_address_transactions

Retrieves the transactions where this address was either the originator or a recipient.

Note that transactions are returned in descending order by default (block number and transaction index), which means the most recent transactions are on page 0, and the oldest transactions are on the last page.

If you intend to traverse all the transactions, it is recommended to specify the flag direction=ascending, which will guarantee that the pagination is stable and will not change with the arrival of new transactions.

const response = await client.getAddressTransactions({
    hash: "string",
})

get_address_usage

Retrieves the historical usage for the specified address. Usage is defined by the number of unique addresses interacting with this contract for a specific window of time. Example: If an address makes a transaction to a contract in June, then again in July, this address will be counted once for each period in the usage totals.

const response = await client.getAddressUsage({
    hash: "string",
})

blockchains_metrics_latest

Get metrics for a specific blockchain.

const response = await client.blockchainsMetricsLatest()

get_all_blocks

Retrieves all the blocks within the specified range.

const response = await client.getAllBlocks({
    endNumber: "string",
    startNumber: "string",
})

blocks_metrics_historical

Get metrics for historical confirmed blocks for a given blockchain. Default metrics are for Ethereum over a 1d tick / 365d lookback period. Changing the header blockchain ID will return that blockchains metrics.

const response = await client.blocksMetricsHistorical({
})

blocks_metrics

Get metrics for recent confirmed blocks for a given blockchain. Default metrics are for Ethereum over a 24h period. Changing the header blockchain ID will return that blockchains metrics.

const response = await client.blocksMetrics({
})

get_block

Retrieves the block specified by its id (number or hash).

const response = await client.getBlock({
    id: "string",
})

get_block_functions

Retrieves all the functions which were called at the specified block number or hash.

const response = await client.getBlockFunctions({
    id: "string",
})

get_block_logs

Retrieves all the logs at the specified block number or hash.

const response = await client.getBlockLogs({
    id: "string",
})

get_blocks_token_transfers

Retrieves all the tokens which were transferred at the specified block number.

const response = await client.getBlocksTokenTransfers({
    id: "string",
})

get_block_transactions

Retrieves all the transactions included in a specified block id.

const response = await client.getBlockTransactions({
    id: "string",
})

get_contract_details

Retrieves all the detailed information for the specified contract (ABI, bytecode, sourcecode...).

const response = await client.getContractDetails({
    hash: "string",
})

get_contract_functions

Retrieves the functions of the specified contract (if available) - if not available on chain, the byte code is decompiled and a list of functions is extracted from it.

const response = await client.getContractFunctions({
    hash: "string",
})

uniswap_v3_liquidity_distribution

This API provides the current distribution of the liquidity in a specified Uniswap v3 pool.

const response = await client.uniswapV3LiquidityDistribution({
    poolAddress: "string",
})

defi_dex_pool_lens

This API retrieves information about all of the actions that occurred for a specific liquidity pool on the protocol within a certain timespan.

const response = await client.defiDexPoolLens({
    protocolId: "string",
    poolAddress: "string",
})

defi_dex_protocol_lens

This API retrieves information about all of the actions that occurred on the protocol within a certain timespan.

const response = await client.defiDexProtocolLens({
    protocolId: "string",
})

defi_dex_wallet_lens

This API retrieves information about all of the actions taken by a specific wallet on the protocol within a certain timespan.

const response = await client.defiDexWalletLens({
    protocolId: "string",
    walletAddress: "string",
})

defi_lending_information_assets

This API lists the supported assets across the available lending protocols and provides snapshots of aggregate metrics.

const response = await client.defiLendingInformationAssets({
})

defi_lending_information_protocols

This API lists the supported DeFi lending protocols and provides snapshots of aggregate metrics.

const response = await client.defiLendingInformationProtocols({
})

profit_and_loss_analytics_in_defi_lending

Analyze a wallet's historical yield, net worth and interest owed from lending and borrowing assets across different DeFi protocols.

const response = await client.profitAndLossAnalyticsInDefiLending({
    walletAddress: "string",
})

lending_asset_summary_metrics

This API provides aggregated insights into the asset markets across various lending protocols.

const response = await client.lendingAssetSummaryMetrics({
    protocolId: "string",
    assetId: "string",
})

defi_lending_asset_lens

This API retrieves information about all of the actions that occurred for a specific asset on the protocol within a certain timespan.

const response = await client.defiLendingAssetLens({
    protocolId: "string",
    asset: "string",
})

defi_lending_governance_lens

This API retrieves information about all of the governance actions that occurred for the protocol within a certain timespan.

const response = await client.defiLendingGovernanceLens({
    protocolId: "string",
})

lending_protocol_metrics_summary

This API provides aggregated insights into the lending protocols.

const response = await client.lendingProtocolMetricsSummary({
    protocolId: "string",
})

defi_lending_protocol_lens

This API retrieves information about all of the actions that occurred on the protocol within a certain timespan.

const response = await client.defiLendingProtocolLens({
    protocolId: "string",
})

track_positions_lending_wallet

This API retrieves the balances of a given address within supported lending protocols.

const response = await client.trackPositionsLendingWallet({
    protocolId: "string",
    address: "string",
})

defi_lending_wallet_lens

This API retrieves information about all of the actions taken by a specific wallet on the protocol within a certain timespan.

const response = await client.defiLendingWalletLens({
    protocolId: "string",
    walletAddress: "string",
})

stablecoins_in_defi_lending_aggregate_insights

Easily analyze a stablecoin's metrics across multiple DeFi lending protocols.

const response = await client.stablecoinsInDefiLendingAggregateInsights({
    assetSymbol: "string",
})

defi_information_dex_exchanges

Retrieves list of supported Ethereum decentralized exchanges (DEX).

const response = await client.defiInformationDexExchanges({
})

defi_information_dex_pairs

Retrieves supported DEX Pairs.

const response = await client.defiInformationDexPairs({
    exchange: "string",
})

dex_liquidity_positions_pairs_latest

Retrieves the latest Liquidity Positions within the specified pool.

Positions are ordered by providers, in descending order.

const response = await client.dexLiquidityPositionsPairsLatest({
    pair: "string",
})

dex_liquidity_positions_providers_latest

Retrieves the latest Liquidity Positions of a liquidity provider across all pools.

Positions are ordered by pools, in descending order.

const response = await client.dexLiquidityPositionsProvidersLatest({
    address: "string",
})

defi_liquidity_information

Retrieves information about supported exchange-pairs for liquidity.

const response = await client.defiLiquidityInformation({
})

defi_liquidity_pool_total_return

Aggregates fees earned and impermanent loss for each liquidity provider in a pool to calculate pool level fees earned and impermanent loss. These values are calculated daily at midnight UTC.

const response = await client.defiLiquidityPoolTotalReturn({
    address: "string",
})

defi_dex_liquidity_provider_return_since_inception

Retrieves a liquidity provider's return since inception (the first time they provided liquidity or received LP tokens) including fees earned, impermanent loss and related metadata. These values are calculated daily at midnight UTC.

const response = await client.defiDexLiquidityProviderReturnSinceInception({
    liquidityPoolAddress: "string",
})

defi_dex_liquidity_provider_historical_return

Retrieves a liquidity provider’s return in a time interval including fees earned, impermanent loss and related metadata.

const response = await client.defiDexLiquidityProviderHistoricalReturn({
    liquidityPoolAddress: "string",
    addresses: "string",
    endDate: "1970-01-01T00:00:00",
    startDate: "1970-01-01T00:00:00",
})

dex_liquidity_provider_events

For a given wallet (EOA), this endpoint returns all events associated with the EOA's liquidity events across pools (mint, burn and swap).

const response = await client.dexLiquidityProviderEvents({
    providerAddress: "string",
})

defi_liquidity_snapshots

Retrieves a snapshot (a point in time) of the liquidity of the tokens in a pool.

const response = await client.defiLiquiditySnapshots({
    poolAddress: "string",
})

defi_liquidity_historical

Retrieves the historical (time series) liquidity for the specified pair.

const response = await client.defiLiquidityHistorical({
    pool: "string",
})

defi_liquidity_latest

Retrieves the latest liquidity information for the specified pool including both token liquidity prices.

const response = await client.defiLiquidityLatest({
    pool: "string",
})

defi_metrics_assets_historical

Retrieves historical daily metrics for the specified asset (for example DAI).

const response = await client.defiMetricsAssetsHistorical({
    exchange: "string",
    asset: "string",
})

defi_metrics_assets_latest

Retrieves the latest daily metrics for the specified asset (for example DAI).

const response = await client.defiMetricsAssetsLatest({
    exchange: "string",
    asset: "string",
})

defi_metrics_exchanges_historical

Retrieves historical daily exchange metrics for the specified decentralized exchange.

const response = await client.defiMetricsExchangesHistorical({
    exchange: "string",
})

defi_metrics_exchanges_latest

Retrieves the latest exchange daily metrics for the specified decentralized exchange.

const response = await client.defiMetricsExchangesLatest({
    exchange: "string",
})

defi_metrics_pairs_historical

Retrieves historical daily metrics for the specified pair (for example DAI_WETH).

const response = await client.defiMetricsPairsHistorical({
    exchange: "string",
    pair: "string",
})

defi_metrics_pairs_latest

Retrieves the latest minute by minute metrics for the specified pair (for example DAI_WETH).

const response = await client.defiMetricsPairsLatest({
    exchange: "string",
    pair: "string",
})

defi_ohlcv_information

Retrieves information about supported exchange-pairs for ohlcv.

const response = await client.defiOhlcvInformation({
})

defi_ohlcv_historical

Retrieves the historical (time series) open-high-low-close for the specified pair. Includes data for exchanges depending on where the pair is traded. Base & Quote information is using the first and second asset in a pool/pair, which is the represented price.

const response = await client.defiOhlcvHistorical({
    pool: "string",
})

defi_ohlcv_latest

Retrieves the latest open-high-low-close for the specified pair. Includes data for exchanges depending on where the pair is traded. Asset information is included in the payload. Base & Quote information is using the first and second asset in a pool/pair, which is the represented price.

const response = await client.defiOhlcvLatest({
    pool: "string",
})

defi_prices_assets_information

Retrieves the list of all available market asset price data sets.

const response = await client.defiPricesAssetsInformation()

defi_prices_assets_historical

Retrieves the historical minute by minute price for the specified asset (for example DAI) in WETH.

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.defiPricesAssetsHistorical({
    asset: "string",
})

defi_prices_assets_latest

Retrieves the latest minute by minute price for the specified asset (for example DAI) in WETH.

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.defiPricesAssetsLatest({
    asset: "string",
})

defi_prices_pairs_historical

Retrieves the historical minute by minute price for the specified pair (for example DAI_WETH).

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.defiPricesPairsHistorical({
    base: "string",
    quote: "string",
})

defi_prices_pairs_latest_copy

Retrieves the latest minute by minute price for the specified pair (for example DAI_WETH).

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.defiPricesPairsLatestCopy({
    base: "string",
    quote: "string",
})

defi_prices_pairs_information

Retrieves the list of all available market pair price data sets.

NOTE: DeFi Price is a reference rate established by liquidity data.

const response = await client.defiPricesPairsInformation({
})

defi_trades_information

Retrieves the list of all available Swaps datasets.

const response = await client.defiTradesInformation({
})

defi_trades_historical

Retrieves the historical (time series) trade data for the specified pool/pair.

  • Asset information can be used from the metadata payload.
  • Base & Quote information is using the first and second asset in a pool/pair, which is the represented price.
const response = await client.defiTradesHistorical({
    pool: "string",
})

dex_twap_assets_information

Retrieves the list of all available market asset twap data sets.

const response = await client.dexTwapAssetsInformation()

dex_twap_assets_historical

Retrieves the historical minute by minute twap for the specified asset (for example DAI).

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.dexTwapAssetsHistorical({
    asset: "string",
})

dex_twap_assets_latest

Retrieves the latest minute by minute twap for the specified asset (for example DAI).

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.dexTwapAssetsLatest({
    asset: "string",
})

dex_twap_pairs_historical

Retrieves the historical TWAP for the specified base, quote pair - this is the global TWAP across all supported contracts.

Default results are over 1 minute intervals with a 60 minutes lookback period.

TWAP is calculated as a time weighted moving average across all contracts.

const response = await client.dexTwapPairsHistorical({
    base: "string",
    quote: "string",
})

dex_twap_pairs_latest

Retrieves the latest TWAP for the specified base, quote pair - this is the global TWAP across all supported contracts based on minutely data.

Price is calculated as a time weighted moving average.

const response = await client.dexTwapPairsLatest({
    base: "string",
    quote: "string",
})

dex_twap_pairs_information

Retrieves the list of all available DeFi pair TWAP data sets.

const response = await client.dexTwapPairsInformation({
})

dex_vwap_assets_information

Retrieves the list of all available market asset vwap data sets.

const response = await client.dexVwapAssetsInformation()

dex_vwap_assets_historical

Retrieves the historical minute by minute twap for the specified asset (for example DAI).

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.dexVwapAssetsHistorical({
    asset: "string",
})

dex_vwap_assets_latest

Retrieves the latest minute by minute vwap for the specified aset (for example DAI).

NOTE: DeFi Price is a reference rate established by trade data.

const response = await client.dexVwapAssetsLatest({
    asset: "string",
})

dex_vwap_pairs_historical

Retrieves the historical VWAP for the specified base, quote pair - this is the global VWAP across all supported contracts.

Default results are over 1 minute intervals with 60 minutes lookback period.

VWAP is calculated as a volume weighted moving average across all contracts.

const response = await client.dexVwapPairsHistorical({
    base: "string",
    quote: "string",
})

defi_vwap_pairs_latest

Retrieves the latest VWAP for the specified base, quote pair - this is the global VWAP across all supported contracts based on minutely data.

Price is calculated as a volume weighted moving average.

const response = await client.defiVwapPairsLatest({
    base: "string",
    quote: "string",
})

defi_vwap_pairs_information

Retrieves the list of all available market pair VWAP data sets.

const response = await client.defiVwapPairsInformation({
})

get_market_exchanges

Retrieves information about supported exchange-pairs for these types of data: • ohlcv (open-high-low-close-volume) • order book snapshot • order book event • ticker • trade

const response = await client.getMarketExchanges({
})

futures_exchanges_pairs

Retrieves information about supported exchange & instruments for these types of data: • funding rates • liquidations • long short ratio • ohlcv (open-high-low-close-volume) • open interest • order book snapshot • order book event • ticker • trade

const response = await client.futuresExchangesPairs({
})

futures_exchanges_reference

Retrieves reference information for each of the instruments.

const response = await client.futuresExchangesReference({
})

batch_historical_ent

Retrieves the historical time series funding rates for the specified exchange and instrument(s).

const response = await client.batchHistoricalEnt({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ent

Retrieves the latest funding rates for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestByExchangeEnt({
    exchange: "string",
})

futures_funding_rates_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresFundingRatesInformation({
})

futures_funding_rates_historical

Retrieves the historical time series funding rates for the specified instrument and exchange(s).

const response = await client.futuresFundingRatesHistorical({
    instrument: "string",
})

futures_funding_rates_latest

Retrieves the latest funding rates for the specified instrument.

const response = await client.futuresFundingRatesLatest({
    instrument: "string",
})

futures_insurance_fund_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresInsuranceFundInformation({
})

futures_insurance_fund_historical

Retrieves the historical insurance fund for the specified instrument and exchange(s).

const response = await client.futuresInsuranceFundHistorical({
    instrument: "string",
})

futures_insurance_fund_latest

Retrieves the latest Insurance Fund for the specified instrument and exchange(s).

const response = await client.futuresInsuranceFundLatest({
    instrument: "string",
})

futures_liquidations_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresLiquidationsInformation({
})

futures_liquidations_historical

Retrieves the historical time series liquidations for the specified instrument and exchange(s).

const response = await client.futuresLiquidationsHistorical({
    instrument: "string",
})

futures_liquidations_latest

Retrieves the latest liquidations for the specified instrument and exchange(s).

const response = await client.futuresLiquidationsLatest({
    instrument: "string",
})

futures_long_short_ratio_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresLongShortRatioInformation({
})

futures_long_short_ratio_historical

Retrieves the historical time series Long/Short Ratio data for the specified instrument and exchange(s).

const response = await client.futuresLongShortRatioHistorical({
    instrument: "string",
})

futures_long_short_ratio_latest

Retrieves the latest Long/Short Ratio data for the specified instrument.

const response = await client.futuresLongShortRatioLatest({
    instrument: "string",
})

ohlcv_ond

Retrieves the historical time series OHLCV data for the specified exchange and instrument(s).

const response = await client.ohlcvOnd({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ond

Retrieves the latest Open High Low Close Volume data for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestByExchangeOnd({
    exchange: "string",
})

futures_ohlcv_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresOhlcvInformation({
})

futures_ohlcv_historical

Retrieves the historical time series OHLCV data for the specified instrument and exchange(s).

const response = await client.futuresOhlcvHistorical({
    instrument: "string",
})

futures_ohlcv_latest

Retrieves the latest Open High Low Close Volume data for the specified instrument.

const response = await client.futuresOhlcvLatest({
    instrument: "string",
})

batch_historical_ent_1

Retrieves the historical time series open interest for the specified exchange and instrument(s).

const response = await client.batchHistoricalEnt1({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ent_2

Retrieves the latest open interest for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestByExchangeEnt2({
    exchange: "string",
})

futures_open_interest_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresOpenInterestInformation({
})

futures_open_interest_historical

Retrieves the historical time series open interest for the specified instrument and exchange(s).

const response = await client.futuresOpenInterestHistorical({
    instrument: "string",
})

futures_open_interest_latest

Retrieves the latest open interest for the specified instrument.

const response = await client.futuresOpenInterestLatest({
    instrument: "string",
})

futures_order_book_events_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresOrderBookEventsInformation({
})

futures_order_book_events_historical

Retrieves the historical time series order book events (bid and ask) for the specified instrument and exchange(s).

Note: This endpoint returns a maximum of 1 hour of historical data per request. The parameters startDate and endDate can be used to specify any arbitrary time range.

const response = await client.futuresOrderBookEventsHistorical({
    instrument: "string",
    exchange: "string",
})

futures_order_book_snapshots_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresOrderBookSnapshotsInformation({
})

futures_order_book_snapshots_historical

Retrieves the historical time series order book snapshots (bid and ask) for the specified instrument and exchange(s).

Note: This endpoint returns a maximum of 10 minutes of historical data per request. The parameters startDate and endDate can be used to specify any arbitrary time range.

const response = await client.futuresOrderBookSnapshotsHistorical({
    instrument: "string",
    exchange: "string",
})

futures_tickers_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresTickersInformation({
})

futures_tickers_historical

Retrieves the historical time series tickers for the specified instrument and exchange(s).

const response = await client.futuresTickersHistorical({
    instrument: "string",
})

futures_tickers_latest

Retrieves the latest tickers for the specified instrument and exchange(s).

const response = await client.futuresTickersLatest({
    instrument: "string",
})

futures_trades_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.futuresTradesInformation({
})

futures_trades_historical

Retrieves the historical (time series) trade data for the specified instrument.

Note: This endpoint returns a max of 1 hour historical data per request. In order to get more than 1 hour you must use the startDate & endDate parameters to move the time frame window to get the next n hours/days/months of data.

const response = await client.futuresTradesHistorical({
    instrument: "string",
    exchange: "string",
})

market_metrics_exchanges_volumes_historical

Retrieves the total volume traded by the exchanges in USD.

const response = await client.marketMetricsExchangesVolumesHistorical({
})

market_metrics_exchanges_volumes_latest

Retrieves the total volume traded by the exchanges in USD over a rolling 24h period, updated hourly. The timestamp returned represents the beginning of the daily bar, following the same approach as OHLCV.

const response = await client.marketMetricsExchangesVolumesLatest({
})

market_metrics_exchanges_assets_volumes_historical

Retrieves the daily volume of assets on each exchange.

*Note: This endpoint excludes data from LMAX.

const response = await client.marketMetricsExchangesAssetsVolumesHistorical({
    exchange: "string",
})

market_metrics_exchanges_assets_volumes_latest

Retrieves the daily volume of assets on each exchange over a rolling 24h period, updated hourly. The timestamp returned represents the beginning of the daily bar, following the same approach as OHLCV. Note: This endpoint excludes data from LMAX.

const response = await client.marketMetricsExchangesAssetsVolumesLatest({
    exchange: "string",
})

market_metrics_exchanges_pairs_volumes_historical

Retrieves the daily volume of pairs on each exchange.

const response = await client.marketMetricsExchangesPairsVolumesHistorical({
    exchange: "string",
})

market_metrics_exchanges_pairs_volumes_latest

Retrieves the daily volume of pairs on each exchange over a rolling 24h period, updated hourly. The timestamp returned represents the beginning of the daily bar, following the same approach as OHLCV.

const response = await client.marketMetricsExchangesPairsVolumesLatest({
    exchange: "string",
})

implied_yield_latest

Retrieves the implied yield of all available non-perpetual contracts for an asset on an exchange.

*Note: Implied yield is only calculated for instruments which have not expired yet.

const response = await client.impliedYieldLatest({
    asset: "string",
    futuresExchange: "string",
    spotExchange: "string",
})

market_metrics_asset_supply_historical

Retrieves historical supply data for blockchains and tokens from October 2019 forward. *Note: We get supply values directly from our data/nodes. Blockchains included in our supply data are: Ethereum, Bitcoin and Litecoin.

const response = await client.marketMetricsAssetSupplyHistorical({
    asset: "string",
})

market_metrics_asset_supply_latest

Retrieves latest supply data for blockchains and tokens.*Note: We get supply values directly from our data/nodes. Blockchains included in our supply data are: Ethereum, Bitcoin and Litecoin.

const response = await client.marketMetricsAssetSupplyLatest({
    asset: "string",
})

implied_yield_historical

Retrieves the historical basis APR for an instrument on an exchange.

*Note: Implied yield is only calculated for instruments which have not expired yet.

const response = await client.impliedYieldHistorical({
    instrument: "string",
    futuresExchange: "string",
    spotExchange: "string",
})

market_asset_metrics_historical_nvt_pro

Get the NVT metric for a specific asset symbol over a period of time.

const response = await client.marketAssetMetricsHistoricalNvtPro({
    symbolPath: "string",
})

market_asset_metrics_historical_sharpe_pro

Get the Sharpe metric for a specific asset symbol over a period of time.

const response = await client.marketAssetMetricsHistoricalSharpePro({
    symbolPath: "string",
})

market_asset_metrics_historical_stock_to_flow_pro

Get the Stock to Flow metric for a specific asset symbol over a period of time.

const response = await client.marketAssetMetricsHistoricalStockToFlowPro({
    symbolPath: "string",
})

market_asset_metrics_latest

Get advanced metrics like NVT, Sharpe and Stock to Flow for a specific asset symbol.

const response = await client.marketAssetMetricsLatest({
    symbolPath: "string",
})

options_exchanges_pairs

Retrieves information about supported exchange & instruments for these types of data: • liquidations • ohlcv (open-high-low-close-volume) • open interest • order book snapshot • order book event • ticker • trade

const response = await client.optionsExchangesPairs({
})

options_exchanges_reference

Retrieves reference information for each of the pairs.

const response = await client.optionsExchangesReference({
})

options_liquidations_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsLiquidationsInformation({
})

options_liquidations_historical

Retrieves the historical time series liquidations for the specified instrument and exchange(s).

const response = await client.optionsLiquidationsHistorical({
    instrument: "string",
})

options_liquidations_latest

Retrieves the latest liquidations for the specified instrument and exchange(s).

const response = await client.optionsLiquidationsLatest({
    instrument: "string",
})

batch_historical_ond_1

Retrieves the historical time series OHLCV data for the specified exchange and instrument(s). Note: Block trades are included in the calculation of OHCLV for Deribit.

const response = await client.batchHistoricalOnd1({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ond_1

Retrieves the latest Open High Low Close Volume data for the specified exchange. Instruments with no activity in the past 24 hours are ignored. Note: Block trades are included in the calculation of OHCLV for Deribit.

const response = await client.latestByExchangeOnd1({
    exchange: "string",
})

options_ohlcv_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsOhlcvInformation({
})

options_ohlcv_historical

Retrieves the historical time series OHLCV data for the specified instrument and exchange(s). Note: Block trades are included in the calculation of OHCLV for Deribit.

const response = await client.optionsOhlcvHistorical({
    instrument: "string",
})

options_ohlcv_latest

Retrieves the latest Open High Low Close Volume data for the specified instrument. Note: Block trades are included in the calculation of OHCLV for Deribit.

const response = await client.optionsOhlcvLatest({
    instrument: "string",
})

batch_historical_ent_2

Retrieves the historical time series open interest for the specified exchange and instrument(s).

const response = await client.batchHistoricalEnt2({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ent_3

Retrieves the latest open interest for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestByExchangeEnt3({
    exchange: "string",
})

options_open_interest_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsOpenInterestInformation({
})

options_open_interest_historical

Retrieves the historical time series open interest for the specified instrument and exchange(s).

const response = await client.optionsOpenInterestHistorical({
    instrument: "string",
})

options_open_interest_latest

Retrieves the latest open interest for the specified instrument.

const response = await client.optionsOpenInterestLatest({
    instrument: "string",
})

options_order_book_events_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsOrderBookEventsInformation({
})

options_order_book_events_historical

Retrieves the historical time series order book events (bid and ask) for the specified instrument and exchange(s).

const response = await client.optionsOrderBookEventsHistorical({
    instrument: "string",
})

options_order_book_snapshots_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsOrderBookSnapshotsInformation({
})

options_order_book_snapshots_historical

Retrieves the historical time series order book snapshots (bid and ask) for the specified instrument and exchange(s).

const response = await client.optionsOrderBookSnapshotsHistorical({
    instrument: "string",
    exchange: "string",
})

options_tickers_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsTickersInformation({
})

options_tickers_historical

Retrieves the historical time series tickers for the specified instrument and exchange(s).

const response = await client.optionsTickersHistorical({
    instrument: "string",
    exchange: "string",
})

options_tickers_latest

Retrieves the latest tickers for the specified instrument and exchange(s).

const response = await client.optionsTickersLatest({
    instrument: "string",
    exchange: "string",
})

options_trades_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.optionsTradesInformation({
})

options_trades_historical

Retrieves the historical (time series) trade data for the specified instrument.

const response = await client.optionsTradesHistorical({
    instrument: "string",
    exchange: "string",
})

get_market_pairs

Retrieves information about supported exchange-pairs for these types of data: • ohlcv (open-high-low-close-volume) • order book snapshot • order book event • ticker • trade

const response = await client.getMarketPairs({
})

market_rankings_historical

Retrieves the top ranked assets, tokens and native coins, by a specific metric.

const response = await client.marketRankingsHistorical({
    date: "string",
})

market_rankings

Retrieves the top ranked assets, tokens and native coins, by a specific metric.

const response = await client.marketRankings({
})

spot_exchanges_reference

Retrieves reference information for each of the pairs.

const data: GetMarketSpotExchangesReferenceBody = {}
const response = await client.spotExchangesReference({
    data: data,
})

batch_historical_ond

Retrieves the historical (time series) open-high-low-close for the specified exchange and pairs. Note: The timestamp returned refers to the start of the candle.

const response = await client.batchHistoricalOnd({
    exchange: "string",
    pair: "string",
})

latest_by_exchange

Retrieves the latest open-high-low-close for the specified exchange. Pairs with no activity in the past 24 hours are ignored.

const response = await client.latestByExchange({
    exchange: "string",
})

get_market_ohlc_information

Retrieves information about supported exchange-pairs for ohlcv. Includes data for both centralized and decentralized exchange data.

const response = await client.getMarketOhlcInformation({
})

get_historical_ohlc

Retrieves the historical (time series) open-high-low-close for the specified pair. Note: The timestamp returned refers to the start of the candle.

const response = await client.getHistoricalOhlc({
    pair: "string",
})

get_ohlcv_pair_latest

Retrieves the latest open-high-low-close for the specified pair.

const response = await client.getOhlcvPairLatest({
    pair: "string",
})

order_book_updates

Retrieves order book update/events (bid and ask). The volume of this data is very large for many exchanges and pairs.

const response = await client.orderBookUpdates({
    pair: "string",
})

snapshots_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.snapshotsInformation({
})

get_market_orders

Retrieves the order book data for the specified pair.

const response = await client.getMarketOrders({
    pair: "string",
    exchange: "string",
})

spot_prices_assets_information

Retrieves the list of all the available supported assets and time range availability.

const response = await client.spotPricesAssetsInformation({
})

spot_prices_assets_historical

Retrieves the historical price for the specified asset - the price is calculated across all exchanges which supports this asset, including all cross rates pairs.

Price of an asset is calculated as the VWAP (Volume Weighted Average Price) across all exchanges supporting this asset, with a 1 bar lookback period.

const response = await client.spotPricesAssetsHistorical({
    asset: "string",
})

spot_prices_assets_latest

Retrieves the latest price for the specified asset - the global price is calculated across all exchanges which supports this asset, including all cross rates pairs.

Price of an asset is calculated as the VWAP (Volume Weighted Average Price) across all exchanges supporting this asset, with a 1 bar lookback period.

const response = await client.spotPricesAssetsLatest({
    asset: "string",
})

spot_prices_pairs_information

Retrieves the list of all the available supported pairs and time range availability.

const response = await client.spotPricesPairsInformation({
})

spot_prices_pairs_historical

Retrieves the historical price for the specified pair - the price is calculated across all exchanges which supports this pair, including all cross rates pairs.

Price of a pair is calculated as the VWAP (Volume Weighted Average Price) across all exchanges supporting this pair, with a 1 bar lookback period. If the parameter exchange is specified, the data returned is the VWAP for that pair on that exchange.

const response = await client.spotPricesPairsHistorical({
    pair: "string",
})

spot_prices_pairs_latest

Retrieves the latest price for the specified pair - the price is calculated across all exchanges which supports this pair.

Price of a pair is calculated as the VWAP (Volume Weighted Average Price) across all exchanges supporting this pair, with a 1 bar lookback period.

If the parameter exchange is specified, the data returned is the price for that pair on that exchange.

const response = await client.spotPricesPairsLatest({
    pair: "string",
})

spot_reference_quotes_historical

Retrieves the historical reference quotes for the specified pair.

The default granularity is up to 1 second intervals (depending on the exchange).

const response = await client.spotReferenceQuotesHistorical({
    pair: "string",
    endDate: "1970-01-01T00:00:00",
    startDate: "1970-01-01T00:00:00",
})

get_all_market_tickers

Retrieves the list of all available market tickers.

const response = await client.getAllMarketTickers({
})

get_market_ticker_pair_historical

Retrieves the historical ticker, bid/ask/mid/last, for the specified pair.

const response = await client.getMarketTickerPairHistorical({
    pair: "string",
})

get_latest_market_ticker

Retrieves the latest market ticker Bid/Ask/Mid/Last for the specified pair.

const response = await client.getLatestMarketTicker({
    pair: "string",
})

trades

Retrieves the list of all available market trade data sets.

const response = await client.trades({
})

market_trades

Retrieves the historical (time series) trade data for the specified pair.

const response = await client.marketTrades({
    pair: "string",
})

spot_twap_assets_information

Retrieves the list of all the available supported assets and time range availability.

const response = await client.spotTwapAssetsInformation({
})

spot_twap_assets_historical

Retrieves the historical TWAP for the specified asset - this is the global TWAP across all exchanges which supports this asset, including all cross rates pairs.

Price is calculated as a time weighted moving average across all exchanges.

const response = await client.spotTwapAssetsHistorical({
    asset: "string",
})

spot_twap_assets_latest

Retrieves the latest TWAP for the specified asset - this is the global TWAP across all exchanges which supports this asset, including all cross rates pairs, based on minutely data.

TWAP is calculated as a time weighted moving average across all exchanges.

const response = await client.spotTwapAssetsLatest({
    asset: "string",
})

spot_twap_pairs_information

Retrieves the list of all the available supported pairs and time range availability.

const response = await client.spotTwapPairsInformation({
})

spot_twap_pairs_historical

Retrieves the historical TWAP for the specified pair - this is the global TWAP across all exchanges which supports this pair, including all cross rates pairs.

Price is calculated as a time weighted moving average across all exchanges.

If the parameter exchange is specified, the data returned is the TWAP for that pair on that exchange.

const response = await client.spotTwapPairsHistorical({
    pair: "string",
})

spot_twap_pairs_latest

Retrieves the latest TWAP for the specified pair - this is the global TWAP across all exchanges which supports this pair, based on minutely data.

Price is calculated as a time weighted moving average across all exchanges.

If the parameter exchange is specified, the data returned is the TWAP for that pair on that exchange.

const response = await client.spotTwapPairsLatest({
    pair: "string",
})

spot_vwap_assets_information

Retrieves the list of all the available supported assets and time range availability.

const response = await client.spotVwapAssetsInformation({
})

spot_vwap_assets_historical

Retrieves the historical VWAP for the specified asset - this is the global VWAP across all exchanges which supports this asset, including all cross rates pairs.

Price is calculated as a volume weighted moving average across all exchanges.

const response = await client.spotVwapAssetsHistorical({
    asset: "string",
})

spot_vwap_assets_latest

Retrieves the latest VWAP for the specified asset - this is the global VWAP across all exchanges which supports this asset, including all cross rates pairs, based on minutely data.

VWAP is calculated as a volume weighted moving average across all exchanges.

const response = await client.spotVwapAssetsLatest({
    asset: "string",
})

spot_vwap_pairs_information

Retrieves the list of all the available supported pairs and time range availability.

const response = await client.spotVwapPairsInformation({
})

spot_vwap_pairs_historical

Retrieves the historical VWAP for the specified pair - this is the global VWAP across all exchanges which supports this pair, including all cross rates pairs.

Price is calculated as a volume weighted moving average across all exchanges.

If the parameter exchange is specified, the data returned is the VWAP for that pair on that exchange.

const response = await client.spotVwapPairsHistorical({
    pair: "string",
})

spot_vwap_pairs_latest

Retrieves the latest VWAP for the specified pair - this is the global VWAP across all exchanges which supports this pair, based on minutely data.

Price is calculated as a volume weighted moving average across all exchanges.

If the parameter exchange is specified, the data returned is the VWAP for that pair on that exchange.

const response = await client.spotVwapPairsLatest({
    pair: "string",
})

swaps_exchanges_pairs

Retrieves information about supported exchange & pairs for these types of data: • funding rates • liquidations • ohlcv (open-high-low-close-volume) • open interest • order book snapshot • order book event • ticker • trade

const response = await client.swapsExchangesPairs({
})

swaps_exchanges_reference

Retrieves reference information for each of the pairs.

const response = await client.swapsExchangesReference({
})

batch_historical_ent_3

Retrieves the historical time series funding rates for the specified exchange and instrument(s).

const response = await client.batchHistoricalEnt3({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ent_1

Retrieves the latest funding rates for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestByExchangeEnt1({
    exchange: "string",
})

swaps_funding_rates_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsFundingRatesInformation({
})

swaps_funding_rates_historical

Retrieves the historical time series funding rates for the specified instrument and exchange(s).

const response = await client.swapsFundingRatesHistorical({
    instrument: "string",
})

swaps_funding_rates_latest

Retrieves the latest funding rates for the specified instrument.

const response = await client.swapsFundingRatesLatest({
    instrument: "string",
})

swaps_insurance_fund_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsInsuranceFundInformation({
})

swaps_insurance_fund_historical

Retrieves the historical insurance fund for the specified instrument and exchange(s).

const response = await client.swapsInsuranceFundHistorical({
    instrument: "string",
})

swaps_insurance_fund_latest

Retrieves the latest Insurance Fund for the specified instrument and exchange(s).

const response = await client.swapsInsuranceFundLatest({
    instrument: "string",
})

swaps_liquidations_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsLiquidationsInformation({
})

swaps_liquidations_historical

Retrieves the historical time series liquidations for the specified instrument and exchange(s).

const response = await client.swapsLiquidationsHistorical({
    instrument: "string",
})

swaps_liquidations_latest

Retrieves the latest liquidations for the specified instrument and exchange(s).

const response = await client.swapsLiquidationsLatest({
    instrument: "string",
})

batch_historical_ond_2

Retrieves the historical time series OHLCV data for the specified exchange and instrument(s).

const response = await client.batchHistoricalOnd2({
    exchange: "string",
    instrument: "string",
})

latest_ond

Retrieves the latest Open High Low Close Volume data for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestOnd({
    exchange: "string",
})

swaps_ohlcv_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsOhlcvInformation({
})

swaps_ohlcv_historical

Retrieves the historical time series OHLCV data for the specified instrument and exchange(s).

const response = await client.swapsOhlcvHistorical({
    instrument: "string",
})

swaps_ohlcv_latest

Retrieves the latest Open High Low Close Volume data for the specified instrument.

const response = await client.swapsOhlcvLatest({
    instrument: "string",
})

batch_historical_ent_4

Retrieves the historical time series open interest for the specified exchange and instrument(s).

const response = await client.batchHistoricalEnt4({
    exchange: "string",
    instrument: "string",
})

latest_by_exchange_ent_4

Retrieves the latest open interest for the specified exchange. Instruments with no activity in the past 24 hours are ignored.

const response = await client.latestByExchangeEnt4({
    exchange: "string",
})

swaps_open_interest_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsOpenInterestInformation({
})

swaps_open_interest_historical

Retrieves the historical time series open interest for the specified instrument and exchange(s).

const response = await client.swapsOpenInterestHistorical({
    instrument: "string",
})

swaps_open_interest_latest

Retrieves the latest open interest for the specified instrument.

const response = await client.swapsOpenInterestLatest({
    instrument: "string",
})

swaps_order_book_events_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsOrderBookEventsInformation({
})

swaps_order_book_events_historical

Retrieves the historical time series order book events (bid and ask) for the specified instrument and exchange(s).

Note: This endpoint returns a maximum of 1 hour of historical data per request. The parameters startDate and endDate can be used to specify any arbitrary time range.

const response = await client.swapsOrderBookEventsHistorical({
    instrument: "string",
})

swaps_order_book_snapshots_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsOrderBookSnapshotsInformation({
})

swaps_order_book_snapshots_historical

Retrieves the historical time series order book snapshots (bid and ask) for the specified instrument and exchange(s).

Note: This endpoint returns a maximum of 10 minutes of historical data per request. The parameters startDate and endDate can be used to specify any arbitrary time range.

const response = await client.swapsOrderBookSnapshotsHistorical({
    instrument: "string",
    exchange: "string",
})

swaps_tickers_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsTickersInformation({
})

swaps_tickers_historical

Retrieves the historical time series tickers for the specified instrument and exchange(s).

const response = await client.swapsTickersHistorical({
    instrument: "string",
})

swaps_tickers_latest

Retrieves the latest liquidations for the specified instrument and exchange(s).

const response = await client.swapsTickersLatest({
    instrument: "string",
})

swaps_trades_information

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsTradesInformation({
})

swaps_trades_historical

Retrieves the list of all the available exchanges, supported instruments and time range availability.

const response = await client.swapsTradesHistorical({
    instrument: "string",
    exchange: "string",
})

get_historical_token_price

Retrieves the historical prices (and other market information) for the specified token from October 2019 forward.

Note: This endpoint returns a max of 6 months of historical data. In order to get more than 6 months you must use the startDate & endDate parameters to move the time frame window to get the next n days/months of data.

const response = await client.getHistoricalTokenPrice({
    symbolPath: "string",
})

get_current_token_price

Retrieves the latest price (and other market information) for the specified token. Tokens with no activity in the past 24 hours are ignored.

const response = await client.getCurrentTokenPrice({
    symbolPath: "string",
})

get_4_byte_signature

Retrieves detailed information about the specified signature hash.

const response = await client.get4ByteSignature({
    hash: "string",
})

token_metrics_historical

Retrieves the historical metrics for the specified ERC token symbol.

const response = await client.tokenMetricsHistorical({
    symbolPath: "string",
})

token_metrics_latest

Retrieves the latest metrics for the specified ERC token symbol.

const response = await client.tokenMetricsLatest({
    symbolPath: "string",
})

get_token_rankings

Retrieves the top ranked Ethereum tokens by a specific metric.

const response = await client.getTokenRankings({
})

token_rankings_historical

Retrieves the top ranked Ethereum tokens by a specific metric, with a lookback window. Useful for viewing token trends.

const response = await client.tokenRankingsHistorical({
})

get_historical_token_holders

Retrieves the historical (time series) token holders for the specified token address.

const response = await client.getHistoricalTokenHolders({
    hash: "string",
    holderAddresses: "string",
})

get_token_holders

Retrieves the token holders for the specified address.

const response = await client.getTokenHolders({
    hash: "string",
})

get_historical_token_supply

Retrieves the historical token supplies (and derivatives) for the specified address.

Note: This endpoint returns a max of 6 months of historical data. In order to get more than 6 months you must use the startDate & endDate parameters to move the time frame window to get the next n days/months of data.

const response = await client.getHistoricalTokenSupply({
    hash: "string",
})

get_token_supply_latest

Retrieves the latest token supplies (and derivatives) for the specified address.

const response = await client.getTokenSupplyLatest({
    hash: "string",
})

get_token_transfers

Retrieves all token transfers involving the specified token address.

const response = await client.getTokenTransfers({
    hash: "string",
})

get_token_velocity

Retrieves the historical velocity for the specified address.

const response = await client.getTokenVelocity({
    hash: "string",
})

get_token_volume

Retrieves the historical number of transfers for the specified address.

const response = await client.getTokenVolume({
    hash: "string",
})

get_all_transactions

Retrieves all transactions matching the specified filters.

const response = await client.getAllTransactions({
})

mempool_all

Retrieves the mempool for a specific blockchain matching the specified filters. Default results are for Ethereum, however, please make sure your "x-amberdata-blockchain-id" header matches the blockchain you want to retrieve data for.

*Note: Mempool data is available for Ethereum, Bitcoin or Litecoin.

const response = await client.mempoolAll({
})

transactions_metrics_historical

Get metrics for historical confirmed transactions for a given blockchain. Default metrics are for Ethereum over a 1d tick / 365d lookback period. Changing the header blockchain ID will return that blockchains metrics.

const response = await client.transactionsMetricsHist
axiosform-data
1.0.0

6 months ago