---
updatedAt: 2026-08-19T14:40:16.000Z
agentTools:
projectIndex: https://docs.blockberry.one/llms.txt
---
# getDex
Get a list of all DEXes 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 project for which a DEX is deployed. |
| | imgUrl | A link to the image of the project for which a DEX is deployed. |
| | isIndexed | A flag showing that we collect data about a DEX. |
| Package | packageId | The ID of the package by which a DEX is deployed. |
| | packageName | The name of the package by which a DEX is deployed. |
| | packageImg | A link to the image of the project for which a DEX is deployed. |
# 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": {
"post": {
"tags": [
"DEFI"
],
"summary": "getDex",
"description": "Get a list of all DEXes registered with the Sui Directory.",
"operationId": "getDex",
"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 DEX data is shown.",
"required": true,
"schema": {
"type": "string",
"description": "Period for which DEX 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": "CURRENT_TVL",
"enum": [
"CURRENT_TVL"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DexSearchParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/PageDexDtoAPI"
}
}
}
}
}
}
}
},
"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"
}
}
},
"DexSearchParams": {
"type": "object",
"properties": {
"withTvlOnly": {
"type": "boolean",
"description": "Flag showing if only DEXes with TVL are queried.",
"default": false
}
}
},
"DefiPackageDto": {
"type": "object",
"properties": {
"packageAddress": {
"type": "string"
},
"packageImg": {
"type": "string"
},
"packageName": {
"type": "string"
}
}
},
"DexDtoAPI": {
"type": "object",
"properties": {
"projectName": {
"type": "string"
},
"imgUrl": {
"type": "string"
},
"socialWebsite": {
"type": "string"
},
"socialDiscord": {
"type": "string"
},
"socialTwitter": {
"type": "string"
},
"socialTelegram": {
"type": "string"
},
"currTvl": {
"type": "number"
},
"volume": {
"type": "number"
},
"volumeChange": {
"type": "number",
"format": "double"
},
"txsCount": {
"type": "integer",
"format": "int64"
},
"poolsCount": {
"type": "integer",
"format": "int64"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DefiPackageDto"
}
},
"isIndexed": {
"type": "boolean"
}
}
},
"PageDexDtoAPI": {
"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/DexDtoAPI"
}
},
"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"
}
}
}
}
```