Skip to content

Get Liquidity by Token

This endpoint returns liquidity data for a given token address. Supported chains: ethereum, polygon, optimism, arbitrum, base, avalanche.

Parameters

Parameter Description Type
chain_id A keyword (i.e. "ethereum") or CAIP-2 identifier specifying the blockchain to query. string
token_address required The address of the token. string
from_timestamp The earlier timestamp to retrieve liquidity data between, inclusive (in seconds since the Unix epoch or ISO-8601 format). date-time
to_timestamp The later timestamp to retrieve liquidity data between, inclusive (in seconds since the Unix epoch or ISO-8601 format). date-time
order The order in which to retrieve the results (either asc or desc). string
limit The maximum number of results to retrieve (default 100). string

Response

Name Type Description
block_number integer The block number at which the event occurred.
category text The category of the event, one of (deposit, withdraw, or swap).
contract_address text The contract address of the DEX pool.
contract_version text The version of the exchange contract interacted with (e.g. v1 or v2).
exchange_name text The name of the exchange that facilitated the event.
liquidity numeric The total pool liquidity between the tick range post transaction (only Uniswap V3 and Kyber V3).
liquidity_delta numeric The change in the liquidity in the tick range (only Uniswap V3 and Kyber V3).
log_index integer The log index at which the event occurred.
lp_address text The address of the liquidity provider (null for swap events).
pool_balance numeric The DEX Pool's balance of token_address
position_id integer Unique position NFT ID for the tick range (only Uniswap V3 and Kyber V3).
position_liquidity numeric The total position liquidity for position_id post transaction (only Uniswap V3 and Kyber V3).
quantity numeric The quantity of the token_address (negative for withdrawals, swaps out).
sender_address text The address that initiated the event.
tick_lower numeric The bottom of the tick range (only Uniswap V3 and Kyber V3).
tick_upper numeric The top of the tick range (only Uniswap V3 and Kyber V3).
timestamp timestamp without time zone The timestamp at which the event occurred.
token_address text The token address whose pool balance was affected in the liquidity event.
transaction_hash text The transaction hash at which the event occurred.

curl -X GET \
    'https://api.transpose.io/dex/liquidity-by-token?chain_id=ethereum&token_address=0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2' \
    -H 'X-API-KEY: BtRVYj7dgnYUcr1gSSfWhmrTShIb8RBG' \

Got questions? Join our Discord

Discord is the primary home of the Transpose developer community. Join us to ask questions, share your work, and get help.