List Transactions by Vault

Through this endpoint customers can obtain details on transactions by vault id.

key.singleItemTitle GET /vaults/{vaultId}/transactions

Path Parameters

Required
vaultId string

The sepcific Vault ID.

Example : 6565f9a13f8dcd000760d33a

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
Optional
limit integer

Defines how many items should be returned in the response per page basis.

Default : 50

Example : 50
Optional
startingAfter string

Defines the id of the previous listed record id from which the current list should start from.

Example : 5ca21f92cf5431000105d1a7

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
  limit integer
  
  Defines how many items should be returned in the response per page basis.
  
  Example : 50
- Optional
  startingAfter string
  
  Defines the id of the previous listed record id from which the current list should start from.
  
  Example : 5ca21f92cf5431000105d1a7
- Required
  hasMore boolean
  
  Defines whether or not there are more elements available after this set.
  
  Example : true
- Required
  items array
  Example : Array ( )
  
  Required
  blockchain string
  
  The blockchain protoocl, e.g Bitcoin, Ethereum, Tron.
  
  Example : bitcoin
  
  Required
  createdTimestamp integer
  
  When this transaction was created.
  
  Example : 1705399159
  
  Required
  direction string
  
  The direction of the transaction in this Vault, incoming or outgoing transaction.
  
  Example : incoming
  
  Required
  hasTokenTransfer string
  
  If this transaction has any tokens transfers.
  
  Example : false
  
  Required
  id string
  
  The transaction ID in Vaultody, this is needed for pagination/load more functionality.
  
  Example : 654ba3af9e8dd80901f17347
  
  Required
  isInternal string
  
  If this transaction has any Internal Transactions.
  
  Example : false
  
  Required
  minedInBlockHeight string
  
  The block height this transaction was mined in.
  
  Example : 1234324
  
  Required
  network string
  
  The blockchain network e.g mainnet, testnet, sepolia.
  
  Example : mainnet
  
  Required
  recipients array
  
  Recipients are all addresses receive assets in this transaction.
  
  Required
  address string
  
  The public address itself.
  
  Example : TKGMSZh4Wf3pVB2gWkUqzU7vwGhRy4H245
  
  Optional
  addressType string
  
  The address type, e.g deposit, smart.
  
  Example : deposit
  
  Required
  amount string
  
  The amount received.
  
  Example : 5.96124
  
  Required
  isVaultAddress string
  
  If this address belongs to this Vault or not.
  
  Example : true
  
  Optional
  label string
  
  The label of the address.
  
  Example : Tron address
  
  Required
  unitSymbol string
  
  The unit symbol e.g. BTC, TRX, BNB.
  
  Example : USDT
  
  Required
  senders array
  
  Senders are all addresses send assets in this transaction.
  
  Required
  address string
  
  The public sender's address.
  
  Example : TF5mtoWoahGhJiPU4BXXANPvL1kuRwrBoM
  
  Optional
  addressType string
  
  The address type , e.g. Deposit, Smart.
  
  Required
  amount string
  
  The amount sent.
  
  Example : 0.000001
  
  Required
  isVaultAddress string
  
  If this address belongs to this Vault.
  
  Example : true
  
  Optional
  label string
  
  The address label.
  
  Required
  unitSymbol string
  
  The symbol, e.g BTC, TRX, BNB, ETH.
  
  Example : BTC
  
  Required
  status string
  
  The status of the transaction.
  
  Example : completed
  
  Required
  transactionFee object
  
  The transaction fee details.
  
  Required
  amount string
  
  The transaction fee amount
  
  Example : 5.96124
  
  Required
  unitSymbol string
  
  The transaction fee symbol.
  
  Example : TRX
  
  Required
  transactionId string
  
  The blockchain transaction ID.
  
  Example : 281a63d28ddf6d0d5d78090b7cdf3a8c0be95bbb296544943ef45d9dec44405d

Request Example

Http Java C# PHP Python Ruby Node.js Go

GET

https://rest.vaultody.com/vaults/6565f9a13f8dcd000760d33a/transactions?context=yourExampleString&limit=50&startingAfter=5ca21f92cf5431000105d1a7

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/vaults/6565f9a13f8dcd000760d33a/transactions?context=yourExampleString&limit=50&startingAfter=5ca21f92cf5431000105d1a7")
  .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/vaults/6565f9a13f8dcd000760d33a/transactions?context=yourExampleString&limit=50&startingAfter=5ca21f92cf5431000105d1a7");
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/vaults/6565f9a13f8dcd000760d33a/transactions?context=yourExampleString&limit=50&startingAfter=5ca21f92cf5431000105d1a7');
$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","limit":"50","startingAfter":"5ca21f92cf5431000105d1a7"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("GET", "vaults,6565f9a13f8dcd000760d33a,transactions", 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/vaults/6565f9a13f8dcd000760d33a/transactions?context=yourExampleString&limit=50&startingAfter=5ca21f92cf5431000105d1a7")

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","limit":"50","startingAfter":"5ca21f92cf5431000105d1a7"};

var options = {
  "method": "GET",
  "hostname": "rest.vaultody.com",
  "path": "/v2/vaults/6565f9a13f8dcd000760d33a/transactions" + (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/vaults/6565f9a13f8dcd000760d33a/transactions?context=yourExampleString&limit=50&startingAfter=5ca21f92cf5431000105d1a7"

  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": {
        "limit": 50,
        "startingAfter": "5ca21f92cf5431000105d1a7",
        "hasMore": true,
        "items": [
            {
                "blockchain": "bitcoin",
                "createdTimestamp": 1705399159,
                "direction": "incoming",
                "hasTokenTransfer": "false",
                "id": "654ba3af9e8dd80901f17347",
                "isInternal": "false",
                "minedInBlockHeight": "1234324",
                "network": "mainnet",
                "recipients": [
                    {
                        "address": "TKGMSZh4Wf3pVB2gWkUqzU7vwGhRy4H245",
                        "addressType": "deposit",
                        "amount": "5.96124",
                        "isVaultAddress": "true",
                        "label": "Tron address",
                        "unitSymbol": "USDT"
                    }
                ],
                "senders": [
                    {
                        "address": "TF5mtoWoahGhJiPU4BXXANPvL1kuRwrBoM",
                        "addressType": "",
                        "amount": "0.000001",
                        "isVaultAddress": "true",
                        "label": "",
                        "unitSymbol": "BTC"
                    }
                ],
                "status": "completed",
                "transactionFee": {
                    "amount": "5.96124",
                    "unitSymbol": "TRX"
                },
                "transactionId": "281a63d28ddf6d0d5d78090b7cdf3a8c0be95bbb296544943ef45d9dec44405d"
            }
        ]
    }
}

{
    "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 Transactions by Vault

Path Parameters

Query Paramaters

Response Schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Request Example

Response Example

Try It Out