Skip to main content

Accounts API

Endpoints for querying account information, balances, permissions, and domains.

Balance & Status

EndpointDescriptionMethod
getAccountGet account detailsGET
getBalanceGet account balanceGET
getEffectiveBalanceGet effective balanceGET
getGuaranteedBalanceGet guaranteed balanceGET
getAccountBlocksGet account blocksGET
getAccountBlockCountGet account block countGET
getAccountBlockIdsGet account block IDsGET

Account Identity & Keys

EndpointDescriptionMethod
getAccountIdGet account ID from passphrase/public keyGET
getAccountPublicKeyGet account public keyGET
deriveAccountFromSeedDerive account from seedGET
deriveKeysDerive keys from seedGET
getShamwariQKPGet ShamwariQKP from passphraseGET

Account Assets

EndpointDescriptionMethod
getAccountTotemsGet account totem holdingsGET
getAccountTotemCountGet totem countGET
getAccountCurrenciesGet account currency holdingsGET
getAccountCurrencyCountGet currency countGET
getAccountCurrencyAccountsGet currency payment accountsGET
getAccountCurrencyVaultsGet currency vault infoGET
getAccountCurrencySavingsGet currency savingsGET
getAccountCurrencyLoansGet currency loansGET

Account Properties & Control

EndpointDescriptionMethod
getAccountPropertiesGet account propertiesGET
setAccountPropertySet account propertyPOST
deleteAccountPropertyDelete account propertyPOST
getAccountLessorsGet account lessorsGET

Account Domains

EndpointDescriptionMethod
registerAccountDomainRegister domainPOST
deregisterAccountDomainDeregister domainPOST
transferAccountDomainTransfer domainPOST
getAccountDomainGet domain infoGET
renewAccountDomainRenew domainPOST

Account Permissions

EndpointDescriptionMethod
getAccountPermissionsGet permissionsGET
addAccountPermissionAdd permissionPOST
removeAccountPermissionRemove permissionPOST

Phased Transactions

EndpointDescriptionMethod
getAccountPhasedTransactionsGet phased transactionsGET
getVoterPhasedTransactionsGet voter phased txsGET
getLinkedPhasedTransactionsGet linked phased txsGET
getAccountPhasedTransactionCountCount phased txsGET

Account Exchange Requests

EndpointDescriptionMethod
getAccountExchangeRequestsGet exchange requestsGET

Current Orders

EndpointDescriptionMethod
getAccountCurrentAskOrderIdsGet ask order IDsGET
getAccountCurrentBidOrderIdsGet bid order IDsGET
getAccountCurrentAskOrdersGet ask ordersGET
getAccountCurrentBidOrdersGet bid ordersGET
getAccountShufflingsGet account shufflingsGET

ShamwariQKP

EndpointDescriptionMethod
getShamwariQKPGet keys from passphraseGET