Claim History - Vessel Finance API

Request

Query Params

assetName

string

optional

The name of the asset claimed.

startTime

integer

optional

The start of the time range for the claim history in Unix milliseconds.

endTime

integer

optional

The end of the time range for the claim history in Unix milliseconds.

offset

integer

optional

The offset for pagination.

limit

integer

optional

The maximum number of results to return. Default is 500.

fromId

integer

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:

VESSEL-PASSPHRASE

string

required

Default:

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

curl --location --request GET 'https://testnet.trade.vessel.finance/api/v1/gateway/user/history/claim?assetName&startTime&endTime&offset&limit&fromId' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200Success

application/json

Body

claims

array [object {5}]

required

An array containing details for each historical claim transaction.

id

string

optional

amount

string

required

Amount of cryptocurrency claimed.

assetName

string

required

Name of the asset claimed.

address

string

required

Address to which the claim was made.

timestamp

string

required

Timestamp when the claim was made, in Unix milliseconds.

Example

{
    "claims": [
        {
            "id": "259610002",
            "amount": "0.01",
            "assetName": "WBTC",
            "address": "0x3ad8ccb270d84808ca16e2be3594c9eb723210f8",
            "timestamp": "1728716459749"
        }
    ]
}