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

partner

string

all

Filter by partner identifier

Example Request

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

Example Response

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-09T20:31:07.026218+00:00",
      "tx_hash": "0xcffcb5b2b72148861b81806acc786d7f4be5ba7052195858714af79093dc167f",
      "contract_address": "0x33F6a644B4bc77f5FED906d6092424fC5FaE20ED",
      "requestor_fid": 123,
      "name": "name",
      "symbol": "symbol",
      "img_url": "https://example.com/image.png",
      "pool_address": "0xa9Ea40Cf1652a48DBbCDf5E9da2deD3a4fF63DD3",
      "cast_hash": "0x87329332b57c3b6b1ae84622b2d6c3695683e927",
      "type": "clanker_v2",
      "pair": "WETH"
    }
  ],
  "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

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": 252,
      "created_at": "2024-11-09T14:26:21.129442+00:00",
      "tx_hash": "0xa0dbf4cf50b5a02833c28ce0885373ec5e3d28beb5a283495580d0fea89b95ad",
      "contract_address": "0x282565dDE7aFeb934334FcdF7aB30A8a07285180",
      "requestor_fid": 211845,
      "name": "Test",
      "symbol": "TST",
      "img_url": null,
      "pool_address": "0x74AD7a85811af78Cac76048C774D5ED8B0a9EfEb",
      "cast_hash": "0xda8c0a71aec85e6390ed8efd2f3f486446825671",
      "type": null,
      "pair": null
    }
  ],
  "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

Last updated