Skip to main content
POST
/
v3
/
api
/
trading
/
vaults
Retrieve all vaults
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/trading/vaults \
  --header 'Content-Type: application/json' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "venueIds": [
    "<string>"
  ],
  "names": [
    "<string>"
  ],
  "statuses": [
    "ACTIVE"
  ],
  "companyIds": [
    "ZTEST"
  ],
  "createdBy": [
    "<string>"
  ],
  "paginationLimit": 10,
  "paginationOffset": 123,
  "sort": {
    "by": "id"
  }
}
'
{
  "items": [
    {
      "id": "ZTEST-ITV-849P8XKKAO",
      "venueId": "<string>",
      "name": "Demo vault",
      "companyId": "ZTEST",
      "balances": [
        {
          "currency": "BTC",
          "availableBalance": {
            "amount": "<string>",
            "amountUnit": "0.006414",
            "fiatValue": "0.006414",
            "fiatCurrency": "USD",
            "usdValue": "0.006414"
          },
          "ledgerBalance": {
            "amount": "<string>",
            "amountUnit": "0.006414",
            "fiatValue": "0.006414",
            "fiatCurrency": "USD",
            "usdValue": "0.006414"
          },
          "pendingOutBalance": {
            "amount": "<string>",
            "amountUnit": "0.006414",
            "fiatValue": "0.006414",
            "fiatCurrency": "USD",
            "usdValue": "0.006414"
          },
          "pendingInBalance": {
            "amount": "<string>",
            "amountUnit": "0.006414",
            "fiatValue": "0.006414",
            "fiatCurrency": "USD",
            "usdValue": "0.006414"
          },
          "feeBufferBalance": {
            "amount": "<string>",
            "amountUnit": "0.006414",
            "fiatValue": "0.006414",
            "fiatCurrency": "USD",
            "usdValue": "0.006414"
          },
          "subClientBalances": {}
        }
      ],
      "createdAt": "2021-05-11T04:43:43Z",
      "customProperties": {
        "clientReference": "ZodiaTest",
        "walletReference": 1223456
      },
      "createdBy": "api-maker@zodia.io",
      "updatedAt": "2021-05-11T04:43:43Z"
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.zodia-custody.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json

Payload to retrieve vaults by using filters

​
ids
string[]

Search by vault IDs

​
venueIds
string[]

Search by venue IDs

​
names
string[]

Search by vault names

​
statuses
string[]

Search by vault status i.e. ACTIVE or DEACTIVATED

​
companyIds
string[]
​
createdBy
string[]
​
paginationLimit
number

Number of items in response (default is 10)

Example:

10

​
paginationOffset
number
​
sort
object

Response

OK

​
items
object[]
required

Trading vaults owned by the company

​
total
integer
required

Number of vaults