MEXC API Broker

https://www.mexc.com/api-docs
Admin
Documentation for the MEXC API Broker program, enabling partners to integrate trading, account...
Tokens:245,895
Snippets:1,664
Trust Score:5.8
Update:3 hours ago
Show doc for...
Tokens:
Raw
### Installation and Configuration Commands

Source: https://www.mexc.com/api-docs/cli/appendix/quick-reference

Commands to install the MEXC CLI and configure an account. Requires Node.js 20+ and an Access Key/Secret Key for account setup.

```bash
node -v                                           # Confirm Node.js 20+
npm install -g @mexc-ai/cli                       # Install
mexc doctor                                       # Environment check
mexc profile set my-account                          # Configure Access Key / Secret Key
mexc profile use my-account                          # Set as the current account
```

--------------------------------

### Configure MCP by category with mexc-spot entry

Source: https://www.mexc.com/api-docs/cli/ai-agent

JSON configuration for MCP servers, one entry per category. The example sets up the mexc-spot server with the command 'mexc' and arguments for spot market with read-only access.

```json
{
  "mcpServers": {
    "mexc-spot": { "command": "mexc", "args": ["mcp", "spot", "--read-only"] }
  }
}
```

--------------------------------

### Agent setup commands for MCP server

Source: https://www.mexc.com/api-docs/cli/ai-agent

Common agent configuration commands for adding the mexc-spot MCP server. Each command is specific to a different agent (claude, codex, gemini, kiro-cli, code, cursor).

```bash
claude   mcp add-json -s user mexc-spot '{"type":"stdio","command":"mexc","args":["mcp","spot","--read-only"]}'
codex    mcp add mexc-spot -- mexc mcp spot --read-only
gemini   mcp add -s user -t stdio mexc-spot mexc mcp spot --read-only
kiro-cli mcp add --name mexc-spot --command "mexc mcp spot --read-only" --scope global
code     --add-mcp '{"name":"mexc-spot","type":"stdio","command":"mexc","args":["mcp","spot","--read-only"]}'
cursor   --add-mcp '{"name":"mexc-spot","type":"stdio","command":"mexc","args":["mcp","spot","--read-only"]}'
```

--------------------------------

### curl command for Example 2 (Query String)

Source: https://www.mexc.com/api-docs/spot-v3/introduction

Places an order via POST /api/v3/order with all parameters in the query string. Uses the X-MEXC-APIKEY header and the signature from the preceding HMAC SHA256 example. The command is for demonstration with the provided apiKey and secretKey.

```shell
curl command:

    (HMAC SHA256)
    $ curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" \
           -X POST \
           'https://api.mexc.com/api/v3/order?symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=fd3e4e8543c5188531eb7279d68ae7d26a573d0fc5ab0d18eb692451654d837a'
```

--------------------------------

### curl command for Example 1 (Request Body)

Source: https://www.mexc.com/api-docs/spot-v3/introduction

Places an order via POST /api/v3/order with all parameters in the request body. Uses the X-MEXC-APIKEY header and the signature from the preceding HMAC SHA256 example. The command is for demonstration with the provided apiKey and secretKey.

```shell
curl command:

    (HMAC SHA256)
    $ curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" \
           -H "Content-Type: application/json" \
           -X POST \
           'https://api.mexc.com/api/v3/order' \
           --data-raw 'symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=fd3e4e8543c5188531eb7279d68ae7d26a573d0fc5ab0d18eb692451654d837a'
```

--------------------------------

### Find global npm root for MEXC CLI binary path

Source: https://www.mexc.com/api-docs/cli/ai-agent

Run this command to locate the global npm root directory. Append '/@mexc-ai/cli-<platform>/bin/mexc' to the output to get the full path to the MEXC CLI binary. Replace <platform> with your platform (e.g., win32-x64, darwin-arm64, linux-x64).

```bash
npm root -g     # Append /@mexc-ai/cli-<platform>/bin/mexc to the output directory
```

--------------------------------

### Install and verify MEXC CLI with npm

Source: https://www.mexc.com/api-docs/cli/installation

Installs the @mexc-ai/cli package globally, then confirms the installation and runs an environment check. `mexc doctor` verifies the data directory, server connectivity, credential readability, and agent skill document compatibility; run it first when something looks wrong.

```bash
npm install -g @mexc-ai/cli    # Install
mexc --version                 # Confirm installation
mexc doctor                    # Environment check
```

--------------------------------

### Python deserialization example for PushDataV3ApiWrapper

Source: https://www.mexc.com/api-docs/spot-v3/websocket-market-streams/protocol-buffers-integration

Parsing example: import the generated module, assemble a PushDataV3ApiWrapper object, serialize to a string, then deserialize and print the result.

```python
#Parsing example:

import PushDataV3ApiWrapper_pb2

# Assemble the object
pushData = PushDataV3ApiWrapper_pb2.PushDataV3ApiWrapper()
pushData.channel = 'spot@public.aggre.depth.v3.api.pb@10ms'
pushData.symbol = 'BTCUSDT'

# Serialize to a string
serializedData = pushData.SerializeToString()

# Deserialize into a PushDataV3ApiWrapper object
result = PushDataV3ApiWrapper_pb2.PushDataV3ApiWrapper()
result.ParseFromString(serializedData)
print(result)
```

--------------------------------

### GET /api/v3/exchangeInfo - Response Example

Source: https://www.mexc.com/api-docs/spot-v3/market-data-endpoints/exchange-information

Example JSON response from the exchangeInfo endpoint. Shows symbol details, filters, commissions, and trading permissions.

```json
{
    "timezone": "CST",
    "serverTime": 1786334624020,
    "rateLimits": [],
    "exchangeFilters": [],
    "symbols": [
        {
            "symbol": "METALUSDT",
            "status": "1",
            "baseAsset": "METAL",
            "baseAssetPrecision": 2,
            "quoteAsset": "USDT",
            "quotePrecision": 5,
            "quoteAssetPrecision": 5,
            "baseCommissionPrecision": 2,
            "quoteCommissionPrecision": 5,
            "orderTypes": [
                "LIMIT",
                "MARKET",
                "LIMIT_MAKER"
            ],
            "isSpotTradingAllowed": true,
            "isMarginTradingAllowed": false,
            "quoteAmountPrecision": "1",
            "baseSizePrecision": "0.1",
            "permissions": [
                "SPOT"
            ],
            "filters": [
                {
                    "filterType": "PERCENT_PRICE_BY_SIDE",
                    "bidMultiplierUp": "0.2",
                    "askMultiplierDown": "0.2"
                }
            ],
            "maxQuoteAmount": "2000000",
            "makerCommission": "0",
            "takerCommission": "0.0005",
            "quoteAmountPrecisionMarket": "1",
            "maxQuoteAmountMarket": "100000",
            "fullName": "Metal Blockchain",
            "tradeSideType": 1,
            "contractAddress": "xtokens",
            "conceptPlateIds": [
                51
            ],
            "conceptPlates": [
                "mc-trade-zone-innovation"
            ],
            "st": false
        }
    ]
}
```

--------------------------------

### K-line data sample response

Source: https://www.mexc.com/api-docs/futures/websocket-api/k-line-data

Example of a K-line update pushed to the client. The 't' field is the trade time in seconds (window start).

```json
{
  "channel": "push.kline",
  "data": {
    "a": 233.740269343644737245,
    "c": 6885,
    "h": 6910.5,
    "interval": "Min60",
    "l": 6885,
    "o": 6894.5,
    "q": 1611754,
    "symbol": "BTC_USDT",
    "t": 1587448800
  },
  "symbol": "BTC_USDT"
}
```

--------------------------------

### GET /api/v3/fiat/merchant/ads/limit - Request Example

Source: https://www.mexc.com/api-docs/p2p/account-order-info/get-ads-limit

HTTP GET request to query advertisement limits. Requires P2P Account Read permission and is rate-limited to 50 requests/second. Mandatory parameters: coinId, fiatUnit, and side (BUY/SELL).

```text
GET /api/v3/fiat/merchant/ads/limit?coinId=USDT&fiatUnit=BRL&side=BUY
```

--------------------------------

### Sample data for Spot Account Deals

Source: https://www.mexc.com/api-docs/spot-v3/websocket-user-data-streams/spot-account-deals

Example of the data received on the spot@private.deals.v3.api.pb channel, showing trade details.

```json
{
  "channel": "spot@private.deals.v3.api.pb",
  "symbol": "MXUSDT",
  "sendTime": 1736417034332,
  "privateDeals": {
    "price": "3.6962",
    "quantity": "1",
    "amount": "3.6962",
    "tradeType": 2,
    "isMaker": false,
    "tradeId": "505979017439002624X1",
    "orderId": "C02__505979017439002624115",
    "feeAmount": "0.0003998377369698171",
    "feeCurrency": "MX",
    "time": 1736417034280
  }
}
```

--------------------------------

### GET /api/v3/fiat/merchant/ads/limit - Response Example

Source: https://www.mexc.com/api-docs/p2p/account-order-info/get-ads-limit

Example JSON response showing limit constraints for publishing a P2P advertisement. Includes price limits, floating ratios, quantity limits, per-transaction fiat amounts, payment time limit, and supported payment methods.

```json
{
  "msg": "success",
  "code": 0,
  "data": {
    "minPrice": "1",
    "maxPrice": "100",
    "minPriceRatio": "0.8",
    "maxPriceRatio": "1.2",
    "minQuantity": "100",
    "maxQuantity": "20000",
    "minSingleTransAmount": "50",
    "maxSingleTransAmount": "5000",
    "maxPayTimeLimit": 30,
    "payMethods": [
      { "id": 205, "name": "PIX" },
      { "id": 1, "name": "Bank Transfer" }
    ]
  }
}
```

--------------------------------

### curl command for Example 3 (Mixed Query String and Request Body)

Source: https://www.mexc.com/api-docs/spot-v3/introduction

Places an order via POST /api/v3/order with parameters split between the query string and request body. Uses the X-MEXC-APIKEY header and the signature from the preceding HMAC SHA256 example. The command is for demonstration with the provided apiKey and secretKey.

```shell
curl command:

    (HMAC SHA256)
    $ curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" \
           -H "Content-Type: application/json" \
           -X POST \
           'https://api.mexc.com/api/v3/order?symbol=BTCUSDT&side=BUY&type=LIMIT' \
           --data-raw 'quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=d1a676610ceb39174c8039b3f548357994b2a34139a8addd33baadba65684592'
```

--------------------------------

### Sample data for spot@private.orders.v3.api.pb

Source: https://www.mexc.com/api-docs/spot-v3/websocket-user-data-streams/spot-account-orders

Example response payload for the spot account orders stream. Shows the structure with channel, symbol, sendTime, and privateOrders object.

```json
{
  "channel": "spot@private.orders.v3.api.pb",
  "symbol": "MXUSDT",
  "sendTime": 1736417034281,
  "privateOrders": {
    "clientId": "C02__505979017439002624115",
    "price": "3.5121",
    "quantity": "1",
    "amount": "0",
    "avgPrice": "3.6962",
    "orderType": 5,
    "tradeType": 2,
    "remainAmount": "0",
    "remainQuantity": "0",
    "lastDealQuantity": "1",
    "cumulativeQuantity": "1",
    "cumulativeAmount": "3.6962",
    "status": 2,
    "createTime": 1736417034259
  }
}
```

--------------------------------

### GET /api/v3/broker/capital/deposit/subHisrec/getall

Source: https://www.mexc.com/api-docs/spot-v3/change-log

Broker endpoint to query deposit records. Added response field `subAccount` (string, sub-account name) to the deposit record list and updated the response example.

```APIDOC
## [GET] /api/v3/broker/capital/deposit/subHisrec/getall

### Description
Query deposit records for sub-accounts (Broker).

### Method
GET

### Endpoint
/api/v3/broker/capital/deposit/subHisrec/getall

### Response
#### Success Response (200)
- **subAccount** (string) - Sub-account name.

### Additional Information
- Response example updated.
```

--------------------------------

### GET /api/v1/contract/kline/fair_price/{symbol}

Source: https://www.mexc.com/api-docs/futures/market-endpoints/get-fair-price-candles

Fetches fair price candlestick data for a specified contract symbol. Supports optional interval, start, and end time parameters. Returns arrays of OHLCV data and related fields.

```APIDOC
## GET /api/v1/contract/kline/fair_price/{symbol}

### Description
Retrieves fair price candlestick data for a specified contract symbol. Supports optional interval, start, and end time parameters. Returns arrays of OHLCV data and related fields.

### Method
GET

### Endpoint
/api/v1/contract/kline/fair_price/{symbol}

### Parameters
#### Path Parameters
- **symbol** (string) - Required - Contract symbol

#### Query Parameters
- **interval** (string) - Optional - Interval: Min1, Min5, Min15, Min30, Min60, Hour4, Hour8, Day1, Week1, Month1. Default is Min1 if omitted
- **start** (long) - Optional - Unix second timestamp
- **end** (long) - Optional - Unix second timestamp

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **code** (integer) - Response code
- **data** (object) - Contains arrays of candle data
  - **time** (array of long) - Time window timestamps
  - **open** (array of double) - Open prices
  - **close** (array of double) - Close prices
  - **high** (array of double) - High prices
  - **low** (array of double) - Low prices
  - **vol** (array of double) - Volume
  - **amount** (array of double) - Amount
  - **realOpen** (array of double) - Real open prices
  - **realClose** (array of double) - Real close prices
  - **realHigh** (array of double) - Real high prices
  - **realLow** (array of double) - Real low prices

#### Response Example
```json
{
    "success": true,
    "code": 0,
    "data": {
        "time": [
            1761876000,
            1761876900,
            1761877800,
            1761878700,
            1761879600
        ],
        "open": [
            109573.9,
            109003.9,
            109304.4,
            108726.1,
            108794.9
        ],
        "close": [
            109003.9,
            109304.4,
            108726.1,
            108794.9,
            108629.1
        ],
        "high": [
            109631.6,
            109421.8,
            109353.0,
            108904.4,
            108810.6
        ],
        "low": [
            108960.4,
            109003.9,
            108681.1,
            108500.3,
            108555.6
        ],
        "vol": [
            0.0,
            0.0,
            0.0,
            0.0,
            0.0
        ],
        "amount": [
            0.0,
            0.0,
            0.0,
            0.0,
            0.0
        ],
        "realOpen": [
            109003.9,
            109304.4,
            108726.1,
            108794.9,
            108629.1
        ],
        "realClose": [
            109003.9,
            109304.4,
            108726.1,
            108794.9,
            108629.1
        ],
        "realHigh": [
            109003.9,
            109304.4,
            108726.1,
            108794.9,
            108629.1
        ],
        "realLow": [
            109003.9,
            109304.4,
            108726.1,
            108794.9,
            108629.1
        ]
    }
}
```

### Notes
- The maximum number of data points per request is 2000. If your chosen start/end time and granularity exceed this limit, only 2000 data points will be returned. To obtain fine-grained data over a larger time span, make multiple requests with segmented time ranges.
- If only the start time is provided, data from the start time to the current system time is returned. If only the end time is provided, the 2000 data points closest to the end time are returned. If neither is provided, the 2000 most recent data points relative to the current system time are returned.

### Rate Limit
20 times / 2 seconds
```

--------------------------------

### Sample response for subscription

Source: https://www.mexc.com/api-docs/spot-v3/websocket-market-streams/protocol-buffers-integration

Sample response data for a successful subscription request.

```json
{
  "id": 0,
  "code": 0,
  "msg": "spot@public.aggre.deals.v3.api.pb@100ms@BTCUSDT"
}
```

--------------------------------

### GET /api/v1/contract/kline/{symbol}

Source: https://www.mexc.com/api-docs/futures/market-endpoints/get-candlestick-data

Fetches candlestick data for a specified contract symbol. Supports optional interval, start, and end time parameters. Returns arrays of open, close, high, low, volume, and other data points.

```APIDOC
## GET /api/v1/contract/kline/{symbol}

### Description
Retrieves candlestick (K-line) data for a specified contract symbol. Supports configurable intervals and time ranges.

### Method
GET

### Endpoint
/api/v1/contract/kline/{symbol}

### Parameters
#### Path Parameters
- **symbol** (string) - Required - Contract symbol

#### Query Parameters
- **interval** (string) - Optional - Interval: Min1, Min5, Min15, Min30, Min60, Hour4, Hour8, Day1, Week1, Month1. Default is Min1 if omitted
- **start** (long) - Optional - Unix second timestamp
- **end** (long) - Optional - Unix second timestamp

### Request Example
GET /api/v1/contract/kline/BTC_USDT?interval=Min15&start=1761876000&end=1761879600

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **code** (integer) - Response code
- **data** (object) - Contains arrays of candlestick data
  - **time** (array of long) - Time window timestamps
  - **open** (array of double) - Open prices
  - **close** (array of double) - Close prices
  - **high** (array of double) - High prices
  - **low** (array of double) - Low prices
  - **vol** (array of double) - Volume
  - **amount** (array of double) - Amount
  - **realOpen** (array of double) - Real open prices
  - **realClose** (array of double) - Real close prices
  - **realHigh** (array of double) - Real high prices
  - **realLow** (array of double) - Real low prices

#### Response Example
{
    "success": true,
    "code": 0,
    "data": {
        "time": [
            1761876000,
            1761876900,
            1761877800,
            1761878700,
            1761879600
        ],
        "open": [
            109573.9,
            109006.4,
            109301.5,
            108725.9,
            108794.7
        ],
        "close": [
            109006.4,
            109301.5,
            108725.9,
            108794.7,
            108669.9
        ],
        "high": [
            109628.1,
            109426.2,
            109350.2,
            108913.8,
            108815.1
        ],
        "low": [
            108953.3,
            109006.4,
            108666.2,
            108498.5,
            108649.0
        ],
        "vol": [
            5587051.0,
            5739575.0,
            5945477.0,
            5863529.0,
            1668892.0
        ],
        "amount": [
            6.106243567181E7,
            6.270099147368E7,
            6.47966331717E7,
            6.374986900458E7,
            1.814907510911E7
        ],
        "realOpen": [
            109574.0,
            109010.0,
            109301.4,
            108726.0,
            108794.8
        ],
        "realClose": [
            109006.4,
            109301.5,
            108725.9,
            108794.7,
            108669.9
        ],
        "realHigh": [
            109628.1,
            109426.2,
            109350.2,
            108913.8,
            108815.1
        ],
        "realLow": [
            108953.3,
            109010.0,
            108666.2,
            108498.5,
            108649.0
        ]
    }
}

### Notes
- The maximum number of data points per request is 2000. If the chosen start/end time and granularity exceed this limit, only 2000 data points will be returned. To obtain fine-grained data over a larger time span, make multiple requests with segmented time ranges.
- If only the start time is provided, data from the start time to the current system time is returned. If only the end time is provided, the 2000 data points closest to the end time are returned. If neither is provided, the 2000 most recent data points relative to the current system time are returned.

### Rate Limit
20 times / 2 seconds
```

--------------------------------

### GET /api/v3/capital/config/getall

Source: https://www.mexc.com/api-docs/spot-v3/change-log

Queries the currency information. This documentation update adds the response field `depositPreConfirms` and updates the sample response JSON.

```APIDOC
## [GET] /api/v3/capital/config/getall

### Description
Query the currency information.

### Method
GET

### Endpoint
/api/v3/capital/config/getall

### Response
#### Success Response (200)
- **depositPreConfirms** (type not specified) - Added response field.

### Additional Information
- Sample response JSON updated.
```

--------------------------------

### POST /api/v3/order

Source: https://www.mexc.com/api-docs/spot-v3/introduction

Places a new order on the MEXC Spot exchange. This example demonstrates three ways to send parameters: all in the request body, all in the query string, or mixed between the two. The signature is generated using HMAC SHA256 over the concatenated parameters.

```APIDOC
## POST /api/v3/order

### Description
Places a new order on the MEXC Spot exchange. This example demonstrates three ways to send parameters: all in the request body, all in the query string, or mixed between the two. The signature is generated using HMAC SHA256 over the concatenated parameters.

### Method
POST

### Endpoint
/api/v3/order

### Parameters
#### Path Parameters
None

#### Query Parameters
- **symbol** (string) - Required - Trading pair, e.g., BTCUSDT
- **side** (string) - Required - Order side: BUY or SELL
- **type** (string) - Required - Order type, e.g., LIMIT
- **quantity** (string) - Required - Order quantity
- **price** (string) - Required - Order price
- **recvWindow** (integer) - Optional - Time window for request validity in milliseconds
- **timestamp** (integer) - Required - Current timestamp in milliseconds
- **signature** (string) - Required - HMAC SHA256 signature of the request parameters

#### Request Body
- **symbol** (string) - Required - Trading pair, e.g., BTCUSDT
- **side** (string) - Required - Order side: BUY or SELL
- **type** (string) - Required - Order type, e.g., LIMIT
- **quantity** (string) - Required - Order quantity
- **price** (string) - Required - Order price
- **recvWindow** (integer) - Optional - Time window for request validity in milliseconds
- **timestamp** (integer) - Required - Current timestamp in milliseconds
- **signature** (string) - Required - HMAC SHA256 signature of the request parameters

### Request Example
#### Example 1: All parameters in the Request Body
```shell
curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" \
     -H "Content-Type: application/json" \
     -X POST \
     'https://api.mexc.com/api/v3/order' \
     --data-raw 'symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=fd3e4e8543c5188531eb7279d68ae7d26a573d0fc5ab0d18eb692451654d837a'
```

#### Example 2: All parameters in the Query String
```shell
curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" \
     -X POST \
     'https://api.mexc.com/api/v3/order?symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=fd3e4e8543c5188531eb7279d68ae7d26a573d0fc5ab0d18eb692451654d837a'
```

#### Example 3: Mixed Query String and Request Body
```shell
curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" \
     -H "Content-Type: application/json" \
     -X POST \
     'https://api.mexc.com/api/v3/order?symbol=BTCUSDT&side=BUY&type=LIMIT' \
     --data-raw 'quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=d1a676610ceb39174c8039b3f548357994b2a34139a8addd33baadba65684592'
```

### Response
#### Success Response (200)
No response schema provided in the source.

#### Response Example
No response example provided in the source.

```

--------------------------------

### Sample data for spot@public.bookTicker.batch.v3.api.pb@BTCUSDT

Source: https://www.mexc.com/api-docs/spot-v3/websocket-market-streams/individual-symbol-book-ticker-streamsbatch-aggregation

Example response payload for the batch book ticker stream. It includes the channel, symbol, sendTime, and a publicBookTickerBatch object with bid/ask prices and quantities, version, and lastOrderCreateTime.

```json
{
  "channel" : "spot@public.bookTicker.batch.v3.api.pb@BTCUSDT",
  "symbol" : "BTCUSDT",
  "sendTime" : "1778075380611",
  "publicBookTickerBatch" : {
    "items" : [ {
      "bidPrice" : "100",
      "bidQuantity" : "4",
      "askPrice" : "",
      "askQuantity" : ""
    } ],
    "version" : "10023",
    "lastOrderCreateTime" : "1778075380572"
  }
}
```

--------------------------------

### Deposit and Withdrawal Enum Examples

Source: https://www.mexc.com/api-docs/spot-v3/change-log

Added enum examples to the deposit and withdrawal documentation.

```APIDOC
## [Documentation] Deposit and Withdrawal

### Description
Added enum examples to the deposit and withdrawal documentation.
```

--------------------------------

### POST /api/v3/sub-account/apiKey

Source: https://www.mexc.com/api-docs/spot-v3/subaccount-endpoints/create-an-apikey-for-a-sub-account-for-master-account

Creates an API key for a sub-account. Requires the SPOT_ACCOUNT_WRITE permission. The request must include the sub-account name, a note, permissions, and a timestamp. The response contains the generated API key and secret key.

```APIDOC
## POST /api/v3/sub-account/apiKey

### Description
Creates an API key for a sub-account. Requires the SPOT_ACCOUNT_WRITE permission.

### Method
POST

### Endpoint
/api/v3/sub-account/apiKey

### Parameters
#### Query Parameters
- **subAccount** (STRING) - Required - Sub-account Name
- **note** (STRING) - Required - APIKey note
- **permissions** (STRING) - Required - Permission of APIKey: SPOT_ACCOUNT_READ, SPOT_ACCOUNT_WRITE, SPOT_DEAL_READ, SPOT_DEAL_WRITE, CONTRACT_ACCOUNT_READ, CONTRACT_ACCOUNT_WRITE, CONTRACT_DEAL_READ, CONTRACT_DEAL_WRITE, SPOT_TRANSFER_READ, SPOT_TRANSFER_WRITE
- **ip** (STRING) - Optional - Link IP addresses, separate with commas if more than one. Support up to 20 addresses.
- **recvWindow** (LONG) - Optional - (no description provided)
- **timestamp** (LONG) - Required - (no description provided)

### Response
#### Success Response (200)
- **subAccount** (string) - Sub-account name
- **note** (string) - APIKey note
- **apiKey** (string) - API public key
- **secretKey** (string) - API secret key
- **permissions** (string) - APIKey permissions
- **ip** (string) - Linked IP addresses
- **createTime** (long) - Creation time, Unix millisecond timestamp

#### Response Example
{
    "subAccount": "mexc1",
    "note": "1",
    "apiKey": "arg13sdfgs",
    "secretKey": "nkjwn21973ihi",
    "permissions": "SPOT_ACCOUNT_READ",
    "ip": "135.181.193",
    "createTime": 1597026383085
}
```

--------------------------------

### GET /api/v3/trades

Source: https://www.mexc.com/api-docs/spot-v3/market-data-endpoints/recent-trades-list

Get recent trades for a symbol. By default, returns the latest 500 trades.

```APIDOC
## GET /api/v3/trades

### Description
Get recent trades for a symbol. By default, returns the latest 500 trades.

### Method
GET

### Endpoint
/api/v3/trades

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Symbol name, e.g. BTCUSDT
- **limit** (integer) - Optional - Number of results returned. Default 500; max 1000

### Response
#### Success Response (200)
- **id** - Trade id
- **price** - Price
- **qty** - Number
- **quoteQty** - Trade total
- **time** - Trade time
- **isBuyerMaker** - Was the buyer the maker?
- **isBestMatch** - Was the trade the best price match?
- **tradeType** - Trade type

#### Response Example
```json
[
    {
        "id": null,
        "price": "63530",
        "qty": "0.00317906",
        "quoteQty": "201.96568180",
        "time": 1781226399689,
        "isBuyerMaker": true,
        "isBestMatch": true,
        "tradeType": "ASK"
    },
    {
        "id": null,
        "price": "63530",
        "qty": "0.00100644",
        "quoteQty": "63.93913320",
        "time": 1781226399688,
        "isBuyerMaker": true,
        "isBestMatch": true,
        "tradeType": "ASK"
    },
    {
        "id": null,
        "price": "63529.99",
        "qty": "0.00232318",
        "quoteQty": "147.5916021682",
        "time": 1781226399687,
        "isBuyerMaker": true,
        "isBestMatch": true,
        "tradeType": "ASK"
    }
]
```

### Weight(IP)
5
```

--------------------------------

### GET /api/v3/capital/config/getall

Source: https://www.mexc.com/api-docs/spot-v3/wallet-endpoints/query-the-currency-information

Returns detailed coin information and contract addresses. Requires the SPOT_WITHDRAW_READ permission and has a weight of 10 (IP).

```APIDOC
## GET /api/v3/capital/config/getall

### Description
Returns detailed coin information and contract addresses.

### Method
GET

### Endpoint
/api/v3/capital/config/getall

### Parameters
None

### Response
#### Success Response (200)
- **coin** (string) - Coin symbol
- **depositDesc** (string) - Deposit description
- **depositEnable** (boolean) - Whether deposit is enabled
- **minConfirm** (integer) - Minimum confirmations required for deposit
- **depositPreConfirms** (integer) - Pre-confirmation count for deposit
- **name** (string) - Network display name
- **network** (string) - Withdraw network display name (legacy parameter, will be deprecated)
- **withdrawEnable** (boolean) - Whether withdraw is enabled
- **withdrawFee** (string) - Withdraw fee
- **withdrawIntegerMultiple** (string) - Withdraw amount increment
- **withdrawMax** (string) - Max withdraw amount
- **withdrawMin** (string) - Min withdraw amount
- **sameAddress** (boolean) - Whether deposit and withdraw share the same address format
- **contract** (string) - Contract address
- **withdrawTips** (string) - Withdraw tips
- **depositTips** (string) - Deposit tips
- **netWork** (string) - Withdraw network (new parameter, for the new withdraw endpoint)

#### Response Example
```json
[
    {
        "coin": "CATCHOLD",
        "name": "SpaceCatch",
        "networkList": [
            {
                "coin": "CATCHOLD",
                "depositDesc": "Deposit is prohibited (forced deposit may result in asset loss)",
                "depositEnable": false,
                "minConfirm": 3360,
                "depositPreConfirms": 120,
                "name": "SpaceCatch",
                "network": "Arbitrum One(ARB)",
                "withdrawEnable": true,
                "withdrawFee": "0",
                "withdrawIntegerMultiple": "18",
                "withdrawMax": "100000",
                "withdrawMin": "1",
                "sameAddress": false,
                "contract": "0xf0a479C9c3378638EC603b8B6B0d75903902550B",
                "withdrawTips": null,
                "depositTips": null,
                "netWork": "ARB"
            }
        ]
    },
    {
        "coin": "BBC",
        "name": "ByByeCar",
        "networkList": [
            {
                "coin": "BBC",
                "depositDesc": "Deposit is prohibited (forced deposit may result in asset loss)",
                "depositEnable": false,
                "minConfirm": 20,
                "depositPreConfirms": 2,
                "name": "ByByeCar",
                "network": "Tron(TRC20)",
                "withdrawEnable": true,
                "withdrawFee": "0",
                "withdrawIntegerMultiple": "18",
                "withdrawMax": "200000",
                "withdrawMin": "1",
                "sameAddress": false,
                "contract": "TRrkeSxEypfiTn7gU3Gg3tP756cEhK493b",
                "withdrawTips": "",
                "depositTips": "",
                "netWork": "TRX"
            }
        ]
    }
]
```
```

--------------------------------

### GET /api/v3/sub-account/list

Source: https://www.mexc.com/api-docs/spot-v3/subaccount-endpoints/query-sub-account-list-for-master-account

Get details of the sub-account list. Requires SPOT_ACCOUNT_READ permission. Weight(IP): 1.

```APIDOC
## GET /api/v3/sub-account/list

### Description
Get details of the sub-account list.

### Method
GET

### Endpoint
/api/v3/sub-account/list

### Parameters
#### Query Parameters
- **subAccount** (STRING) - Optional - Sub-account Name
- **isFreeze** (STRING) - Optional - true or false
- **page** (INT) - Optional - Default value: 1
- **limit** (INT) - Optional - Default value: 10, Max value: 200
- **timestamp** (LONG) - Required
- **recvWindow** (LONG) - Optional

### Response
#### Success Response (200)
- **subAccounts** (array) - List of sub-accounts
  - **subAccount** (string) - subAccount name
  - **isFreeze** (boolean) - isFreeze
  - **createTime** (number) - createTime
  - **uid** (string) - subaccount uid

#### Response Example
{
    "subAccounts":[
        {
            "subAccount":"mexc666",
            "isFreeze":false,
            "createTime":1544433328000,
            "uid": "49910511"
        },
        {
            "subAccount":"mexc888",
            "isFreeze":false,
            "createTime":1544433328000,
            "uid": "91921059"
        }
    ]
}
```

--------------------------------

### GET /api/v3/ticker/price

Source: https://www.mexc.com/api-docs/spot-v3/market-data-endpoints/symbol-price-ticker

Get the latest price for a symbol or all symbols. If the symbol parameter is not sent, all symbols will be returned in an array.

```APIDOC
## GET /api/v3/ticker/price

### Description
Get the latest price for a symbol or all symbols.

### Method
GET

### Endpoint
/api/v3/ticker/price

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - If the symbol is not sent, all symbols will be returned in an array.

### Response
#### Success Response (200)
- **symbol** (string) - The trading pair symbol.
- **price** (string) - Last price.

#### Response Example
```json
{
    "symbol": "BTCUSDT",
    "price": "184.34"
}
```

Or when no symbol is provided:
```json
[
  {
    "symbol": "BTCUSDT",
    "price": "6.65"
  },
  {
    "symbol": "ETHUSDT",
    "price": "5.65"
  }
]
```
```

--------------------------------

### POST /api/v3/userDataStream

Source: https://www.mexc.com/api-docs/spot-v3/websocket-user-data-streams/listen-key

Starts a new data stream. The stream will close 60 minutes after creation unless a keepalive is sent. Requires SPOT_ACCOUNT_READ permission.

```APIDOC
## POST /api/v3/userDataStream

### Description
Starts a new data stream. The stream will close 60 minutes after creation unless a keepalive is sent.

### Method
POST

### Endpoint
/api/v3/userDataStream

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **listenKey** (string) - The listen key for the new data stream.

#### Response Example
{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}
```

--------------------------------

### Troubleshooting Commands

Source: https://www.mexc.com/api-docs/cli/appendix/quick-reference

Commands to check the environment and display the CLI version for troubleshooting.

```bash
mexc doctor                                       # Environment check
mexc --version                                    # Version
```

--------------------------------

### GET /api/v3/depth

Source: https://www.mexc.com/api-docs/spot-v3/market-data-endpoints/order-book

Get order book depth for a symbol. By default, returns 100 bids and 100 asks.

```APIDOC
## GET /api/v3/depth

### Description
Get order book depth for a symbol. By default, returns 100 bids and 100 asks.

### Method
GET

### Endpoint
/api/v3/depth

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Symbol
- **limit** (integer) - Optional - Return number; default 100; max 5000

### Response
#### Success Response (200)
- **lastUpdateId** (long) - Last Update Id
- **bids** (list) - Bid [Price, Quantity]
- **asks** (list) - Ask [Price, Quantity]

#### Response Example
{
  "lastUpdateId": 1112416,
  "bids": [
      ["15.00000", "49999.00000"]
  ],
  "asks": [
    ["14.0000", "1.0000"]
  ]
}
```

--------------------------------

### POST /api/v3/sub-account/virtualSubAccount

Source: https://www.mexc.com/api-docs/spot-v3/subaccount-endpoints/create-a-sub-accountfor-master-account

Creates a new sub-account from the master account. Requires the SPOT_ACCOUNT_WRITE permission and has an IP weight of 1.

```APIDOC
## POST /api/v3/sub-account/virtualSubAccount

### Description
Create a sub-account from the master account.

### Method
POST

### Endpoint
/api/v3/sub-account/virtualSubAccount

### Parameters
#### Request Body
- **subAccount** (STRING) - Required - Sub-account Name
- **note** (STRING) - Required - Sub-account notes
- **recvWindow** (LONG) - Optional - 
- **timestamp** (LONG) - Required - 

### Request Example
{
  "subAccount": "mexc1",
  "note": "1"
}

### Response
#### Success Response (200)
- **subAccount** (STRING) - Sub-account Name
- **note** (STRING) - Sub-account notes

#### Response Example
{
  "subAccount": "mexc1",
  "note": "1"
}
```
Tokens:
Raw