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
  • Get Paginated List of Tokens
  • Get Paginated List of Tokens with Search
  1. Developers
  2. API

Public Endpoints

Get Paginated List of Tokens

Retrieves a paginated list of deployed tokens with optional filtering and sorting capabilities.

GET https://www.clanker.world/api/tokens

Query Parameters

Parameter
Type
Default
Description

sort

string

desc

Sort order for results based on creation date (asc or desc)

page

number

1

Page number for pagination

pair

string

all

Filter by trading pair. Options: WETH, ANON, HIGHER, DEGEN, or CLANKER

socialInterface

string

all

Filter by social_context.interface

Example Request

curl "https://www.clanker.world/api/tokens"

Example Response

{
  "data": [
    {
      "id": 241400,
      "created_at": "2025-04-15T00:16:39.464442+00:00",
      "tx_hash": "0x581b54f7b59def7483eb0306d924f82910582d3d024f2dd9a2195341eacd43b9",
      "contract_address": "0x6270BCB5398927335AEf599EdD1CC666FcC77797",
      "name": "deployer",
      "symbol": "$deployer",
      "pool_address": "0x213264B1Bc0F39f705687fdaBe97E8b3F8B3455F",
      "cast_hash": "bankr deployment",
      "type": "clanker_v3_1",
      "pair": "WETH",
      "chain_id": 8453,
      "metadata": {
        "auditUrls": [],
        "description": "",
        "socialMediaUrls": []
      },
      "deploy_config": {
        "devBuyAmount": 0,
        "lockupPercentage": 0,
        "vestingUnlockDate": 0
      },
      "social_context": {
        "interface": "Bankr",
        "messageId": "bankr deployment",
        "id": "886870"
        "platform": "Farcaster"
      },
      "requestor_fid": 886870,
      "deployed_at": "2025-04-15T00:16:35",
      "msg_sender": "0x2112b8456AC07c15fA31ddf3Bf713E77716fF3F9",
      "factory_address": "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382",
      "locker_address": "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
      "warnings": [],
      "pool_config": {
        "pairedToken": "0x4200000000000000000000000000000000000006",
        "tickIfToken0IsNewToken": -230400
      },
      "starting_market_cap": 9.870869513221747
    },
    {
      "id": 241399,
      "created_at": "2025-04-15T00:15:37.032429+00:00",
      "tx_hash": "0x0088ae9400e6cc0de3414bd4b9ad13d68c6822b05a4895fa14a4181cb0ef4b58",
      "contract_address": "0x6B2B40bF4c0c6734fd738f7090e8D694C817e91D",
      "name": "Pokemon",
      "symbol": "PKMON",
      "img_url": "https://pbs.twimg.com/media/GogsV0mWIAA6YnY.jpg",
      "pool_address": "0xf8827866d4bd7a8Ef237a457d5924C87E702Da81",
      "cast_hash": "https://twitter.com/millionbby12/status/1911936222257197369",
      "type": "clanker_v3_1",
      "pair": "WETH",
      "chain_id": 8453,
      "metadata": {
        "auditUrls": [],
        "description": "Deployed using Bankr on X",
        "socialMediaUrls": []
      },
      "deploy_config": {
        "devBuyAmount": 0,
        "lockupPercentage": 0,
        "vestingUnlockDate": 0
      },
      "social_context": {
        "interface": "Bankr",
        "messageId": "bankr deployment",
        "id": "886870"
        "platform": "Farcaster"
      },
      "requestor_fid": 886870,
      "deployed_at": "2025-04-15T00:15:33",
      "msg_sender": "0x2112b8456AC07c15fA31ddf3Bf713E77716fF3F9",
      "factory_address": "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382",
      "locker_address": "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
      "warnings": [],
      "pool_config": {
        "pairedToken": "0x4200000000000000000000000000000000000006",
        "tickIfToken0IsNewToken": -230400
      },
      "starting_market_cap": 9.870869513221747
    },
  ],
  "hasMore": true,
  "total": 34480
}
  • Results are paginated with 5 items per page

  • Search is case-insensitive and matches partial strings

  • The search matches against both token names and symbols

Get Paginated List of Tokens with Search

Search for deployed tokens based on various criteria including name, symbol, and requestor FIDs.

GET https://www.clanker.world/api/tokens/search

Query Parameters

Parameter
Type
Required
Description

q

string

No

Search query for token name or symbol

type

string

No

Filter by token type. Values: all (default), proxy

fids

string

No

Comma-separated list of Farcaster IDs to filter by

page

number

No

Page number for pagination (default: 1)

Example Requests

# Basic search
curl "https://www.clanker.world/api/tokens/search?q=test&page=1"

# Search with filters
curl "https://www.clanker.world/api/tokens/search?q=test&type=clanker_v2&fids=1234,5678&page=1"

Example Response

{
  "data": [
    {
      "id": 241400,
      "created_at": "2025-04-15T00:16:39.464442+00:00",
      "tx_hash": "0x581b54f7b59def7483eb0306d924f82910582d3d024f2dd9a2195341eacd43b9",
      "contract_address": "0x6270BCB5398927335AEf599EdD1CC666FcC77797",
      "name": "deployer",
      "symbol": "$deployer",
      "pool_address": "0x213264B1Bc0F39f705687fdaBe97E8b3F8B3455F",
      "cast_hash": "bankr deployment",
      "type": "clanker_v3_1",
      "pair": "WETH",
      "chain_id": 8453,
      "metadata": {
        "auditUrls": [],
        "description": "",
        "socialMediaUrls": []
      },
      "deploy_config": {
        "devBuyAmount": 0,
        "lockupPercentage": 0,
        "vestingUnlockDate": 0
      },
      "social_context": {
        "interface": "Bankr",
        "messageId": "bankr deployment",
        "id": "886870"
      },
      "requestor_fid": 886870,
      "deployed_at": "2025-04-15T00:16:35",
      "msg_sender": "0x2112b8456AC07c15fA31ddf3Bf713E77716fF3F9",
      "factory_address": "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382",
      "locker_address": "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
      "warnings": [],
      "pool_config": {
        "pairedToken": "0x4200000000000000000000000000000000000006",
        "tickIfToken0IsNewToken": -230400
      },
      "starting_market_cap": 9.870869513221747
    },
    {
      "id": 241399,
      "created_at": "2025-04-15T00:15:37.032429+00:00",
      "tx_hash": "0x0088ae9400e6cc0de3414bd4b9ad13d68c6822b05a4895fa14a4181cb0ef4b58",
      "contract_address": "0x6B2B40bF4c0c6734fd738f7090e8D694C817e91D",
      "name": "Pokemon",
      "symbol": "PKMON",
      "img_url": "https://pbs.twimg.com/media/GogsV0mWIAA6YnY.jpg",
      "pool_address": "0xf8827866d4bd7a8Ef237a457d5924C87E702Da81",
      "cast_hash": "https://twitter.com/millionbby12/status/1911936222257197369",
      "type": "clanker_v3_1",
      "pair": "WETH",
      "chain_id": 8453,
      "metadata": {
        "auditUrls": [],
        "description": "Deployed using Bankr on X",
        "socialMediaUrls": []
      },
      "deploy_config": {
        "devBuyAmount": 0,
        "lockupPercentage": 0,
        "vestingUnlockDate": 0
      },
      "social_context": {
        "interface": "Bankr",
        "messageId": "bankr deployment",
        "id": "886870"
      },
      "requestor_fid": 886870,
      "deployed_at": "2025-04-15T00:15:33",
      "msg_sender": "0x2112b8456AC07c15fA31ddf3Bf713E77716fF3F9",
      "factory_address": "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382",
      "locker_address": "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
      "warnings": [],
      "pool_config": {
        "pairedToken": "0x4200000000000000000000000000000000000006",
        "tickIfToken0IsNewToken": -230400
      },
      "starting_market_cap": 9.870869513221747
    },
  ],
  "hasMore": true,
  "total": 186
}
  • Results are paginated with 5 items per page

  • Search is case-insensitive and matches partial strings

  • The search matches against both token names and symbols

PreviousAPINextDeploy a Token

Last updated 1 month ago