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"
}
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/trading/vaults"
payload = {
"ids": ["<string>"],
"venueIds": ["<string>"],
"names": ["<string>"],
"statuses": ["ACTIVE"],
"companyIds": ["ZTEST"],
"createdBy": ["<string>"],
"paginationLimit": 10,
"paginationOffset": 123,
"sort": { "by": "id" }
}
headers = {
"submitter-id": "<submitter-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'submitter-id': '<submitter-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['<string>'],
venueIds: ['<string>'],
names: ['<string>'],
statuses: ['ACTIVE'],
companyIds: ['ZTEST'],
createdBy: ['<string>'],
paginationLimit: 10,
paginationOffset: 123,
sort: {by: 'id'}
})
};
fetch('https://api.custody.api-zodia.io/v3/api/trading/vaults', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.custody.api-zodia.io/v3/api/trading/vaults",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'<string>'
],
'venueIds' => [
'<string>'
],
'names' => [
'<string>'
],
'statuses' => [
'ACTIVE'
],
'companyIds' => [
'ZTEST'
],
'createdBy' => [
'<string>'
],
'paginationLimit' => 10,
'paginationOffset' => 123,
'sort' => [
'by' => 'id'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"submitter-id: <submitter-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.custody.api-zodia.io/v3/api/trading/vaults"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"venueIds\": [\n \"<string>\"\n ],\n \"names\": [\n \"<string>\"\n ],\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"createdBy\": [\n \"<string>\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("submitter-id", "<submitter-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.custody.api-zodia.io/v3/api/trading/vaults")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"venueIds\": [\n \"<string>\"\n ],\n \"names\": [\n \"<string>\"\n ],\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"createdBy\": [\n \"<string>\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/trading/vaults")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["submitter-id"] = '<submitter-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"venueIds\": [\n \"<string>\"\n ],\n \"names\": [\n \"<string>\"\n ],\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"createdBy\": [\n \"<string>\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}Interchange-V3
Retrieve all vaults
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"
}
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/trading/vaults"
payload = {
"ids": ["<string>"],
"venueIds": ["<string>"],
"names": ["<string>"],
"statuses": ["ACTIVE"],
"companyIds": ["ZTEST"],
"createdBy": ["<string>"],
"paginationLimit": 10,
"paginationOffset": 123,
"sort": { "by": "id" }
}
headers = {
"submitter-id": "<submitter-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'submitter-id': '<submitter-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['<string>'],
venueIds: ['<string>'],
names: ['<string>'],
statuses: ['ACTIVE'],
companyIds: ['ZTEST'],
createdBy: ['<string>'],
paginationLimit: 10,
paginationOffset: 123,
sort: {by: 'id'}
})
};
fetch('https://api.custody.api-zodia.io/v3/api/trading/vaults', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.custody.api-zodia.io/v3/api/trading/vaults",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'<string>'
],
'venueIds' => [
'<string>'
],
'names' => [
'<string>'
],
'statuses' => [
'ACTIVE'
],
'companyIds' => [
'ZTEST'
],
'createdBy' => [
'<string>'
],
'paginationLimit' => 10,
'paginationOffset' => 123,
'sort' => [
'by' => 'id'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"submitter-id: <submitter-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.custody.api-zodia.io/v3/api/trading/vaults"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"venueIds\": [\n \"<string>\"\n ],\n \"names\": [\n \"<string>\"\n ],\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"createdBy\": [\n \"<string>\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("submitter-id", "<submitter-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.custody.api-zodia.io/v3/api/trading/vaults")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"venueIds\": [\n \"<string>\"\n ],\n \"names\": [\n \"<string>\"\n ],\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"createdBy\": [\n \"<string>\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/trading/vaults")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["submitter-id"] = '<submitter-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"venueIds\": [\n \"<string>\"\n ],\n \"names\": [\n \"<string>\"\n ],\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"companyIds\": [\n \"ZTEST\"\n ],\n \"createdBy\": [\n \"<string>\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}Headers
Email of API user submitting the request
Example:
"api-maker@zodia.io"
Body
application/json
Payload to retrieve vaults by using filters
Search by vault IDs
Search by venue IDs
Search by vault names
Search by vault status i.e. ACTIVE or DEACTIVATED
Number of items in response (default is 10)
Example:
10
Show child attributes
Show child attributes
⌘I