Vessel Finance API
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

Vessel REST API

The Vessel REST API is structured into two principal categories: Public APIs and User APIs, each offering distinct functionalities.

Public APIs#

Signature (Not required): Public APIs facilitate direct access to crucial market data and exchange specifics. Without requiring user authentication, these APIs enable the retrieval of live market prices, trading pair information, and other salient details, ensuring easy access to essential data.

User APIs#

User APIs Signature (Required): Access to User APIs is secured through mandatory signature-based authentication. These APIs provide comprehensive tools for asset management, order placement, and reviewing order history. This secure framework allows users to interact with their accounts and manage their assets with enhanced efficiency.
Note:
Dual Authentication for Order Placement: Placing an order requires dual authentication, utilizing both Poseidon Signature and HMAC Signature. Other operations require only the HMAC Signature.
Guides for Authentication: For detailed instructions, refer to HMAC Signature Guide and Poseidon Signature Guide.

Rate Limiting#

Usage Limits: To promote efficient usage and equitable access, the API is subject to a rate limit of 3,000 requests every 5 minutes. This limit is applied to both the IP address initiating the requests and the individual user accounts, ensuring a secure and balanced usage environment for all API interactions.
Modified at 2024-01-03 10:15:26
Previous
Error Code
Next
Public
Built with