Accounts
Authorizations
Query parameters
pageany ofOptionalDefault:
Which page to fetch
1
notOptional
integer · min: 1Optional
pageSizeany ofOptionalDefault:
Page size to use
30
notOptional
integer · min: 1 · max: 30Optional
statusstring · enumOptionalPossible values:
Account status
namestringOptional
Search by matching name
governanceTypestring · enumOptionalPossible values:
Account governance type
sortBystring · enumOptionalDefault:
Sort by attribute
createdAt
Possible values: sortOrderstring · enumOptionalDefault:
Sort order
asc
Possible values: skipLiveDatabooleanOptionalDefault:
Do not fetch live data (e.g. balance and staking) from blockchain
false
Responses
200
Successful response
application/json
default
Error response
application/json
get
GET /rest/accounts HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"page": 1,
"next": 1,
"prev": 1,
"pageSize": 1,
"total": 1,
"results": [
{
"id": "text",
"legacyId": 1,
"status": "ACTIVE",
"name": "text",
"currency": "text",
"index": 1,
"derivationPath": "text",
"createdAt": "2025-06-22T14:24:00.220Z",
"updatedAt": "2025-06-22T14:24:00.220Z",
"balance": {
"total": "text",
"pending": "text"
},
"asset": {
"type": "BITCOIN_LIKE",
"xpub": "text"
},
"governance": {
"type": "CLASSIC",
"policyId": "text"
}
}
]
}
Authorizations
Path parameters
idstringRequired
Id of the target account
Query parameters
skipLiveDatabooleanOptionalDefault:
Do not fetch live data (e.g. balance and staking) from blockchain
false
Responses
200
Successful response
application/json
default
Error response
application/json
get
GET /rest/accounts/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"legacyId": 1,
"status": "ACTIVE",
"name": "text",
"currency": "text",
"index": 1,
"derivationPath": "text",
"createdAt": "2025-06-22T14:24:00.220Z",
"updatedAt": "2025-06-22T14:24:00.220Z",
"balance": {
"total": "text",
"pending": "text"
},
"asset": {
"type": "BITCOIN_LIKE",
"xpub": "text"
},
"governance": {
"type": "CLASSIC",
"policyId": "text"
}
}