Get Vault balance - DexBuilder Docs

GET

api

dexbuilder

user

balance

Get Vault balance

curl --request GET \
  --url https://api.dexbuilder.com/api/v4/dexbuilder/user/balance \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <api-key>' \
  --header 'Timestamp: <api-key>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>' \
  --header 'x-perp-device-type: <x-perp-device-type>'

import requests

url = "https://api.dexbuilder.com/api/v4/dexbuilder/user/balance"

headers = {
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "x-perp-device-type": "<x-perp-device-type>",
    "KEY": "<api-key>",
    "Timestamp": "<api-key>",
    "SIGN": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "code": 0,
  "message": "success",
  "reason": "<string>",
  "trace_id": "<string>",
  "data": {
    "available": "100.5"
  }
}

Use a Broker API Key and pass the target user’s wallet in X-User-Wallet-Address. The gateway checks that the wallet belongs to your Broker. See Broker API Key and signing.

Usage notes

available is the Vault balance denominated in USDT.
Pass x-perp-device-type as specified in the OpenAPI request parameters.

Authorizations

KEY

string

header

required

Broker API Key

Timestamp

string

header

required

Unix timestamp in seconds

SIGN

string

header

required

Hexadecimal HMAC-SHA512 signature generated with the Broker Secret Key

Headers

X-User-Wallet-Address

string

required

Target user's wallet address. The gateway verifies that the user belongs to the current Broker.

x-perp-device-type

enum<string>

required

DexBuilder device type: 1 Android, 2 iOS, 3 WEB. A missing or invalid value returns INVALID_DEVICE_TYPE. Required only on the platform endpoints that specify this header.

Available options:

1,

2,

3

Response

Query successful

code

integer

Business code; 0 indicates success

Example:

0

message

string

Human-readable message; success responses use success

Example:

"success"

reason

string

Error reason identifier; usually empty on success

trace_id

string

Trace ID to provide when requesting support

data

object

Show child attributes

Get Vault balance

curl --request GET \
  --url https://api.dexbuilder.com/api/v4/dexbuilder/user/balance \
  --header 'KEY: <api-key>' \
  --header 'SIGN: <api-key>' \
  --header 'Timestamp: <api-key>' \
  --header 'X-User-Wallet-Address: <x-user-wallet-address>' \
  --header 'x-perp-device-type: <x-perp-device-type>'

import requests

url = "https://api.dexbuilder.com/api/v4/dexbuilder/user/balance"

headers = {
    "X-User-Wallet-Address": "<x-user-wallet-address>",
    "x-perp-device-type": "<x-perp-device-type>",
    "KEY": "<api-key>",
    "Timestamp": "<api-key>",
    "SIGN": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "code": 0,
  "message": "success",
  "reason": "<string>",
  "trace_id": "<string>",
  "data": {
    "available": "100.5"
  }
}

​Usage notes

Authorizations

Headers

Response

Usage notes