Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

chain
enum<string>
default:arbitrum
required
Available options:
arbitrum,
base,
ethereum
token
string
default:USDC
required

The symbol or address of the asset to get liquidity change for.. A token identifier - either a supported symbol (e.g., USDC, WETH) or a valid Ethereum address (0x...)

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

start_block
integer
default:0
required

The start block to calculate liquidity change from.

Required range: x >= 0
end_block
integer
default:319407231
required

The end block to calculate liquidity change to.

Required range: x >= 0

Response

Successful Response

liquidity_change
string
required

The change in the liquidity index between the two times, expressed as a percentage.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
start_time
string<date-time>
required

Dateime of starting block

end_time
string<date-time>
required

Datetime of ending block