---
updatedAt: 2026-08-19T14:40:16.000Z
agentTools:
projectIndex: https://docs.blockberry.one/llms.txt
---
# getDexPools
Get the total number of all DEX pools registered with the Sui Directory.
> 📘 This is the Pro endpoint, currently available for free as part of the API campaign.
We provide the following metadata for this endpoint:
| Object | Parameter | Description |
| :-------- | :-------------- | :--------------------------------------------------------------------------------------------------------- |
| Project | projectName | The name of the DEX project that has a DEX pool. |
| | projectImg | A link to the image of the DEX project that has a DEX pool. |
| | isIndexed | A flag showing that we collect data about a DEX pool. |
| Pool | poolId | The ID of a DEX pool. |
| | poolName | The name of a DEX pool. |
| | poolImg | A link to the image of a DEX pool. |
| Pool Coin | coinType | The type of coin provided in the following format: NxN::\{coin name}::\{COIN NAME}. |
| | coinName | The name of the coin in a DEX pool. |
| | imgUrl | A link to the image of the coin that is involved in a transaction that ran with a DEX. |
| | coinSymbol | The symbol of the coin denomination involved in a transaction that ran with the queried DEX. |
| | securityMessage | A message warning the user that a coin used in a transaction that ran with the queried DEX is a scam coin. |
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Sui mainnet API",
"description": "This is the new API Module implementation. The SUI Blockchain API is used to retrieve SUI Blockchain data. In order to execute queries you need to get API Key and use it in header 'x-api-key'. However, before that you need to sign up on the explorer or company website. If an account is created on the website https://staketab.com/ or https://suiscan.xyz/, the user will be granted the ROLE_USER role. After that you may fetch API KEY.",
"termsOfService": "terms-of-service",
"contact": {
"name": "Staketab tech support",
"url": "https://staketab.com/",
"email": "support@staketab.com"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.blockberry.one/sui",
"description": "Production"
}
],
"security": [
{
"x-api-key": []
}
],
"paths": {
"/v1/dex/pools": {
"post": {
"tags": [
"DEFI"
],
"summary": "getDexPools",
"description": "Get the total number of all DEX pools registered with the Sui Directory.",
"operationId": "getDexPools",
"parameters": [
{
"name": "page",
"in": "query",
"description": "Queried API page.",
"required": true,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "size",
"in": "query",
"description": "Number of queried entries.",
"required": true,
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 20
}
},
{
"name": "orderBy",
"in": "query",
"description": "Sorting method: from the lowest element to the highest (ASC) or from the highest element to the lowest (DESC).",
"required": true,
"schema": {
"type": "string",
"default": "DESC",
"enum": [
"ASC",
"DESC"
]
}
},
{
"name": "period",
"in": "query",
"description": "Period for which data is shown.",
"required": true,
"schema": {
"type": "string",
"description": "Period for which data is shown.",
"default": "DAY",
"enum": [
"DAY",
"WEEK",
"MONTH"
]
}
},
{
"name": "sortBy",
"in": "query",
"description": "Select sorting parameter.",
"required": true,
"schema": {
"type": "string",
"description": "Select sorting parameter.",
"default": "LIQUIDITY_IN_USD",
"enum": [
"LIQUIDITY_IN_USD",
"VOLUME"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DexPoolSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PageDexPoolDtoAPI"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"PageableObject": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int64"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"paged": {
"type": "boolean"
},
"unpaged": {
"type": "boolean"
}
}
},
"SortObject": {
"type": "object",
"properties": {
"sorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
},
"unsorted": {
"type": "boolean"
}
}
},
"DexPoolSearchParams": {
"required": [
"poolFactoryId"
],
"type": "object",
"properties": {
"poolFactoryId": {
"type": "array",
"description": "Common ID for all pools of a single DEX.",
"example": "CETUS",
"items": {
"type": "string",
"description": "Common ID for all pools of a single DEX.",
"example": "CETUS"
}
},
"poolFactoryEmpty": {
"type": "boolean"
}
}
},
"DexPoolCoinDtoAPI": {
"type": "object",
"properties": {
"coinType": {
"type": "string"
},
"coinName": {
"type": "string"
},
"imgUrl": {
"type": "string"
},
"coinSymbol": {
"type": "string"
},
"supply": {
"type": "number"
},
"supplyInUsd": {
"type": "number"
},
"coinSeq": {
"type": "integer",
"format": "int32"
},
"securityMessage": {
"type": "string"
},
"hasNoMetadata": {
"type": "boolean"
}
}
},
"DexPoolDtoAPI": {
"type": "object",
"properties": {
"poolId": {
"type": "string"
},
"poolName": {
"type": "string"
},
"poolImg": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectImg": {
"type": "string"
},
"liquidityInUsd": {
"type": "number"
},
"volume": {
"type": "number"
},
"price": {
"type": "number",
"format": "double"
},
"txsCount": {
"type": "integer",
"format": "int64"
},
"fee": {
"type": "number"
},
"coins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DexPoolCoinDtoAPI"
}
},
"isIndexed": {
"type": "boolean"
}
}
},
"PageDexPoolDtoAPI": {
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"pageable": {
"$ref": "#/components/schemas/PageableObject"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DexPoolDtoAPI"
}
},
"number": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/SortObject"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
},
"securitySchemes": {
"x-api-key": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
}
}
}
}
```