Vessel Finance API
  1. Asset
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
          GET
        • Withdraw
          POST
        • Withdraw History
          GET
        • Deposit History
          GET
        • Claim History
          GET
        • Internal Transfer (Send)
          POST
        • Internal Transfer History
          GET
      • 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. Asset

Deposit History

Testnet Env
Testnet Env
GET
/api/v1/gateway/user/history/deposit
Last modified:2024-10-15 06:23:56
User Deposit History provides users with a comprehensive list of their deposit transactions on our platform.

Request

Query Params
assetName
string 
optional
Specifies the name of the asset for which you want to retrieve deposit history. For example, "USDT", "USDC", or "WBTC".
status
string 
optional
Specifies the current status of the deposit request. Possible values include:
SUCCESS - The deposit request has been successfully processed.
PENDING - The deposit request is pending and has not been processed yet.
FAILED - The deposit request has failed.
startTime
string 
optional
Specifies the starting time (Unix timestamps in milliseconds & UTC) for retrieving deposit history. Only deposits made after this timestamp will be included in the result.
Example:
1700635755135
endTime
string 
optional
Specifies the ending time (Unix timestamps in milliseconds & UTC) for retrieving deposit history. Only deposits made before or at this timestamp will be included in the result.
Example:
1700635755137
limit
string 
optional
Specifies the maximum number of deposit history entries to retrieve (Default is 1000. Maximum is 1000).
fromId
string 
optional
The ID from which to start fetching records. In this API, since the order is descending (backwards), if fromId is set to 100, the system will return records starting from the ID just before 100 and continue moving backwards. The retrieval will proceed until the limit is reached.
Header Params
VESSEL-API-KEY
string 
required
Default:
{{API_KEY}}
VESSEL-PASSPHRASE
string 
required
Default:
{{API_PASSPHRASE}}
VESSEL-SIGNATURE
string 
required
Use signRequest script to generate
VESSEL-TIMESTAMP
string 
required
Use signRequest script to set

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/gateway/user/history/deposit?fromId' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK
application/json
Body
deposits
array [object {8}] 
required
An array containing details for each deposit transaction.
id
string 
required
A unique identifier for the deposit transaction.
globalEventId
string 
required
Global event identifier associated with the deposit in Vessel.
amount
string 
required
A amount of cryptocurrency deposited.
transactionFee
string 
required
Transaction fee associated with the deposit.
assetName
string 
required
Name of cryptocurrency (e.g., "USDT" or "WBTC").
status
string 
required
Current status of the deposit request. Possible values include:
SUCCESS - The deposit request has been successfully processed.
PENDING - The deposit request is pending and has not been processed yet.
FAILED - The deposit request has failed.
address
string 
required
Account address from which the cryptocurrency was deposited.
timestamp
string 
required
Timestamp when the deposit transaction was initiated (Unix timestamps in milliseconds & UTC).
Example
{
  "deposits": [
    {
      "id": "1728711700276090",
      "globalEventId": "98791",
      "amount": "10000",
      "transactionFee": "0",
      "assetName": "USDC",
      "status": "SUCCESS",
      "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
      "timestamp": "1728719621766"
    },
    {
      "id": "1728711700276087",
      "globalEventId": "7852",
      "amount": "0.01",
      "transactionFee": "0",
      "assetName": "ETH",
      "status": "SUCCESS",
      "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
      "timestamp": "1728717986541"
    },
    {
      "id": "1728711700276042",
      "globalEventId": "6636",
      "amount": "10",
      "transactionFee": "0",
      "assetName": "ETH01",
      "status": "SUCCESS",
      "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
      "timestamp": "1728714547923"
    },
    {
      "id": "1728640580315366",
      "globalEventId": "615",
      "amount": "100.2",
      "transactionFee": "0",
      "assetName": "USDT",
      "status": "SUCCESS",
      "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
      "timestamp": "1728705668864"
    },
    {
      "id": "1728640580315365",
      "globalEventId": "614",
      "amount": "1",
      "transactionFee": "0",
      "assetName": "WBTC",
      "status": "SUCCESS",
      "address": "",
      "timestamp": "1728705416386"
    }
  ]
}
Modified at 2024-10-15 06:23:56
Previous
Withdraw History
Next
Claim History
Built with