v2 .2026-03-20

Jump to

Ctrl

General Information

Rest APIs

List UTXOs

GET

/vaults/{vaultId}/utxos

Returns a list of UTXOs (Unspent Transaction Outputs) for a given vault, with optional filtering by vault account, asset, address, and spend status.

Path Parameters

vaultId string Required

Unique identifier of the vault.

Query Parameters

context string Optional

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.

address string Optional

Filter UTXOs by blockchain address.

assetId string Optional

Filter UTXOs by asset id.

isSpent boolean Optional

Filter by spend status (true - spent, false - unspent). If not provided, default is false (only unspent UTXOs are returned).

limit integer Optional

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

Default : 50

startingAfter string Optional

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

vaultAccountId string Optional

Filter UTXOs belonging to a specific vault account.

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

data object Required

limit integer Required

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

startingAfter string Optional

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

5ca21f92cf5431000105d1a7

hasMore boolean Required

Defines whether or not there are more elements available after this set.

true

items array Items (object) Required

address string Required

Blockchain address that received the UTXO.

tb1qulfd8mt9j57sxv6k4gqz3766n5qa97049kuc35

assetId string Required

Identifier of the asset associated with this UTXO.

6913471c6b2794841dc8fb6f

createdTimestamp integer Required

Unix timestamp (milliseconds) when the UTXO was created or confirmed.

1705399159

index string Required

Output index within the transaction.

isSpent boolean Required

Indicates whether this UTXO has been spent (true) or is still unspent (false).

false

transactionId string Required

Hash of the blockchain transaction that created this UTXO.

c7ef013b7e4230307839db369e5d86944b5239493d4f31359c340cfcca97fb4d

utxoId string Required

Unique identifier for the address/UTXO record, used as the value for the startingAfter pagination parameter when fetching the next page of results.

6960d8d889a82e0ff42e0f92

value object Required

amount string Required

Amount of the asset.

0.001

assetUnit string Required

Asset unit (e.g., BTC, LTC, USDC).

BTC

vaultAccountId string Required

Identifier of the vault account that owns this UTXO.

6936c7e88097040007891abe

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

uri_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified URI has not been found. Check the URI and try again.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

code string Required

Specifies an error code, e.g. error 404.

limit_greater_than_allowed

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

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 array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

code string Required

Specifies an error code, e.g. error 404.

invalid_pagination

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

missing_api_key

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

code string Required

Specifies an error code, e.g. error 404.

invalid_api_key

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The provided API key is invalid. Please, generate a new one from your Dashboard.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

code string Required

Specifies an error code, e.g. error 404.

endpoint_not_allowed_for_plan

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

code string Required

Specifies an error code, e.g. error 404.

endpoint_not_allowed_for_api_key

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

This endpoint is not available for your API key.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

code string Required

Specifies an error code, e.g. error 404.

feature_mainnets_not_allowed_for_plan

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

resource_not_found

code string Required

Specifies an error code, e.g. error 404.

resource_not_found

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The specified resource has not been found.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

invalid_data

code string Required

Specifies an error code, e.g. error 404.

invalid_data

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The data provided seems to be invalid.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

unsupported_media_type

code string Required

Specifies an error code, e.g. error 404.

unsupported_media_type

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

The selected Media Type is unavailable. The Content-Type header should be 'application/json'.

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

invalid_request_body_structure

code string Required

Specifies an error code, e.g. error 404.

invalid_request_body_structure

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

Your request body for POST requests must have a structure of { data: { item: [...properties] } }

details array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

request_limit_reached

code string Required

Specifies an error code, e.g. error 404.

request_limit_reached

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

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 array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2026-03-20

requestId string Required

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

601c1710034ed6d407996b30

context string Optional

yourExampleString

error object Required

unexpected_server_error

code string Required

Specifies an error code, e.g. error 404.

unexpected_server_error

message string Required

Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.

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 array Items (object) Optional

attribute string Required

Specifies an attribute of the error by name.

attribute which content caused the error

message string Required

Specifies the details of an attribute as part from the error.

message describing the error

Was this page helpful?

Yes

Language

URL

{
    "apiVersion": "2026-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "startingAfter": "5ca21f92cf5431000105d1a7",
        "hasMore": true,
        "items": [
            {
                "address": "tb1qulfd8mt9j57sxv6k4gqz3766n5qa97049kuc35",
                "assetId": "6913471c6b2794841dc8fb6f",
                "createdTimestamp": 1705399159,
                "index": "2",
                "isSpent": false,
                "transactionId": "c7ef013b7e4230307839db369e5d86944b5239493d4f31359c340cfcca97fb4d",
                "utxoId": "6960d8d889a82e0ff42e0f92",
                "value": {
                    "amount": "0.001",
                    "assetUnit": "BTC"
                },
                "vaultAccountId": "6936c7e88097040007891abe"
            }
        ]
    }
}

{
    "apiVersion": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "resource_not_found",
        "message": "The specified resource has not been found.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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": "2026-03-20",
    "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"
            }
        ]
    }
}

List UTXOs

Path Parameters

Query Parameters

Response Schema

Security schema

URL Schema