Account

Account information and balances

Get order status

get

Returns the status of a single order for the authenticated account.

Rules

  • symbol is required.

  • Exactly one of orderId (server-assigned UUID) or origClientOrderId (your client ID) must be provided.

  • Requests must be signed (global security requires XApiKey header AND Ed25519Sig query signature).

Weight: 4

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired
Query parameters
symbolstring · min: 3 · max: 33Required

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
orderIdstring · uuidOptional

Server-assigned order ID (if combined with origClientOrderId, must refer to same order).

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
origClientOrderIdstringOptional

Client-assigned order ID (optional if orderId is set).

Example: myorder-001Pattern: ^[A-Za-z0-9._-]{1,36}$
Responses
chevron-right
200

Order status

application/json

Detailed status of a single order

symbolstring · min: 3 · max: 33Optional

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
orderIdstring · uuidOptional

Exchange-assigned order ID (UUID)

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
clientOrderIdstring · max: 36Optional

Client-assigned order ID, if provided on placement (max 36 chars)

Example: myorder-001
pricenumberOptional

Price for LIMIT/*_LIMIT orders; null for MARKET/STOP orders

Example: 0.01234567
origQtynumberOptional

Original order quantity (base asset)

Example: 100
executedQtynumberOptional

Executed quantity (base asset)

Example: 25
cumulativeQuoteQtynumberOptional

Cumulative quote quantity (quote asset)

Example: 0.30864175
statusstring · enumOptional

Order status

Example: PARTIALLY_FILLEDPossible values:
timeInForcestring · enumOptional

Time in force for LIMIT/*_LIMIT orders; null otherwise

Example: GTCPossible values:
typestring · enumOptional

Order type

Example: LIMITPossible values:
sidestring · enumOptional

Order side

Example: BUYPossible values:
stopPricenumberOptional

Stop price for STOP/TAKE_PROFIT orders; null otherwise

Example: 0.01
timeinteger · int64Optional

Creation time (ms since epoch)

Example: 1724952745000
updateTimeinteger · int64Optional

Last update time (ms since epoch)

Example: 1724952751000
isWorkingbooleanOptional

Whether the order is currently working on the book

Example: true
workingTimeinteger · int64Optional

Time at which the book started working on the order

Example: 1724952751000
get
/api/v1/order

Get open orders

get

Returns all open orders for the authenticated account.

Rules

  • symbol is optional. When provided, results are filtered to that trading pair; otherwise all symbols are returned.

  • When there are no open orders, the server returns 200 with an empty array [].

  • Requests must be signed (global security requires XApiKey header AND Ed25519Sig query signature).

Weight: 6

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired
Query parameters
symbolstring · min: 3 · max: 33Required

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
Responses
chevron-right
200

List of open orders

application/json

Detailed status of a single order

symbolstring · min: 3 · max: 33Optional

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
orderIdstring · uuidOptional

Exchange-assigned order ID (UUID)

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
clientOrderIdstring · max: 36Optional

Client-assigned order ID, if provided on placement (max 36 chars)

Example: myorder-001
pricenumberOptional

Price for LIMIT/*_LIMIT orders; null for MARKET/STOP orders

Example: 0.01234567
origQtynumberOptional

Original order quantity (base asset)

Example: 100
executedQtynumberOptional

Executed quantity (base asset)

Example: 25
cumulativeQuoteQtynumberOptional

Cumulative quote quantity (quote asset)

Example: 0.30864175
statusstring · enumOptional

Order status

Example: PARTIALLY_FILLEDPossible values:
timeInForcestring · enumOptional

Time in force for LIMIT/*_LIMIT orders; null otherwise

Example: GTCPossible values:
typestring · enumOptional

Order type

Example: LIMITPossible values:
sidestring · enumOptional

Order side

Example: BUYPossible values:
stopPricenumberOptional

Stop price for STOP/TAKE_PROFIT orders; null otherwise

Example: 0.01
timeinteger · int64Optional

Creation time (ms since epoch)

Example: 1724952745000
updateTimeinteger · int64Optional

Last update time (ms since epoch)

Example: 1724952751000
isWorkingbooleanOptional

Whether the order is currently working on the book

Example: true
workingTimeinteger · int64Optional

Time at which the book started working on the order

Example: 1724952751000
get
/api/v1/openOrders

Get account trades

get

Returns executed trades (fills) for the authenticated account.

Rules

  • symbol is required.

  • If fromId is supplied, results include trades with id >= fromId and are returned in ascending id order; otherwise the most recent trades are returned.

  • limit defaults to 500 and is clamped to a maximum of 1000.

  • When there are no trades, the server returns 200 with an empty array [].

  • Time window: startTime and endTime together must not exceed 24 hours.

  • Supported parameter combinations (with symbol always present):

    • symbol

    • symbol + orderId

    • symbol + startTime

    • symbol + endTime

    • symbol + fromId

    • symbol + startTime + endTime

    • symbol + orderId + fromId

  • Requests must be signed (global security requires XApiKey header AND Ed25519Sig query signature).

  • Data Source: Memory ⇒ Database.

Weight: 20

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired
Query parameters
symbolstring · min: 3 · max: 33Required

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
orderIdstring · uuidOptional

Exchange-assigned order ID (UUID). May be combined with fromId.

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
startTimestring · int64Optional

Start of the time filter (ms since epoch). Can be used alone or with endTime (together ≤ 24h).

Example: 1724952745000
endTimestring · int64Optional

End of the time filter (ms since epoch). Can be used alone or with startTime (together ≤ 24h).

Example: 1725039145000
fromIdstring · int64Optional

Inclusive trade id to start from (id >= fromId). May be used with symbol or with symbol + orderId.

Example: 28457
limitstring · min: 1 · max: 1000Optional

Max number of trades to return. Default 500; maximum 1000. Out-of-range values are clamped.

Example: 500
Responses
chevron-right
200

List of account trades

application/json

Details of an executed trade

symbolstring · min: 3 · max: 33Optional

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
idinteger · int64Optional

Unique paging id

Example: 12345
orderIdstring · uuidOptional

Exchange-assigned order ID (UUID)

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
pricenumberOptional

The price the trade executed at

Example: 0.01234567
qtynumberOptional

The amount of base asset filled

Example: 1.01
quoteQtynumberOptional

The amount of quote asset exchanged

Example: 99.99
commissionnumberOptional

The amount of commission paid by the creator of the referenced order

Example: 0.99
commissionAssetstring · min: 2 · max: 24Optional

Code for the commission asset

Example: BTCPattern: ^[A-Z0-9_]+$
timeinteger · int64Optional

Trade execution time (ms since epoch)

Example: 1724952751000
isBuyerbooleanOptional

Whether the creator of the referenced order took the BUY side

Example: true
isMakerbooleanOptional

Whether the creator of the referenced order was the maker

Example: false
get
/api/v1/myTrades

Get commission rates for the authenticated account

get

Returns a particular symbol's maker and taker commission rates for the caller identified by the provided credentials. Authentication uses the global requirement: XApiKey (header) AND Ed25519Sig (query).

Weight: 20

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired
Query parameters
symbolstring · min: 3 · max: 33Required

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
Responses
chevron-right
200

Commission rates for the authenticated caller

application/json

Maker and taker commission rates for the authenticated account

makernumberOptional

Maker commission rate expressed as a decimal fraction

Example: 0.0015
takernumberOptional

Taker commission rate expressed as a decimal fraction

Example: 0.0015
get
/api/v1/account/commission

Get commission rates and balances for the authenticated account

get

Returns the commission rates and balances for the caller identified by the provided credentials. Authentication uses the global requirement: XApiKey (header) AND Ed25519Sig (query).

Weight: 20

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired
Query parameters
omitZeroBalancesbooleanOptional

If true, omit any balances where both 'free' and 'locked' are zero

Default: falseExample: true
Responses
chevron-right
200

Account balances for the authenticated caller

application/json

Commission rates and balances for the authenticated account

get
/api/v1/account

Last updated