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

Ticker Setting Upade

Developing
{{WSS_SERVER}}/ws
Last modified:2024-10-12 09:23:55
Symbol Update provides real-time updates for symbol information in a financial trading context. It allows clients to subscribe to a symbol update channel and receive instantaneous notifications about changes in trading pairs, including details such as fees, trading limits, and currency information.

Information#

Update Speed: Real-time

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., order book updates).
1.
Type: String.
2.
Value: "trade"
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#

Unsubscribe Example#

Initial Message#

1.
id: A unique identifier for the message, used to match responses to specific requests.
1.
Type: String
2.
Value: "random string"
2.
type: Specifies the type of WebSocket message.
1.
Type: String
2.
Value: "init"
3.
channel: Indicates the type of data being updated (e.g., trade updates).
1.
Type: String
2.
Value: "symbol_update"
4.
timestamp: The timestamp when the response was generated
1.
Type: String (UNIX timestamp in milliseconds)
2.
Examples: 1704696764925
5.
error: Indicates whether the connection encountered any errors.

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., trade updates).
1.
Type: String
2.
Value: "symbol_update"
3.
timestamp: The timestamp when the response was generated
1.
Type: String (UNIX timestamp in milliseconds)
2.
Examples: "1704696764925"
4.
symbolId: ID of the trading pair.
1.
Type: String
2.
Value: "1"
5.
symbolName: Name of the trading pair.
1.
Type: String
2.
Value: "WBTCUSDT"
6.
symbolType: Type of the trading pair.
1.
Type: String
2.
Value: "CURRENCY_EXCHANGE_PAIR"
7.
makerFeeDiscount: The fee discount for makers in a specific trading pair. For instance, a value of 80 indicates a 20% off. And you can trade it for 80% of the original maker fee. To calculate the final maker fee rate when trading in this pair, multiply your account level's maker fee rate by the makerFeeDiscount.
1.
Type: String
2.
Value: "80"
8.
takerFeeDiscount: TThe fee discount for takers in a specific trading pair. For instance, a value of 80 indicates a 20% off. And you can trade it for 80% of the original taker fee. To calculate the final taker fee rate when trading in this pair, multiply your account level's taker fee rate by the taker discount ratio.
1.
Type: String
2.
Value: "80"
9.
maxTradeSize: The maximum base token size for a single trade.
1.
Type: String
2.
Value: "100000"
10.
minTradeSize: The minimum base token size for a single trade.
1.
Type: String
2.
Value: "0.0001"
11.
spotAllowTrading: Indicates whether spot trading is allowed for the symbol.
1.
Type: boolean
2.
Value: true

Response Example#

{
  "{
  "channel": "symbol_update",
  "makerFeeDiscount": 10,
  "maxTradeSize": "10000000",
  "minTradeSize": "1",
  "spotAllowTrading": true,
  "symbolId": "5",
  "symbolName": "WETH01WBTC",
  "symbolType": "CURRENCY_EXCHANGE_PAIR",
  "takerFeeDiscount": "10",
  "timestamp": "1727256561863",
  "type": "update"
}

Request

Header Params

Modified at 2024-10-12 09:23:55
Previous
24hr Ticker Statistics
Next
User
Built with