Vessel Finance API
  1. Vessel REST 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
  1. Vessel REST API

User

APIs under User folder allow you to interact programmatically with your user account on Vessel. User API is focused on providing functionality related to querying assets, order and trade history, placing orders, and withdrawing assets.
Before using these APIs, make sure you have a valid account on our platform. If you don't have an account yet, please visit trade.veseel.finance to create one.

Signature#

Signature Required: User APIs require authentication through a signature. And Place Order requires dual authentication with both Poseidon Signature and HMAC Signature, while other operations exclusively necessitate HMAC Signature.
For a comprehensive understanding, refer to our Sign Request by HMAC Guide and Poseidon Signature Guide.

Important Note#

Actions such as minting test tokens, depositing, and claiming should be performed on our website or by directly interacting with our smart contract. These actions may not be available through the User API.

Mint Test Token#

Visit our Faucet to mint test tokens every 24 hours.

Deposit#

Deposit the test tokens you minted into your account. Once the deposit is successful, you can use these test tokens within your account to interact with our REST API and place orders.

Claim#

After completing a Withdrawal, you can claim the withdrawn tokens to your wallet address.
Previous
AMM Pool Info
Next
User Asset
Built with