API Endpoints

Search - Token, market Data

get
https://public-api.birdeye.so/defi/v3/search

Search for tokens and market data by providing a name, symbol, token address, or market address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Search entry point for tokens and markets.

  • Search by token name, symbol, token address, or market address.
  • target, search_mode, and search_by shape how broad or exact the search should be.
  • Results are paginated with offset and limit up to 20.
  • ui_amount_mode=scaled applies Solana Token-2022 scaled UI amount where supported.
Compute Unit ⚙️
  • This endpoint consumes 40 CU per request.
Use Cases 💡
  • Power token and market search bars.
  • Resolve noisy symbols into exact token or market candidates.
  • Support discovery flows before users open token detail pages.
How to Use 🛠️
  • Set x-chain or use the supported search chain mode.
  • Pass keyword, then narrow with target, search_mode, or search_by if needed.
  • Use offset and limit for paginated result sets.
Best Practices ✅
  • Use exact address search when you already know the token or market address.
  • Use fuzzy or broader search for UI search boxes, then hydrate the selected result with dedicated data endpoints.
  • Keep limit small for interactive search experiences.

Query Params
string
enum
Defaults to all

Specify the chain.

string
string
enum
Defaults to all

An option to search tokens based on their expected results as token, market, or both.

Allowed:
string
enum
Defaults to exact

An option to search tokens with exact match or partially match.

Allowed:
string
enum
Defaults to symbol

An option to search tokens by symbol, name, or both.

Allowed:
string
enum
required
Defaults to volume_24h_usd

Specify the sort field.

string
enum
required
Defaults to desc

Specify the sort order.

Allowed:
boolean
enum

A filter to retrieve tokens based on their verification status (supported on Solana).

Allowed:
string

A comma-separated list of market sources to filter results (supported on Solana). Available options: ['Raydium', 'Raydium CP', 'Raydium Clamm', 'Meteora', 'Meteora DLMM', 'Fluxbeam', 'Pump.fun', 'OpenBook', 'OpenBook V2', 'Orca'].

integer
Defaults to 0

Specify the offset for pagination. Filter for records with offset greater than the specified offset value, including those with offset equal to the specified offset.

integer
1 to 20
Defaults to 20

Number of items per page.

string
enum
Defaults to scaled

Indicate whether to use the scaled amount for scaled ui amount tokens. Only support solana

Allowed:
Responses

Updated 8 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?