Getting a list of vaults
Getting a list of all vaults
This endpoint allows users to retrieve details of all the vaults in your account. To do this, the user must have viewer as their API role.
Query Parameters
The user can also filter the query by using the following parameters
| Name | Type | Description |
|---|---|---|
| limit | number | Default at 200 |
| offset | number | Offset for pagination |
| vault_type | string | Type of vault to filter by |
| asset_id | string | Asset id to retrieve in vault |
| network_id | string | Network Id to retrieve in vault |
The "vault_type" is an enumerated value, which can have two values and used to filter for vaults of a certain type:
| Name | Values | Description |
|---|---|---|
| vault_type | warm | Show all warm vaults details |
| vault_type | cold | Show all cold vaults details |
Response
Querying the endpoint will return a "vaults" array which will contain objects detailing each vault with the following components:
| Name | type | description |
|---|---|---|
| vaults | array | Array of vaults object |
| vault_id | string | The id used to identify the vault |
| vault_name | string | The user defined name of the vault from the RakkaR application |
| vault_type | enum | The type of vault, either: warm or cold |
| assets | array | An array of asset objects representing the assets custodie that vault |
The "assets" detail will include the following:
| Name | type | description |
|---|---|---|
| asset_id | string | The symbol abbreviation of the asset |
| asset_name | string | The name of the asset |
| network_id | string | The symbol abbreviation of the network |
| network_name | string | The name of the network |
| balances | object | An object containing balance values |
The "balances" object details the asset's balance into five balance types:
| Name | Type | Description |
|---|---|---|
| total_balance | string | Total balance of the asset in the vault |
| available_balance | string | Balance available for transfer |
| processing_balance | string | Balance being processed for transfer. Includes the balance in approval by your quorum and balance being processed, signed, and broadcasted by RakkaR |
| staking_balance | string | Balance being staked |
| claimable_balance | string | Balance of staking rewards available to be claimed |
The "asset" object will also contain the "addresses" of the asset in that vault, including the following:
| Name | Type | Description |
|---|---|---|
| addresses | array | An object containing address of the asset wallet |
| address | string | The address of the segwit address of the asset |
| address_legacy | string | The legacy address of the asset |
| memo | string | Memo for addresses of asset types with memo/tag/note |
| isPermanent | string | Identifier value for the original address of an asset wallet |
Example Response
{
"timestamp": "2019-01-02T12:34:56.000Z",
"vaults": [
{
"vault_id": "1",
"vault_name": "Vault 1",
"vault_type": "cold",
"assets": [
{
"asset_id": "ADA",
"asset_name": "Cardano",
"network_id": "ADA",
"network_name": "Cardano",
"balances":
{
"total_balance": "530000",
"available_balance": "500000",
"processing_balance": "0",
"staking_balance": "25000",
"claimable_balance": "5000"
},
"addresses": [
{
"address": "addr1...",
"address_legacy": "addr1...",
"memo": "",
"isPermanent": true
},
{
"address": "addr1...",
"address_legacy": "addr1...",
"memo": "",
"is_permanent": false
}
]
},
{
"asset_id": "BTC",
"asset_name": "Bitcoin",
"network_id": "BTC",
"network_name": "Bitcoin Network",
"balances":
{
"total_balance": "60",
"available_balance": "57",
"processing_balance": "3",
"staking_balance": "0",
"claimable_balance": "0"
},
"addresses": [
{
"address": "bc1q...",
"address_legacy": "1C1c...",
"memo": "",
"isPermanent":true
},
{
"address": "bc3q...",
"address_legacy": "12xc...",
"memo": "",
"isPermanent": false
},
{
"address": "bc5w...",
"address_legacy": "132x...",
"memo": "",
"isPermanent": false
}
]
},
{
"asset_id": "XRP",
"asset_name": "Ripple",
"network_id": "XRP",
"network_name": "Ripple",
"balances":
{
"total_balance": "1000",
"available_balance": "1000",
"processing_balance": "0",
"staking_balance": "0",
"claimable_balance": "0"
},
"addresses": [
{
"address": "r123a...",
"address_legacy": "",
"memo": "180294",
"is_permanent": true
},
{
"address": "r123a...",
"address_legacy": "",
"memo" : "6789",
"is_permanent": false
}
]
},
{
"asset_id": "ETH",
"asset_name": "Ethereum",
"network_id": "ETH",
"network_name": "Ethereum Mainnet",
"balances":
{
"total_balance": "2.0",
"available_balance": "1.8",
"processing_balance": "0.2",
"staking_balance": "0",
"claimable_balance": "0"
},
"addresses": [
{
"address": "0xabc...",
"address_legacy": "",
"memo": "",
"is_permanent": true
}
]
}
]
},
{
"vault_id": "2",
"vault_name": "Vault 2",
"vault_type": "warm",
"assets": [
{
"asset_id": "ETH",
"asset_name": "Ethereum",
"network_id": "ETH",
"network_name": "Ethereum Mainnet",
"balances":
{
"total_balance": "2.0",
"available_balance": "1.8",
"processing_balance": "0.2",
"staking_balance": "0",
"claimable_balance": "0"
},
"addresses": [
{
"address": "0xabc...",
"address_legacy": "",
"memo": "",
"is_permanent": true
}
]
}
]
}
]
}Getting details of a specific vault
To retrieve details of a specific vault, use this endpoint extension by using the vault_id as a path parameter.
Path Parameter
Users must input the id of a vault under vault_id into the parameter.
| Component | Type | Description |
|---|---|---|
| vault_id | string | Vault ID to retrieve |
The response will be in the same format but will only show information of the requested vault.
Example Response
{
"timestamp": "2019-01-02T12:34:56.000Z",
"vaults": [
{
"vault_id": "2",
"vault_name": "Vault 2",
"vault_type": "warm",
"assets": [
{
"asset_id": "ETH",
"asset_name": "Ethereum",
"network_id": "ETH",
"network_name": "Ethereum Mainnet",
"balances":
{
"total_balance": "2.0",
"available_balance": "1.8",
"processing_balance": "0.2",
"staking_balance": "0",
"claimable_balance": "0"
},
"addresses": [
{
"address": "0xabc...",
"address_legacy": "",
"memo": "",
"is_permanent": true
}
]
}
]
}Updated about 1 month ago