> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coingecko.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Search Pools & Tokens
> To search for pools across all networks by pool address, token name, token symbol, or token contract address
export const CacheInfo = ({publicRate, paidRate, rate}) => {
const fmt = v => v === 0 ? 'Real-time (Cacheless)' : `Every ${v}`;
if (rate !== undefined) {
return
Cache / Update Frequency:
{fmt(rate)}
;
}
if (publicRate !== undefined && paidRate !== undefined) {
return
Cache / Update Frequency:- {fmt(paidRate)} (Paid API)
- {fmt(publicRate)} (Demo / Keyless API)
;
}
return null;
};
#### Notes
* Search by pool address, token name, token symbol, or token contract address.
* Returns up to 20 pools per page. Use the `page` param to navigate more results. Pagination beyond 10 pages requires [Analyst plan or above](https://www.coingecko.com/en/api/pricing).
* Unverified token market cap returns `null` — the displayed value on GeckoTerminal may match FDV and might not be accurate.
* Use `include` to return related attributes under the top-level `included` key.
#### SDK Examples
```typescript TypeScript theme={null}
const response = await client.onchain.search.pools.get({
query: 'weth',
});
console.log(JSON.stringify(response, null, 2));
```
```python Python theme={null}
response = client.onchain.search.pools.get(
query="weth",
)
print(response.model_dump_json(indent=2))
```
## OpenAPI
````yaml openapi-specs/demo-api.json get /onchain/search/pools
openapi: 3.0.0
info:
title: CoinGecko Demo API
version: 3.0.0
servers:
- url: https://api.coingecko.com/api/v3
security:
- headerAuth: []
- queryAuth: []
paths:
/onchain/search/pools:
get:
summary: Search Pools & Tokens
description: >-
To search for pools across all networks by pool address, token name,
token symbol, or token contract address
operationId: search-pools
parameters:
- name: query
in: query
required: false
description: >-
Search query: pool contract address, token name, token symbol, or
token contract address.
schema:
type: string
default: weth
- name: network
in: query
required: false
description: |-
Network ID.
*refers to [`/onchain/networks`](/reference/networks-list).
schema:
type: string
- name: include
in: query
required: false
description: |-
Attributes to include, comma-separated if more than one.
Available values: `base_token`, `quote_token`, `dex`
schema:
type: string
- name: page
in: query
required: false
description: |-
Page through results.
Default value: 1
schema:
type: integer
responses:
'200':
description: Pool search results
content:
application/json:
schema:
$ref: '#/components/schemas/PoolSearch'
example:
data:
- id: eth_0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640
type: pool
attributes:
base_token_price_usd: '2084.57214039429'
base_token_price_native_currency: '1.0'
quote_token_price_usd: '1.00359565004917'
quote_token_price_native_currency: '0.00048094599624371'
base_token_price_quote_token: '2079.235522928'
quote_token_price_base_token: '0.0004809459962'
address: '0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640'
name: WETH / USDC 0.05%
pool_created_at: '2021-12-29T12:35:14Z'
fdv_usd: '4700091001.66103'
market_cap_usd: '4706648770.97887'
price_change_percentage:
m5: '0'
m15: '0'
m30: '0'
h1: '0'
h6: '0.599'
h24: '-1.887'
transactions:
m5:
buys: 1
sells: 1
buyers: 1
sellers: 1
m15:
buys: 7
sells: 24
buyers: 7
sellers: 18
m30:
buys: 21
sells: 53
buyers: 15
sellers: 41
h1:
buys: 57
sells: 123
buyers: 39
sellers: 88
h6:
buys: 431
sells: 477
buyers: 194
sellers: 279
h24:
buys: 2436
sells: 2385
buyers: 863
sellers: 989
volume_usd:
m5: '2407.6289853096'
m15: '210244.509017768'
m30: '1067809.71712486'
h1: '2766027.68033409'
h6: '17336676.2757229'
h24: '122795216.58555'
reserve_in_usd: '101050763.5099'
relationships:
base_token:
data:
id: eth_0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
type: token
quote_token:
data:
id: eth_0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
type: token
dex:
data:
id: uniswap_v3
type: dex
included:
- id: eth_0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
type: token
attributes:
address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2'
name: Wrapped Ether
symbol: WETH
decimals: 18
image_url: >-
https://coin-images.coingecko.com/coins/images/2518/large/weth.png?1696503332
coingecko_coin_id: weth
- id: eth_0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
type: token
attributes:
address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
name: USD Coin
symbol: USDC
decimals: 6
image_url: >-
https://coin-images.coingecko.com/coins/images/6319/large/USDC.png?1769615602
coingecko_coin_id: usd-coin
- id: uniswap_v3
type: dex
attributes:
name: Uniswap V3
components:
schemas:
PoolSearch:
type: object
required:
- data
properties:
data:
type: array
items:
type: object
required:
- id
- type
- attributes
- relationships
properties:
id:
type: string
description: Pool identifier
type:
type: string
description: Resource type
attributes:
type: object
required:
- base_token_price_usd
- base_token_price_native_currency
- quote_token_price_usd
- quote_token_price_native_currency
- base_token_price_quote_token
- quote_token_price_base_token
- address
- name
- pool_created_at
- fdv_usd
- market_cap_usd
- price_change_percentage
- transactions
- volume_usd
- reserve_in_usd
properties:
base_token_price_usd:
type: string
description: Base token price in USD
base_token_price_native_currency:
type: string
nullable: true
description: Base token price in native currency
quote_token_price_usd:
type: string
description: Quote token price in USD
quote_token_price_native_currency:
type: string
nullable: true
description: Quote token price in native currency
base_token_price_quote_token:
type: string
nullable: true
description: Base token price in quote token
quote_token_price_base_token:
type: string
nullable: true
description: Quote token price in base token
address:
type: string
description: Pool contract address
name:
type: string
description: Pool name
pool_created_at:
type: string
description: Pool creation timestamp
fdv_usd:
type: string
nullable: true
description: Fully diluted valuation in USD
market_cap_usd:
type: string
nullable: true
description: Market cap in USD
price_change_percentage:
type: object
description: Price change percentage over various timeframes
properties:
m5:
type: string
m15:
type: string
m30:
type: string
h1:
type: string
h6:
type: string
h24:
type: string
transactions:
type: object
description: Transaction counts over various timeframes
properties:
m5:
type: object
properties:
buys:
type: integer
sells:
type: integer
buyers:
type: integer
sellers:
type: integer
m15:
type: object
properties:
buys:
type: integer
sells:
type: integer
buyers:
type: integer
sellers:
type: integer
m30:
type: object
properties:
buys:
type: integer
sells:
type: integer
buyers:
type: integer
sellers:
type: integer
h1:
type: object
properties:
buys:
type: integer
sells:
type: integer
buyers:
type: integer
sellers:
type: integer
h6:
type: object
properties:
buys:
type: integer
sells:
type: integer
buyers:
type: integer
sellers:
type: integer
h24:
type: object
properties:
buys:
type: integer
sells:
type: integer
buyers:
type: integer
sellers:
type: integer
volume_usd:
type: object
description: Volume in USD over various timeframes
properties:
m5:
type: string
m15:
type: string
m30:
type: string
h1:
type: string
h6:
type: string
h24:
type: string
reserve_in_usd:
type: string
nullable: true
description: Total reserve in USD
relationships:
type: object
description: Related resources
properties:
base_token:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
quote_token:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
network:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
dex:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
included:
type: array
description: >-
Included related resources, present when include parameter is
specified
items:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
address:
type: string
name:
type: string
symbol:
type: string
decimals:
type: integer
image_url:
type: string
nullable: true
coingecko_coin_id:
type: string
nullable: true
coingecko_asset_platform_id:
type: string
securitySchemes:
headerAuth:
type: apiKey
in: header
name: x-cg-demo-api-key
description: >-
Learn how to [set up your API
key](https://docs.coingecko.com/docs/setting-up-your-api-key)
queryAuth:
type: apiKey
in: query
name: x_cg_demo_api_key
description: >-
Learn how to [set up your API
key](https://docs.coingecko.com/docs/setting-up-your-api-key)
````