User Profile - Vessel Finance API

Request

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/user' \
--header 'VESSEL-API-KEY;' \
--header 'VESSEL-PASSPHRASE;' \
--header 'VESSEL-SIGNATURE;' \
--header 'VESSEL-TIMESTAMP;'

Responses

🟢200OK

application/json

Body

vesselKey

string

required

The user's vessel public key. Within the Vessel system, authentication is handled by a separate key pair.

address

string

required

The user's wallet address.

id

string

required

A unique identifier for the user on our platform.

makerFeeRate

string

required

The fee rate applied to the user's maker orders.

takerFeeRate

string

required

The fee rate applied to the user's taker orders.

level

string

required

The user's account level, indicating their privileges on the platform.

status

string

required

The status of the user's account (e.g., "ACTIVE").

balances

array [object {2}]

required

An array containing the user's asset balances.

assetName

string

required

The name of the cryptocurrency asset.

balance

string

required

The balance of the respective cryptocurrency asset.

currentOpenOrders

array [object {2}]

required

An array containing the user's open orders.

symbol

string

optional

The trading pair symbol associated with the open orders.

orders

array [object {13}]

optional

An array containing details of each open order for this symbol.

Example

{
    "vesselKey": "0x9f4ce77bc6dadec2e270471c8d0e71bad9791fdc66eadadd175eb9cb485e5094acf498b0a3facfeac02aecbce16b9d49ee300dbe8e92a425a389623f7937291a",
    "address": "0xeb21904eb292f74204a45f22aaf7edc6eddf1072",
    "id": "43",
    "makerFeeRate": "0.002",
    "takerFeeRate": "0.002",
    "level": "DEFAULT",
    "status": "ACTIVE",
    "balances": [
        {
            "assetName": "USDT",
            "balance": "196398.8"
        },
        {
            "assetName": "USDC",
            "balance": "100000"
        }
    ],
    "currentOpenOrders": [
        {
            "symbol": "WBTCUSDT",
            "orders": [
                {
                    "symbol": "WBTCUSDT",
                    "orderId": "91314",
                    "clientOrderId": "1703223681782",
                    "price": "36000",
                    "origQty": "0.1",
                    "executedQty": "0",
                    "cumulativeQuoteQty": "0",
                    "status": "NEW",
                    "timeInForce": "GTC",
                    "type": "LIMIT",
                    "side": "BUY",
                    "workingTime": "1703223719815",
                    "orderTime": "1703223719814"
                }
            ]
        }
    ]
}