# Vessel Finance API

## Docs
- [Introduction](http://apidoc.vessel.finance/doc-3308447.md): 
- [General Info](http://apidoc.vessel.finance/doc-3660228.md): 
- [HMAC Signature Guide](http://apidoc.vessel.finance/doc-3320030.md): 
- [Poseidon Signature Guide](http://apidoc.vessel.finance/doc-3362436.md): 
- [Internal Transfer Signature Guide](http://apidoc.vessel.finance/doc-5434347.md): 
- [Error Code](http://apidoc.vessel.finance/doc-5266833.md): 
- [Vessel REST API](http://apidoc.vessel.finance/folder-24949932.md): 
- Vessel REST API [Public](http://apidoc.vessel.finance/folder-25000237.md): 
- Vessel REST API [User](http://apidoc.vessel.finance/folder-25001596.md): 
- [Vessel WebSocket](http://apidoc.vessel.finance/folder-25210505.md): 
- Vessel WebSocket [Market](http://apidoc.vessel.finance/folder-25210805.md): 
- Vessel WebSocket [User](http://apidoc.vessel.finance/folder-25210816.md): 

## API Docs
- Vessel REST API > Public > Market Data [24hr Ticker Statistics](http://apidoc.vessel.finance/api-127023978.md): 24-Hour Ticker Statistics provides a summary of trading activity for a specific trading pair over the past 24 hours on our platform.
- Vessel REST API > Public > Market Data [Kline / Candlestick Data](http://apidoc.vessel.finance/api-127109782.md): K Line provides historical candlestick (K line) data for a specified trading pair on our platform. 
- Vessel REST API > Public > Market Data [Order Book](http://apidoc.vessel.finance/api-127120144.md): Order Book offers a real-time snapshot of the current market depth, providing information about the existing buy (bids) and sell (asks) orders on our platform.
- Vessel REST API > Public > Market Data [Recent Trades List](http://apidoc.vessel.finance/api-127145311.md): Recent Trades List allows users to retrieve information about the most recent trades executed on our platform. 
- Vessel REST API > Public > Market Data [Average Price](http://apidoc.vessel.finance/api-128291350.md): Average Price provides the average price of a trading pair(e.g., WBTCUSDT) over a specific time (5 minutes) period.
- Vessel REST API > Public > Market Data [AMM Pool Last 24h Data](http://apidoc.vessel.finance/api-172449672.md): AMM Pool Detailed Data provides the data about Automated Market Maker (AMM) pools, including their configuration parameters and liquidity.
- Vessel REST API > Public > Exchange Data [Ticker Info](http://apidoc.vessel.finance/api-126836267.md): Exchange Info provides current trading rules and symbol information for the decentralized exchange (DEX) platform. 
- Vessel REST API > Public > Exchange Data [Asset Info](http://apidoc.vessel.finance/api-126846524.md): Asset Info provides detailed information about supported assets on our platform.
- Vessel REST API > Public > Exchange Data [Trade Fee](http://apidoc.vessel.finance/api-126750125.md): Trade Fee provides real-time information about fee rates applicable to spot trading on our platform. Developer can retrieve the current fee rates for trading transactions, including maker and taker fees.
- Vessel REST API > Public > Exchange Data [AMM Pool Info](http://apidoc.vessel.finance/api-172388812.md): AMM Pool Info provides information concerning Automated Market Maker (AMM) pools. 
- Vessel REST API > User > Asset [User Asset](http://apidoc.vessel.finance/api-126767025.md): User Assets provides detailed information about a user's assets on our platform, including available balances, in-use amounts, pending withdrawals, and current market prices.
- Vessel REST API > User > Asset [Withdraw](http://apidoc.vessel.finance/api-127088764.md): Initiate a withdrawal request using the POST method.
- Vessel REST API > User > Asset [Withdraw History](http://apidoc.vessel.finance/api-127069863.md): Withdraw History provides a list of historical withdrawal transactions on our platform. 
- Vessel REST API > User > Asset [Deposit History](http://apidoc.vessel.finance/api-127763613.md): User Deposit History provides users with a comprehensive list of their deposit transactions on our platform.
- Vessel REST API > User > Asset [Claim History](http://apidoc.vessel.finance/api-191686310.md): Claim History provides a list of historical claim transactions. Users can query the claims made of a specific assetName, including details like the amount, asset name, and timestamp of each claim.
- Vessel REST API > User > Asset [Internal Transfer (Send)](http://apidoc.vessel.finance/api-229851916.md): The Send API endpoint is used to initiate a transfer of assets from one account to another. The sender and the recipient must be the registered user in Vessel.
- Vessel REST API > User > Asset [Internal Transfer History](http://apidoc.vessel.finance/api-229887845.md): The Internal Transfer History API endpoint allows users to retrieve the transaction history of internal transfers (Send and Receive).
- Vessel REST API > User > Order [Place Order](http://apidoc.vessel.finance/api-127083684.md): Place Order allows users to place a specific order on our platform. To utilize this API, follow the  [Poseidon Signature Guide](doc-3362436) to generate the necessary body parameters and timestamp for the header. Input the generated values and proceed to test our Place Order API.
- Vessel REST API > User > Order [Cancel Order](http://apidoc.vessel.finance/api-127762937.md): Cancel Order allows users to cancel a specific order on our platform.
- Vessel REST API > User > Order [Open Orders](http://apidoc.vessel.finance/api-127217209.md): Open Orders provides information about open orders for a specific user on our platform. These orders are active and have not yet been fullfilled or canceled.
- Vessel REST API > User > Order [Completed Orders](http://apidoc.vessel.finance/api-227408558.md): 
- Vessel REST API > User > Order [All Orders](http://apidoc.vessel.finance/api-127219844.md): All Orders provides comprehensive details about all historical orders for a specific trading pair on our platform. This includes both filled, expired and canceled orders.
- Vessel REST API > User > Order [Query Order](http://apidoc.vessel.finance/api-127227873.md): Query Order provides detailed information about a specific order on our platform using the trading pair symbol and either the orderId or clientOrderId. It only returns data for closed orders within the last 14 days or open orders. If you need to retrieve information about orders that were closed more than 14 days ago, please refer to the [All Orders](apifox://link/endpoint/127219844) endpoint. 
- Vessel REST API > User > Order [Modify Order](http://apidoc.vessel.finance/api-210910568.md): Modify Order allows users to modify a specific order on our platform. To utilize this API, follow the Poseidon Signature Guide to generate the necessary body parameters and timestamp for the header. Input the generated values and proceed to test our Modify Order API.
- Vessel REST API > User > AMM [Add Liquidity](http://apidoc.vessel.finance/api-172454622.md): Add Liquidity allows users to add liquidity to an Automated Market Maker (AMM) pool. Users must provide the pool ID, price tick range, base and quote asset amounts, a nonce, and a signature for authentication. Upon successful execution, the API returns the amounts of base and quote assets added to the pool.
- Vessel REST API > User > AMM [Remove Liquidity](http://apidoc.vessel.finance/api-172454626.md): Remove Liquidity allows users to remove liquidity from an Automated Market Maker (AMM) pool. Users must provide the pool ID, price tick range, base and quote asset amounts to remove, a nonce, and a signature for authentication. Upon successful execution, the API returns the amounts of base and quote assets removed from the pool, as well as any fee amounts incurred.
- Vessel REST API > User > AMM [Collect Fee](http://apidoc.vessel.finance/api-172454628.md): Collect Fee allows users to collect fees from their positions within an Automated Market Maker (AMM) pool. Users must provide the pool ID, price tick range, and nonce for authentication. Upon successful execution, the API returns the amounts of base and quote assets collected as fees from the position.
- Vessel REST API > User > AMM [AMM Position](http://apidoc.vessel.finance/api-172454610.md): 
- Vessel REST API > User > AMM [AMM Action History](http://apidoc.vessel.finance/api-172454613.md): 
- Vessel REST API > User > Account [User Profile](http://apidoc.vessel.finance/api-127488725.md): User Profile provides detailed information about a user's profile on our platform. This includes the vessel key, wallet address, maker and taker fee rates, account level, status, asset balances, and open orders.
- Vessel REST API > User > Account [User Trade List](http://apidoc.vessel.finance/api-127766234.md): User Trade History provides users with a detailed history of their trade transactions for a specific trading pair (symbol) on our platform. 
- Vessel WebSocket > Market [Order Book](http://apidoc.vessel.finance/websocket-3496234.md): Order Book is used to subscribe to real-time updates for the order book of a specific trading pair on our platform.
- Vessel WebSocket > Market [K Line](http://apidoc.vessel.finance/websocket-3496265.md): K Line is used to subscribe to real-time updates for the candlestick (Kline) data of a specific trading pair on our platform.
- Vessel WebSocket > Market [Recent Trades](http://apidoc.vessel.finance/websocket-3496309.md): Recent Trades is used to subscribe to real-time updates on recent trades for a specific trading pair on our platform.
- Vessel WebSocket > Market [24hr Ticker Statistics](http://apidoc.vessel.finance/websocket-3496312.md): Ticker Statistics is used to subscribe to real-time updates on symbol statistics for a specific trading pair on our platform.
- Vessel WebSocket > Market [Ticker Setting Upade](http://apidoc.vessel.finance/websocket-3562425.md): 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.
- Vessel WebSocket > User [Authorize](http://apidoc.vessel.finance/websocket-3501597.md): Before subscribing to user data channels, you need to authenticate by connecting to the authorization channel. Use your API key for authentication.
- Vessel WebSocket > User [Balance](http://apidoc.vessel.finance/websocket-3496243.md): Balance is used to subscribe to real-time updates about user's account balances. 
- Vessel WebSocket > User [Account](http://apidoc.vessel.finance/websocket-3506618.md): Account is used to subscribe to real-time updates about user's account changes.