Get Estimated Rewards

Get estimated rewards for a specific token pool address.

GET https://www.clanker.world/api/tokens/estimate-rewards-by-pool-address

Headers:

x-api-key: your_api_key

Query Parameters:

Parameter
Type
Description

poolAddress

string

Address of the token's liquidity pool

Example Request:

curl -X GET \
  'https://www.clanker.world/api/tokens/estimate-rewards-by-pool-address?poolAddress=pool_address' \
  -H 'x-api-key: your_api_key'

Response Format

Example Response:

{
  "userRewards": 4051.7574064199907
}

Response Fields

Field
Type
Description

userRewards

number

Estimated rewards value in USD for the specified pool

Notes

  • The rewards value is returned as a floating-point number

  • Results are estimates and may vary from actual rewards

  • Values are calculated based on current prices of tokens in the pool

Last updated