Vessel Finance API
  1. Market Data
Vessel Finance API
  • Introduction
  • General Info
  • HMAC Signature Guide
  • Poseidon Signature Guide
  • Internal Transfer Signature Guide
  • Error Code
  • Vessel REST API
    • Public
      • Market Data
        • 24hr Ticker Statistics
          GET
        • Kline / Candlestick Data
          GET
        • Order Book
          GET
        • Recent Trades List
          GET
        • Average Price
          GET
        • AMM Pool Last 24h Data
          GET
      • Exchange Data
        • Ticker Info
        • Asset Info
        • Trade Fee
        • AMM Pool Info
    • User
      • Asset
        • User Asset
        • Withdraw
        • Withdraw History
        • Deposit History
        • Claim History
        • Internal Transfer (Send)
        • Internal Transfer History
      • Order
        • Place Order
        • Cancel Order
        • Open Orders
        • Completed Orders
        • All Orders
        • Query Order
        • Modify Order
      • AMM
        • Add Liquidity
        • Remove Liquidity
        • Collect Fee
        • AMM Position
        • AMM Action History
      • Account
        • User Profile
        • User Trade List
  • Vessel WebSocket
    • Market
      • Order Book
      • K Line
      • Recent Trades
      • 24hr Ticker Statistics
      • Ticker Setting Upade
    • User
      • Authorize
      • Balance
      • Account
  1. Market Data

Order Book

Testnet Env
https://testnet.trade.vessel.finance
Testnet Env
https://testnet.trade.vessel.finance
GET
/api/v1/public/depth
Last modified:2024-10-15 06:23:56
Order Book offers a real-time snapshot of the current market depth, providing information about the existing buy (bids) and sell (asks) orders on our platform.

Request

Query Params
symbol
string 
required
Specifies the trading pair symbol for which the order book is requested. (e.g., WBTCUSDT).
Example:
WBTCUSDT
limit
string 
optional
Limits the number of order book entries returned for both asks (sell orders) and bids (buy orders). Default 100; max 5000.If limit > 5000, then the response will truncate to 5000.
Example:
10

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/public/depth?symbol=WBTCUSDT&limit=10'

Responses

🟢200OK
application/json
Body
timestamp
string 
required
A timestamp representing the moment when the order book snapshot was taken (Unix timestamps in milliseconds & UTC).
asks
array [object {3}] 
required
An array containing information about sell orders (asks).
price
string 
required
The price at which the asset is offered for sale.
volume
string 
required
The amount of the asset available at the specified price.
orderCount
string 
required
The number of individual orders at this price level.
bids
array [object {3}] 
required
An array containing information about buy orders (bids).
price
string 
required
The price at which buyers are willing to purchase the asset.
volume
string 
required
The amount of the asset buyers are willing to purchase at the specified price.
orderCount
string 
required
The number of individual orders at this price level.
Example
{
  "timestamp": "1728705083742",
  "asks": [
    {
      "price": "61170",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61180",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61190",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61200",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61210",
      "volume": "0.0006",
      "orderCount": "1"
    }
  ],
  "bids": [
    {
      "price": "61166",
      "volume": "0.0001",
      "orderCount": "1"
    },
    {
      "price": "61150",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61140",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61130",
      "volume": "0.0006",
      "orderCount": "1"
    },
    {
      "price": "61120",
      "volume": "0.0006",
      "orderCount": "1"
    }
  ]
}
Previous
Kline / Candlestick Data
Next
Recent Trades List
Built with