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
  • Endpoint
  • Request Headers
  • Request Body

Was this helpful?

  1. TECH
  2. API Documentation
  3. Trading

Cancel order

Cancel an order. (Private ๐Ÿ”’)

PreviousList ordersNextList trades

Last updated 2 years ago

Was this helpful?

This endpoint is used to cancel a limit order which hasnโ€™t already been executed at a given time. Please note that this is a Private ๐Ÿ”’ route which means it needs to be authorised 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

POST /sapi/v1/orders/cancel/

Request Headers

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

Request Body

Field
Type
Mandatory

order_id

INTEGER

YES

Example

{
  "order_id": 3
}

Response

{
  "status": "success",
  "message": "Cancelled Order Successfully",
  "payload": {
    "order_id": 3,
    "uuid": "3626e3a1-c15f-4979-97f2-30ce8845578d",
    "side": "buy",
    "ord_type": "limit",
    "price": "1663.0",
    "avg_price": "1663.0",
    "state": "wait",
    "market": "ethusdc",
    "created_at": "2022-08-05T12:20:22+02:00",
    "updated_at": "2022-08-05T12:21:28+02:00",
    "origin_volume": "0.003",
    "remaining_volume": "0.0021",
    "executed_volume": "0.0009",
    "maker_fee": "0.001",
    "taker_fee": "0.001",
    "trades_count": 3
  }
}
๐Ÿ”Œ
โ†”๏ธ
login