tanX Docupaper
AboutTrade
  • ABOUT
    • 📒tanX Docupaper
  • TECH
    • 👩‍💻Tech Docupaper
      • 🏨High level architecture
      • 🤔Starkware logic
      • 🌊Transactional flow
        • Off-chain accounts
        • The deposit flow
        • The withdrawal flow
        • The trade flow
        • The transfer flow
        • Full withdrawal
    • 🔌API Documentation
      • 😋Getting started
        • Test connectivity
      • 📈Market
        • 24hr Tickers Price
        • K-line/Candlestick data
        • Orderbook
        • Recent trades
      • ↔️Trading
        • Create order
        • Get order
        • List orders
        • Cancel order
        • Bulk Cancel
        • List trades
      • 🔐Account
        • Generating L2 Key Pairs
        • Login
        • Deposit
        • Withdrawal
        • Profile Information
        • Balance details
        • Profit and loss details
      • 🌏Web-socket stream
        • 🗝️Private web-socket connection
        • 👥Public websocket connection
      • ✨Internal Transfer
        • Create Internal Transfer
        • Get Internal Transfer
        • Check User Existence
        • List Internal Transfers
      • 🧪SDK Reference
        • NodeJS SDK
        • Python SDK
  • LEGAL
    • ‼️tanX Disclaimer
Powered by GitBook
On this page

Was this helpful?

  1. TECH
  2. API Documentation
  3. Trading

List orders

Get all user orders. (Private 🔒)

PreviousGet orderNextCancel order

Last updated 1 year ago

Was this helpful?

Retrieve details of all orders for a user using this endpoint. Please note that this is a Private 🔒 route which means it needs to be authorized by the account initiating this request.

Note: You will need to include the JWT Auth token to request headers to access this endpoint. To get the JWT Auth Token, refer the section of the documentation.

Endpoint

GET /sapi/v1/orders/

Request Headers

{
  "Authorization": "JWT ***"
}

Query Params

Field
Type
Mandatory
Description

limit

INTEGER

NO

default 50

page

INTEGER

NO

market

STRING

NO

ord_type

STRING

NO

allowed values [limit, market, stop_limit, limit_maker]

state

STRING

NO

allowed values [pending, wait, done, cancel]

base_unit

STRING

NO

btcusdt, btc is base_unit and usdt is quote_unit

quote_unit

STRING

NO

start_time

INTEGER

NO

end_time

INTEGER

NO

side

STRING

NO

allowed values [buy, sell]

Example

{baseurl}/sapi/v1/orders/?page=1&limit=10&market=ethusdc

Response

{
    "status": "success",
    "message": "Orders Retrieved Successfully",
    "payload": [
        {
            "id": 25768879,
            "uuid": "17be02d1-34ef-49df-9b92-264705047d99",
            "side": "buy",
            "ord_type": "limit",
            "price": "68733.81",
            "stop_price": null,
            "avg_price": "68733.81",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-31T09:02:00+02:00",
            "updated_at": "2024-05-31T09:02:06+02:00",
            "origin_volume": "0.0425",
            "remaining_volume": "0.0335",
            "executed_volume": "0.009",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 2,
            "cancel_reason": "Order cancelled by user"
        },
        {
            "id": 25765217,
            "uuid": "0203fe8c-e96a-4e8b-801b-8a754d6e825e",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "68818.37",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-31T08:17:44+02:00",
            "updated_at": "2024-05-31T08:17:44+02:00",
            "origin_volume": "0.0874",
            "remaining_volume": "0.0874",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled because it was matched as a taker order"
        },
        {
            "id": 25765153,
            "uuid": "e9056cd6-21dc-4eec-8856-e700f0343010",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "68818.37",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-31T08:16:52+02:00",
            "updated_at": "2024-05-31T08:16:52+02:00",
            "origin_volume": "0.0874",
            "remaining_volume": "0.0874",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled because it was matched as a taker order"
        },
        {
            "id": 25765099,
            "uuid": "9912ed5f-ebf8-41ce-9158-df5f93855a3a",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "50000.0",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-31T08:16:13+02:00",
            "updated_at": "2024-05-31T08:18:15+02:00",
            "origin_volume": "0.1066",
            "remaining_volume": "0.1066",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled by user"
        },
        {
            "id": 25765070,
            "uuid": "94b83516-a7be-40c5-b037-0180818d1a50",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "78937.61",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-31T08:15:53+02:00",
            "updated_at": "2024-05-31T08:15:53+02:00",
            "origin_volume": "0.1066",
            "remaining_volume": "0.1066",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled because it was matched as a taker order"
        },
        {
            "id": 25764923,
            "uuid": "29bda41c-7e74-4758-ae4e-ca7b728a4d40",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "50000.0",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-31T08:14:45+02:00",
            "updated_at": "2024-05-31T08:18:17+02:00",
            "origin_volume": "0.196",
            "remaining_volume": "0.196",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled by user"
        },
        {
            "id": 25643640,
            "uuid": "46bea140-4afe-4cd9-8572-4d8a42915b2b",
            "side": "buy",
            "ord_type": "limit",
            "price": "68505.62",
            "stop_price": null,
            "avg_price": "68505.62",
            "state": "cancel",
            "market": "btcusdc",
            "created_at": "2024-05-30T13:30:29+02:00",
            "updated_at": "2024-05-30T13:30:37+02:00",
            "origin_volume": "0.3442",
            "remaining_volume": "0.3396",
            "executed_volume": "0.0046",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 1,
            "cancel_reason": "Order cancelled by user"
        },
        {
            "id": 25606241,
            "uuid": "bc02d282-9527-4d85-969a-60c09d85f15b",
            "side": "buy",
            "ord_type": "limit",
            "price": "1.0",
            "stop_price": null,
            "avg_price": "0.7566",
            "state": "done",
            "market": "maticusdc",
            "created_at": "2024-05-30T08:35:31+02:00",
            "updated_at": "2024-05-30T08:35:33+02:00",
            "origin_volume": "1000.0",
            "remaining_volume": "0.0",
            "executed_volume": "1000.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 13,
            "cancel_reason": null
        },
        {
            "id": 25605848,
            "uuid": "1d06755e-bb9c-47e8-a5e2-3b9449eb0bb4",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "1.0",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "maticusdc",
            "created_at": "2024-05-30T08:33:47+02:00",
            "updated_at": "2024-05-30T08:33:49+02:00",
            "origin_volume": "1000.0",
            "remaining_volume": "1000.0",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled because it was matched as a taker order"
        },
        {
            "id": 25605647,
            "uuid": "79817d22-2938-4d2d-898d-670d07848f17",
            "side": "buy",
            "ord_type": "limit_maker",
            "price": "1.0",
            "stop_price": null,
            "avg_price": "0.0",
            "state": "cancel",
            "market": "maticusdc",
            "created_at": "2024-05-30T08:32:35+02:00",
            "updated_at": "2024-05-30T08:32:36+02:00",
            "origin_volume": "14076.1",
            "remaining_volume": "14076.1",
            "executed_volume": "0.0",
            "maker_fee": "0.0004",
            "taker_fee": "0.0004",
            "trades_count": 0,
            "cancel_reason": "Order cancelled because it was matched as a taker order"
        }
    ]
}

Possible Cancel Reasons:

You may receive the following cancel reasons in the response:

  • 'Order cancelled by user': The user requested to cancel the order directly, or through a bulk cancel request.

  • ‘Slippage greater than 30%. Order cancelled to prevent loss of funds’: The order was cancelled because its price changed by more than 30% from the time it was placed to the time it was matched.

  • ‘Order cancellation was initiated by system’: The order was cancelled for reasons such as order expiration, slippage exceeding a specified threshold, inconsistent order matching, or detection of suspicious activity. However, cancellations due to these reasons are infrequent.

  • ‘Something went wrong, order was cancelled to prevent loss of funds’: The order was cancelled because it didn't meet the matching criteria due to unexpected reasons.

🔌
↔️
login