For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tokens

Endpoints for searching, listing, and retrieving Clanker token data.

GET /api/tokens/authenticated

Search and list tokens (authenticated variant with higher limits up to 200 per page).

Authentication: Partner API Key (x-api-key header)

Query Parameters

Parameter
Type
Required
Default
Description

q

string

No

—

Free-text search query.

fids

string

No

—

Comma-separated FIDs.

msgSender

address

No

—

Deployer address filter.

pairAddress

address

No

—

Pool/pair address filter.

sort

`"asc"

"desc"`

No

desc

sortBy

`"market-cap"

"tx-h24"

"price-percent-h24"

"price-percent-h1"

socialInterface

string

No

—

Social interface filter.

cursor

string

No

—

Pagination cursor.

startDate

number

No

—

Start date filter (unix timestamp).

limit

number

No

10

Page size (0–200).

offset

number

No

0

Offset.

includeUser

boolean

No

false

Include user data.

includeMarket

boolean

No

false

Include market data.

chainId

number

No

—

Chain ID.

champagne

boolean

No

false

Champagne filter.

pair

string

No

all

Paired token filter.

Response: Paginated token list.


GET /api/get-clanker-by-address

Returns detailed token data by EVM contract address or Solana token mint, including deployer info and social URLs.

Authentication: Partner API Key (x-api-key header)

Query Parameters

Parameter
Type
Required
Default
Description

address

address

Yes

—

EVM token contract (0x…) or Solana mint address.

Response: Token data with social URLs and verified address.

Cached for 2 minutes.


GET /api/get-clankers-by-fid

Returns tokens deployed by a Farcaster FID.

Authentication: Partner API Key (x-api-key header)

Query Parameters

Parameter
Type
Required
Default
Description

fid

number

Yes

—

Farcaster ID (positive integer).

cursor

string

No

—

Pagination cursor.

Response: Paginated token list.

Fixed page size of 10. Cached for 5 seconds.


GET /api/tokens/fetch-by-admin

Returns tokens administered by a given address.

Authentication: Partner API Key (x-api-key header)

Query Parameters

Parameter
Type
Required
Default
Description

admin

address

Yes

—

Admin wallet address.

cursor

string

No

—

Pagination cursor.

limit

number

No

10

Page size (1–200).

includeUser

boolean

No

false

Include user data.

includeMarket

boolean

No

false

Include market data.

chainId

number

No

—

Chain ID.

Response: Paginated token list.


GET /api/tokens/is-blocked

Checks whether a token address is blocked.

Authentication: Partner API Key (x-api-key header)

Query Parameters

Parameter
Type
Required
Default
Description

address

address

Yes

—

Token contract address.

chainId

number

No

—

Chain ID (optional — checks globally if omitted).

Response: Blocked status.

Cached for 1 minute.


Last updated