Vessel Finance API
  1. Market
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
        • Kline / Candlestick Data
        • Order Book
        • Recent Trades List
        • Average Price
        • AMM Pool Last 24h Data
      • 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

24hr Ticker Statistics

{{WSS_SERVER}}/ws
Last modified:2024-10-12 09:22:44
Ticker Statistics is used to subscribe to real-time updates on symbol statistics for a specific trading pair on our platform.

Update Speed#

5000ms

Message Structure#

Send Message#

1.
type: Specifies the type of WebSocket message.
1.
Type: String.
2.
Value: "subscribe"
2.
channel: Indicates the type of data to subscribe to (e.g., symbol stats updates).
1.
Type: String.
2.
Value: "symbol_stats"
3.
id: A unique identifier for the subscription request. Write randomly or use any unique identifier.
1.
Type: String.
2.
Example. "random string 001"

Subscribe Example#

{
    "type": "subscribe",
    "channel": "symbol_stats",
    "id": "random string"
}

Unsubscribe Example#

{
    "type": "unsubscribe",
    "channel": "symbol_stats",
    "id": "random string"
}

Initial Message#

1.
error: Indicates whether the WebSocket message is reporting an error.
1.
Type: Boolean
2.
Value: true if there is an error, false otherwise.
2.
id: Represents a unique identifier associated with the WebSocket message, typically used for tracking or matching responses.
1.
Type: String
2.
Example: "random string"
3.
type: Specifies the type of WebSocket message.
1.
Type: String
2.
Value: "init"
4.
channel: Indicates the type of data being updated (e.g., symbol_stats updates).
1.
Type: String
2.
Value: "symbol_stats"
5.
timestamp: Specifies the timestamp of the 24h ticker statistics is subscribed.
1.
Type: String (UNIX timestamp in milliseconds & UTC)
2.
Example: 1704433004692
6.
data: An object containing information about various trading pairs. Each trading pair is represented by its symbol (e.g., "ETHUSDT", "WBTCUSDT").
1.
openTime: The opening time of the candlestick.
1.
Type: String (UNIX timestamp in milliseconds & UTC)
2.
openPrice: The opening price of the last 24 hours.
1.
Type: String
3.
highPrice: The highest price reached during the last 24 hours.
1.
Type: String
4.
lowPrice: The lowest price reached during the last 24 hours.
1.
Type: String
5.
closePrice: The closing price of the last 24 hours.
1.
Type: String
6.
volume: The total traded volume during the last 24 hours.
1.
Type: String
7.
trades: The number of trades executed during the last 24 hours.
1.
Type: String
8.
closeTime: The closing time of the last 24 hours.
1.
Type: String (UNIX timestamp in milliseconds & UTC)
9.
quoteVolume: The total quoted volume during the candlestick's duration.
1.
Type: String
10.
takerBuyBaseVolume: The volume of the asset bought by takers during the last 24 hours.
1.
Type: String
11.
takerBuyQuoteVolume: The volume of the quoted asset bought by takers during the last 24 hours.
1.
Type: String

Response Example#

Update Message#

1.
Type: Specifies the type of WebSocket message.
1.
Type: String
2.
Value: "update"
2.
Channel: Indicates the type of data being updated (e.g., symbol_stats updates).
1.
Type: String
2.
Value: "symbol_stats"
3.
Data: An object containing information about various trading pairs. Each trading pair is represented by its symbol (e.g., "ETHUSDT", "WBTCUSDT").
1.
Open Time: The opening time of the last 24 hours.
1.
Type: String (UNIX timestamp in milliseconds & UTC)
2.
Open Price: The opening price of the last 24 hours.
1.
Type: String
3.
High Price: The highest price reached during the last 24 hours.
1.
Type: String
4.
Low Price: The lowest price reached during the last 24 hours.
1.
Type: String
5.
Close Price: The closing price of the last 24 hours.
1.
Type: String
6.
Volume: The total traded volume during the last 24 hours.
1.
Type: String
7.
Trades: The number of trades executed during the last 24 hours.
1.
Type: Integer
8.
Close Time: The closing time of the last 24 hours.
1.
Type: String (UNIX timestamp in milliseconds)
9.
Quote Volume: The total quoted volume during the last 24 hours.
1.
Type: String
10.
Taker Buy Base Volume: The volume of the asset bought by takers during the last 24 hours.
1.
Type: String
11.
Taker Buy Quote Volume: The quoted volume of the asset bought by takers during the last 24 hours.
1.
Type: String

Update Example#

{
  "type": "update",
  "channel": "symbol_stats",
  "data": {
    "ETHUSDT": {
      "openTime": "1700784000000",
      "openPrice": "1780.00000000",
      "highPrice": "1789.11000000",
      "lowPrice": "1777.23000000",
      "closePrice": "1779.00000000",
      "volume": "10.00000000",
      "trades": "7",
      "closeTime": "1700870399999",
      "quoteVolume": "17810.63000000",
      "takerBuyBaseVolume": "6.10000000",
      "takerBuyQuoteVolume": "10850.00000000"
    }
  ]
}

Request

Header Params
VESSEL-API-KEY
string 
required
Default:
{{API_KEY}}
VESSEL-PASSPHRASE
string 
required
Default:
{{API_PASSPHRASE}}
VESSEL-SIGNATURE
string 
required
Use signRequest script to generate
VESSEL-TIMESTAMP
string 
required
Use signRequest script to set
Modified at 2024-10-12 09:22:44
Previous
Recent Trades
Next
Ticker Setting Upade
Built with