Clanker Documentation
  • Introduction to Clanker
  • Users
    • FAQ
    • Deploying a Token
    • Creator Rewards
    • Token Deployment & Token Info
      • Presale Token Deployments
    • Unclaimed Rewards Balance
  • Developers
    • SDK
    • API
      • Public Endpoints
      • Deploy a Token
        • Standard Deployment
        • Standard Deployment w/Custom Reward Splits
      • Get Clanker Info by Address
      • Get Tokens Deployed by Address
      • Get Estimated Rewards in USD
      • Get Estimated Uncollected Fees
  • Core Contracts
    • Clanker (Direct Contract Deployments)
    • LpLockerv2
    • ClankerVault
  • Integrations / Partnerships
  • References
    • Brand Assets
    • Changelog
    • Audits
    • Deployed Contracts
    • Supported Quote Tokens
    • Core Team
    • Contact
Powered by GitBook
On this page
  • Response Format
  • Notes
  1. Developers
  2. API

Get Estimated Rewards in USD

Get estimated rewards for a specific token pool address.

PreviousGet Tokens Deployed by AddressNextGet Estimated Uncollected Fees

Last updated 4 months ago

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

Headers:

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

x-api-key: your_api_key