List Vaults by Asset ID

This endpoint allows users to retrieve information about their specific asset in all their vaults.

key.singleItemTitle GET /assets/{assetId}/{blockchain}/vaults/{networkType}

Path Parameters

Required
assetId string

The specific asset ID for the blockchain.

Example : 6523e058a06ebf1322d7dd6f
Required
blockchain string

The specific blockchain, e.g Bitcoin, Ethereum, Binance Smart Chain, Tron.

Example : bitcoin
Required
networkType string

The specific type of the vault - MAIN or TEST (small or capital letters).

Default : test

Example : test

Possible Values : main test

Query Paramaters

Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString

Response Schema

200 400 401 402 403 409 415 422 429 500

Http Status Code: 200
Content Type: application/json

The request has been successful.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2024-05-09
Required
requestId string

Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.

Example : 601c1710034ed6d407996b30
Optional
context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Example : yourExampleString
Required
data
object
- Required
  item object
  
  Required
  exchangeRate string
  
  The current exchange rate.
  
  Example : 1.2
  
  Required
  vaults array
  
  Required
  allocatedAmount string
  
  Allocated amount of the specific asset in the Vault.
  
  Example : 2
  
  Required
  availableAmount string
  
  Available amount of the specific asset in the Vault.
  
  Example : 3.1
  
  Required
  blockedAmount string
  
  Blocked amount of the specific asset in the Vault.
  
  Example : 0
  
  Required
  totalAmount string
  
  Total amount of the specific asset in the Vault.
  
  Example : 5.00001
  
  Required
  vaultColor string
  
  The specific color of the Vault.
  
  Example : #FF991F
  
  Required
  vaultId string
  
  Defines the unique ID of the Vault which contains the specific asset.
  
  Example : 654a4ad6d6aeb3000769074d
  
  Required
  vaultName string
  
  The name of the Vault.
  
  Example : Main Vault
  
  Required
  vaultType string
  
  Represents the type of the Vault, e.g. Smart, General.
  
  Example : general
  
  Possible Values : smart general

Request Example

Http Java C# PHP Python Ruby Node.js Go

GET

https://rest.vaultody.com/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test?context=yourExampleString

Headers

Content-Type: application/json

x-api-key: cb233681a8ee35665296c1824c1f67bc46691788

x-api-sign: PSqeqRLap8rBc/wogNU1DeGGUPb2VyVtg6GiBOaBnYQ=

x-api-timestamp: 1681885776

x-api-passphrase: zYgKeueoOq

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://rest.vaultody.com/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test?context=yourExampleString")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.vaultody.com/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test?context=yourExampleString");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "my-api-key");
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.vaultody.com/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test?context=yourExampleString');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.vaultody.com")
querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("GET", "assets,6523e058a06ebf1322d7dd6f,bitcoin,vaults,test", headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.vaultody.com/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'

response = http.request(request)
puts response.read_body

var https = require("https");
const querystring = require('node:querystring');
const query = {"context":"yourExampleString"};

var options = {
  "method": "GET",
  "hostname": "rest.vaultody.com",
  "path": "/v2/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test" + (Object.keys(query).length ? '?' + querystring.stringify(query) : ''),
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key",
    "X-API-SIGN": signature,
    "X-API-TIMESTAMP": timestamp,
    "X-API-PASSPHRASE": "my-pass-phrase",
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.vaultody.com/assets/6523e058a06ebf1322d7dd6f/bitcoin/vaults/test?context=yourExampleString"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

200 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "exchangeRate": "1.2",
            "vaults": [
                {
                    "allocatedAmount": "2",
                    "availableAmount": "3.1",
                    "blockedAmount": "0",
                    "totalAmount": "5.00001",
                    "vaultColor": "#FF991F",
                    "vaultId": "654a4ad6d6aeb3000769074d",
                    "vaultName": "Main Vault",
                    "vaultType": "general"
                }
            ]
        }
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2024-05-09",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

key.key	key.value

List Vaults by Asset ID

Path Parameters

Query Paramaters

Response Schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Request Example

Response Example

Try It Out