Fetch all user balances

Shows all balances of all merchants are owned by the user.

POST https://app.thedex.cloud/api/v1/balances

Headers

Name
Type
Description

X-EX-APIKEY*

String

Your API key

X-EX-PAYLOAD*

String

Body to base64

X-EX-SIGNATURE*

String

Encrypted body with the secret key

Request Body (empty JSON)

{ }

Request JSON attributes

Name
Type
Description

-

-

-

Response body

{
   [
      "$PAY_CURRENCY_VALUE":{
         "totalBalance":"String",
         "holdBalance":"String",
         "availableBalance":"String"
      }
   ]
}

Response JSON attributes

$PAY_CURRENCY_VALUE

attribute name

reach out to accessed values to define attributes by link: /api/v1/info/currencies attribute "payCurrencies"

"totalBalance"

String

Sum of hold and available balances.

"holdBalance"

String

Temporary kept balance until balance will be unlocked.

"availableBalance"

String

Available balance to withdrawal

Request curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/balances' \
--header 'X-EX-APIKEY: <string>' \
--header 'X-EX-PAYLOAD: <string>' \
--header 'X-EX-SIGNATURE: <string>' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{}'

Example Curl

curl --location --request POST 'https://app.thedex.cloud/api/v1/balances' \
--header 'X-EX-APIKEY: test_api_key_123456' \
--header 'X-EX-PAYLOAD: e30=' \
--header 'X-EX-SIGNATURE: dummy_signature_abc123' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data-raw '{}'

Last updated