EX5 API · REST & WEBSOCKET

Account

Read balances, your trading fee rate and your profile. Account levels decide which API features you can use.

Account levels

Level	Requirement	Unlocks
`1`	E-mail verified	Deposits, deposit addresses, order and trade history, balances
`2`	Phone number verified	Placing and cancelling orders
`3`	Identity documents verified	Withdrawals, withdrawal history, withdrawal addresses and the transaction list

Internal transfers and balances have no level requirement. A call below the required level answers 403 (peatio) or 401 order.action_level.not_permitted (order entry).

Account level requirements

GET/api/v2/peatio/public/member-levelsPublic

Returns the minimum account level for deposits, withdrawals and trading as configured in the exchange core. Levels: 1 = e-mail verified, 2 = phone verified, 3 = identity documents verified.

Placing orders requires account level 2 (verified phone number). The trading level reported here applies to order and trade history.

Responses

Status	Description
`200`	Level requirements.

Response fields

Field	Type	Description
`deposit.minimum_level`	integer	Level for deposits.
`withdraw.minimum_level`	integer	Level for withdrawals, beneficiaries and transaction history.
`trading.minimum_level`	integer	Level for /api/v2/peatio/market/* (order placement through finex needs level 2).

Example response

JSON

{
  "deposit": {
    "minimum_level": 1
  },
  "withdraw": {
    "minimum_level": 3
  },
  "trading": {
    "minimum_level": 1
  }
}

Example request

curl -s "https://exchange.ex5.com/api/v2/peatio/public/member-levels"

import requests

r = requests.get("https://exchange.ex5.com/api/v2/peatio/public/member-levels", timeout=10)
r.raise_for_status()
print(r.json())

const res = await fetch("https://exchange.ex5.com/api/v2/peatio/public/member-levels");
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

List balances

GET/api/v2/peatio/account/balancesAPI key

Returns your account for every visible currency: balance is available funds, locked is reserved by open orders and pending withdrawals. Zero balances are included unless nonzero=true. Coin currencies include your deposit address, or null if none has been generated yet. Paginated.

Parameters

Name	In	Type	Description
`nonzero`	query	boolean	If true, omit currencies whose balance and locked are both zero.
`limit`	query	integer	Page size, 1-1000 (default 100).
`page`	query	integer	Page number, starting at 1 (default 1).

Responses

Status	Description
`200`	Array of accounts.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).

Response fields

Field	Type	Description
`currency`	string	Currency code.
`balance`	string (decimal)	Available balance.
`locked`	string (decimal)	Reserved by open orders and pending withdrawals.
`deposit_address`	PaymentAddress \| null	Coins only; null if no address has been generated yet.

Example response

JSON

[
  {
    "currency": "btc",
    "balance": "0.25",
    "locked": "0.01",
    "deposit_address": {
      "currencies": [
        "btc"
      ],
      "address": "bc1qexampleexampleexampleexampleexample0",
      "state": "active"
    }
  },
  {
    "currency": "usdt",
    "balance": "1500.0",
    "locked": "0.0",
    "deposit_address": null
  }
]

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/peatio/account/balances" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/peatio/account/balances"))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/peatio/account/balances"));

Get one balance

GET/api/v2/peatio/account/balances/{currency}API key

Returns your account for one currency.

Parameters

Name	In	Type	Description
`currency`required	path	string	Currency code, e.g. `btc`, `usdt` or a network currency such as `usdt.trc20` (see GET /api/v2/peatio/public/currencies).

Responses

Status	Description
`200`	Account.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`404`	Record not found: `{"errors":["record.not_found"]}`.
`422`	Validation error, e.g. `{"errors":["public.market.doesnt_exist"]}`.

Response fields

Field	Type	Description
`currency`	string	Currency code.
`balance`	string (decimal)	Available balance.
`locked`	string (decimal)	Reserved by open orders and pending withdrawals.
`deposit_address`	PaymentAddress \| null	Coins only; null if no address has been generated yet.

Example response

JSON

{
  "currency": "btc",
  "balance": "0.25",
  "locked": "0.01",
  "deposit_address": {
    "currencies": [
      "btc"
    ],
    "address": "bc1qexampleexampleexampleexampleexample0",
    "state": "active"
  }
}

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/peatio/account/balances/usdt" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/peatio/account/balances/usdt"))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/peatio/account/balances/usdt"));

Your trading fee

GET/api/v2/peatio/account/trading_fees/meAPI key

Returns the maker/taker fee rates that apply to your account, as fractions (e.g. "0.002" = 0.2%). Omit market for the account-wide rate.

Parameters

Name	In	Type	Description
`market`	query	string	Market id, e.g. `btcusdt`; omitted returns the account-wide (`any`) rate.

Responses

Status	Description
`200`	Fee rates.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`422`	Unknown market: `{"errors":["account.trading_fee.market_doesnt_exist"]}`.

Response fields

Field	Type	Description
`group`	string	Your fee group, e.g. "vip-0".
`market_id`	string	Requested market, or "any".
`market_type`	string	"spot".
`maker`	string (decimal)	Maker fee as a fraction.
`taker`	string (decimal)	Taker fee as a fraction.

Example response

JSON

{
  "group": "vip-0",
  "market_id": "btcusdt",
  "market_type": "spot",
  "maker": "0.002",
  "taker": "0.002"
}

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/peatio/account/trading_fees/me" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/peatio/account/trading_fees/me"))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/peatio/account/trading_fees/me"));

Your account

GET/api/v2/barong/resource/users/meAPI key

Returns your account: UID, role, level (1 = e-mail, 2 = phone, 3 = identity documents verified), whether 2FA is enabled (otp), state, labels, phones (masked) and profile data.

Responses

Status	Description
`200`	User.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).

Response fields

Field	Type	Description
`email`	string	E-mail.
`uid`	string	User id, e.g. ID1234567890.
`role`	string	Role, e.g. "member".
`level`	integer	1 = e-mail, 2 = phone, 3 = identity documents verified.
`otp`	boolean	Two-factor authentication enabled (required for API keys).
`state`	string	"active", "pending", ...
`referral_uid`	string \| null	Referrer UID.
`data`	string	Free-form JSON string.
`username`	string \| null	Username.
`labels`	array<Label>	Verification labels.
`phones`	array<Phone>	Phones (masked).
`profiles`	array<Profile>	Profile data (masked).
`data_storages`	array<object>	Extra stored data.
`created_at`	string (ISO 8601 datetime, UTC)	Created.
`updated_at`	string (ISO 8601 datetime, UTC)	Updated.

Example response

JSON

{
  "email": "trader@example.com",
  "uid": "ID1234567890",
  "role": "member",
  "level": 3,
  "otp": true,
  "state": "active",
  "referral_uid": null,
  "data": "{\"language\":\"en\"}",
  "username": null,
  "labels": [
    {
      "key": "email",
      "value": "verified",
      "scope": "private",
      "created_at": "2026-01-15T10:00:00Z",
      "updated_at": "2026-01-15T10:00:00Z"
    },
    {
      "key": "phone",
      "value": "verified",
      "scope": "private",
      "created_at": "2026-01-15T10:05:00Z",
      "updated_at": "2026-01-15T10:05:00Z"
    }
  ],
  "phones": [
    {
      "country": "DE",
      "number": "4915*****89",
      "validated_at": "2026-01-15T10:05:00Z"
    }
  ],
  "profiles": [],
  "data_storages": [],
  "created_at": "2026-01-15T10:00:00Z",
  "updated_at": "2026-09-27T12:00:00Z"
}

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/barong/resource/users/me" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/barong/resource/users/me"))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/barong/resource/users/me"));