Brine's Docupaper
AboutTrade
  • ABOUT
    • ๐Ÿ“’Brine Docupaper
    • ๐Ÿช™Tokenomics
  • ๐Ÿ—ž๏ธBrine Bytes
    • ๐ŸงตOctober Edition
  • 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
        • List trades
      • ๐Ÿ”Account
        • Login
        • 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
  • FOR USERS
    • ๐Ÿ“’User Docuguide
      • ๐Ÿ’ปWeb App
        • Sign up through Metamask
        • Sign up through Wallet Connect
        • Place a Market Order Trade
        • Place a Limit Order Trade
        • Refer Brine to a Friend
        • Deposit with Metamask
        • Withdraw to Metamask
  • LEGAL
    • โ€ผ๏ธDisclaimer
Powered by GitBook
On this page

Was this helpful?

  1. TECH
  2. API Documentation
  3. Trading

List orders

Get all user orders. (Private ๐Ÿ”’)

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 login 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]

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": 1739939,
      "uuid": "b658b41f-fe68-4561-801d-dfa94c3ca1b5",
      "side": "buy",
      "ord_type": "limit",
      "price": "450.0",
      "avg_price": "0.0",
      "state": "cancel",
      "market": "ethusdc",
      "created_at": "2022-06-16T22:41:14+02:00",
      "updated_at": "2022-06-16T22:43:30+02:00",
      "origin_volume": "0.001",
      "remaining_volume": "0.001",
      "executed_volume": "0.0",
      "maker_fee": "0.001",
      "taker_fee": "0.001",
      "trades_count": 0
    },
    {
      "id": 1739940,
      "uuid": "19bce015-c143-449f-af2b-fdcfa6384015",
      "side": "buy",
      "ord_type": "limit",
      "price": "1134.0",
      "avg_price": "1134.0",
      "state": "done",
      "market": "ethusdc",
      "created_at": "2022-06-16T22:41:24+02:00",
      "updated_at": "2022-06-16T22:41:49+02:00",
      "origin_volume": "0.001",
      "remaining_volume": "0.0",
      "executed_volume": "0.001",
      "maker_fee": "0.001",
      "taker_fee": "0.001",
      "trades_count": 1
    }
  ]
}
PreviousGet orderNextCancel order

Last updated 1 year ago

Was this helpful?

๐Ÿ”Œ
โ†”๏ธ