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
  • Query Params

Was this helpful?

  1. TECH
  2. API Documentation
  3. Market

Orderbook

Get order book details.

Retrieve the latest asks and bids created within the Brine orderbook in a specific market using this endpoint.

Endpoint

GET /sapi/v1/market/orderbook/

Query Params

Field
Type
Mandatory
Description

market

STRING

YES

asks_limit

INT

NO

default 20

bids_limit

INT

NO

default 20

Example

{baseurl}/sapi/v1/market/orderbook/?market=btcusdc&asks_limit=1&bids_limit=1

Response

{
  "status": "success",
  "message": "Retrieval Successful",
  "payload": {
    "asks": [
      {
        "id": 7495410,
        "uuid": "5c30a97a-39b1-4289-b119-5d0ffd96aaa5",
        "side": "sell",
        "ord_type": "market",
        "price": null,
        "avg_price": "0.0",
        "state": "wait",
        "market": "btcusdc",
        "created_at": "2022-07-20T04:14:08+02:00",
        "updated_at": "2022-07-20T04:14:08+02:00",
        "origin_volume": "0.0006",
        "remaining_volume": "0.0006",
        "executed_volume": "0.0",
        "maker_fee": "0.001",
        "taker_fee": "0.001",
        "trades_count": 0
      }
    ],
    "bids": [
      {
        "id": 7470160,
        "uuid": "795cfe5d-06ab-4150-8f44-06dc2b0e88f8",
        "side": "buy",
        "ord_type": "limit",
        "price": "23490.0",
        "avg_price": "23489.7",
        "state": "wait",
        "market": "btcusdc",
        "created_at": "2022-07-20T00:59:57+02:00",
        "updated_at": "2022-07-20T01:47:44+02:00",
        "origin_volume": "2.1772",
        "remaining_volume": "0.0083",
        "executed_volume": "2.1689",
        "maker_fee": "0.001",
        "taker_fee": "0.001",
        "trades_count": 22
      }
    ]
  }
}
PreviousK-line/Candlestick dataNextRecent trades

Last updated 2 years ago

Was this helpful?

๐Ÿ”Œ
๐Ÿ“ˆ