Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.uniswap_v3.uniswap_liquidity_provision_in_range(chain=models.V1UniswapLiquidityProvisionInRangeChain.ARBITRUM, token_id=4318185)

    # Handle response
    print(res)

{
  "in_range": true
}

Uniswap V3

Check if LP is Active.

This endpoint allows users to check whether a specific liquidity provider () position is within the active tick range on the uniswap platform.

by providing the token id associated with the position, users can verify if the position is currently within the tick range where trading occurs. this information is essential for users to monitor the status of their lp positions and ensure that they are actively participating in the trading activities within the liquidity pool and earning trading fees.

GET

uniswap

liquidity_provision

in_range

Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.uniswap_v3.uniswap_liquidity_provision_in_range(chain=models.V1UniswapLiquidityProvisionInRangeChain.ARBITRUM, token_id=4318185)

    # Handle response
    print(res)

{
  "in_range": true
}

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_id

integer

default:4318185

required

Token ID of the NFT representing the liquidity provisioned position.

Required range: x >= 0

Response

Successful Response

in_range

boolean

required

Whether the position is in active tick range or not. If not in range, the position is not earning trading fees.

Pool Price List LP

⌘I

API Reference

Authorizations

Query Parameters

Response