[DEPRECATED] Get Uncollected Fees

Get estimated uncollected fees (in base and quote tokens) for a specific token contract.

This enpoint has been deprecated. Instead, use this SDK method to get token rewards: https://github.com/clanker-devco/clanker-sdk/blob/main/examples/v4/getTokenRewards.ts

V3.1:

GET https://www.clanker.world/api/get-estimated-uncollected-fees/[contract_address]

For v4 clankers: you must include the reward recipient address you are getting the uncollected fee amounts for, as multiple reward recipients may be assigned for the token.

V4:

GET https://www.clanker.world/api/get-estimated-uncollected-fees/[contract_address]?rewardRecipientAddress=[reward_recipient_address]

Headers:

x-api-key: your_api_key

Query Parameters:

Parameter	Type	Description
contract_address	string	The token contract address to query
rewardRecipientAddress	string	The reward recipient address (required for v4's)

Example Request (v3.1):

curl -X GET \
  'https://www.clanker.world/api/get-estimated-uncollected-fees/[token_address]' \
  -H 'x-api-key: your_api_key'

Example Request (v4):

curl -X GET 'http://localhost:3000/api/get-estimated-uncollected-fees/[token_address]?rewardRecipientAddress=[reward_recipient_address]' \
-H 'x-api-key: your_api_key' | jq

Response Format

Example Response:

{
  "lockerAddress": "0x618A9840691334eE8d24445a4AdA4284Bf42417D",
  "lpNftId": 1605020,
  "token1UncollectedRewards": "25549999999999",
  "token0UncollectedRewards": "256188371342895862809729",
  "token0": {
    "chainId": 8453,
    "address": "0x054E4121a946da752a5Cab371BE52B2E6A897ba8",
    "symbol": "MTK",
    "decimals": 18,
    "name": "My Token"
  },
  "token1": {
    "chainId": 8453,
    "address": "0x4200000000000000000000000000000000000006",
    "symbol": "WETH",
    "decimals": 18,
    "name": "Wrapped Ether"
  }
}

Response Fields

Top-Level Fields:

Field	Type	Description
lockerAddress	string	Address of the fee locker contract
lpNftId	integer	Unique identifier for the liquidity position NFT
token0UncollectedRewards	string	Uncollected rewards for token0 (in base units)
token1UncollectedRewards	string	Uncollected rewards for token1 (in base units)
token0	object	Details of the first token in the pair
token1	object	Details of the second token in the pair

Token Object Fields:

Field	Type	Description
chainId	integer	Chain ID where the token is deployed
address	string	Token contract address
symbol	string	Token symbol
decimals	integer	Number of decimal places for the token
name	string	Token name