revault-api

Appearance

List accounts ​

GET/accounts

Query parameters ​

NameTypeDescriptionRequired
page
number
Which page to fetch
min: 1, max: 9007199254740991
pageSize
number
Page size to use
min: 1, max: 30
status
"ACTIVE" | "INACTIVE"
Account status
name
string
Search by matching name
governanceType
"CLASSIC" | "TRADELINK" | "RAW_SIGNING"
Account governance type
allowedAction
| "SEND"
| "STAKE"
| "DEPLOY_CONTRACT"
| "EXECUTE_CONTRACT"
| "ACTIVATE_TOKEN"
| "RECEIVE"
| "SIGN_MESSAGE"
| "SIGN_DIGESTS"
Filter accounts by allowed action for current user
sortBy
| "name"
| "currency"
| "index"
| "createdAt"
| "updatedAt"
Sort by attribute
sortOrder
"asc" | "desc"
Sort order
currency
string
Filter accounts by currency
index
number
Filter accounts by account index
contractAddress
string | null
support
"standalone" | "legacy"
Filter accounts by support

Response schema ​

{
// Current page
page: number;
// Next page or null if there is none
next: number | null;
// Previous page or null if there is none
prev: number | null;
// Max count of items per page
pageSize: number;
// Total count of items
total: number;
// Array of results
results: Array<{
// Internal unique identifier
id: string;
// Legacy internal unique identifier (for retro-compatibility)
legacyId: number;
// Name
name: string;
// Will be deprecated soon, use network instead. Currency
currency: string;
// Network (Same as currency for now)
network: string;
// Token contract address for Token account
contractAddress: string | null;
// BIP44 account index
index: number;
// Derivation path
derivationPath: string;
// Status
status: "ACTIVE" | "INACTIVE";
// Creation timestamp
createdAt: string;
// Last modification timestamp
updatedAt: string;
// Account asset fields
asset:
|
Raw signing account
|
Bitcoin-like
|
Canton-like
|
Cardano-like
|
Ethereum-like
|
Generic-like
|
Polkadot-like
|
Ripple-like
|
Solana-like
|
Stellar-like
|
Sui-like
|
Tezos-like
|
Tron-like
// Governance fields
governance:
|
Classic
|
Tradelink
}>;
}

Examples ​

bash
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/accounts"
ts
const url = "<base-url>/accounts";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});
python
import requests

url = "<base-url>/accounts"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

print(requests.get(url, headers=headers))