Vessel Finance API
  • Introduction
  • General Info
  • HMAC Signature Guide
  • Poseidon Signature Guide
  • Internal Transfer Signature Guide
  • Error Code
  • Vessel REST API
  • Vessel WebSocket
logoPowered by Apifox

Introduction

Welcome to the documentation of Vessel API, your gateway to a secure, speedy and self-custody trading experience. Designed for developers, traders, and crypto degens, our comprehensive API suite enables seamless integration with Vessel's robust features.

Getting Started

Generate Vessel Key and API KEY

To unlock the full potential of the Vessel API, users are required to generate a Vessel Key and an API KEY through our Official Website.

Follow these steps:

  • Visit Vessel website:
    For mainnet: https://trade.vessel.finance/user/key
    For testnet: https://testnet.trade.vessel.finance/user/key
  • Connect your wallet to the website. During our alpha phase, an invitation code is required. You can obtain an invitation code by contacting us directly or through existing early users.
  • Complete the onboarding process.
  • Export your Vessel key and API key

Note: Never share your API key or secret key with anyone to ensure safety.

REST API

REST API service is segmented into two primary endpoint categories:

Public Endpoints

  • Open access; no authentication necessary.
  • Retrieve market data and general exchange statistics.

    User Endpoints

  • Secure access; user authentication is obligatory.

    • HMAC Signature is mandatory for all User-Type API endpoints, covering operations such as managing assets, reviewing historical data, and placing orders. Developers should refer to our Sign Request by HMAC Guide a detailed explanation and code samples on generating HMAC signatures for secure communication with the user endpoints.

    • Poseidon Signature specifically required for the "Place Order" endpoint to ensure secure order placement. Developers should refer to our Poseidon Signature Guide.

WebSocket Connectivity

Leverage the power of real-time data streaming with WebSocket connections. Establish connections to our production (trade.vessel.finance/ws) environments. Be mindful that WebSocket connections maintain a 24-hour validity window—plan reconnections accordingly to maintain consistent data flow.

Contact Us

For inquiries, constructive feedback, or technical support, Vessel is here to listen. You may find us at dev@vessel.finance or join our vibrant community on Discord.

Explore the endless possibilities of secure trading with Vessel API. Our tools are crafted to empower you, enhancing your capability to craft innovative trading solutions.

Enjoy your trading!

Last modified: 4 个月前
Next
General Info