Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kusama accounts API

The accounts API from Kusama — 11 operation(s) for accounts.

Kusama accounts API is one of 21 APIs that Kusama publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include accounts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 11 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 20.14.1.

Requests are made against 5 base URLs: https://polkadot-public-sidecar.parity-chains.parity.io/, https://kusama-public-sidecar.parity-chains.parity.io/, https://polkadot-asset-hub-public-sidecar.parity-chains.parity.io/, https://kusama-asset-hub-public-sidecar.parity-chains.parity.io/, http://localhost:8080.

11 operations 11 paths 17 schemas 11 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
20.14.1
Base URL
https://kusama-rpc.polkadot.io/
Resource Areas
1

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 GET. Each is listed below with its method, path, parameters, and response codes.

accounts 11
GET
/accounts/{accountId}/asset-balances
Get an array of asset-balances for an account.
getAssetBalances 5 params → 200400
GET
/accounts/{accountId}/asset-approvals
Get an asset approval for an account.
getAssetApprovals 6 params → 200400
GET
/accounts/{accountId}/balance-info
Get balance information for an account.
getAccountBalanceInfo 6 params → 200400404
GET
/accounts/{accountId}/convert
Convert a given AccountId to an SS58 address.
accountConvert 4 params → 200400404
GET
/accounts/{accountId}/pool-asset-balances
Get an array of pool-asset-balances for an account.
getPoolAssetBalances 5 params → 200400
GET
/accounts/{accountId}/pool-asset-approvals
Get an asset approval for an account.
getPoolAssetApprovals 6 params → 200400
GET
/accounts/{accountId}/foreign-asset-balances
Get an array of foreign-asset-balances for an account.
getForeignAssetBalances 5 params → 200400
GET
/accounts/{accountId}/proxy-info
Get proxy account information.
getProxyInfo 4 params → 200400
GET
/accounts/{accountId}/vesting-info
Get vesting information for an account.
getVestingSummaryByAccountId 5 params → 200400404
GET
/accounts/{address}/validate
Validate a given address.
getValidationByAccountId 1 param → 200
GET
/accounts/compare
Compares up to 30 SS58 addresses.
accountCompare 1 param → 200400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AccountBalanceInfo (13 properties), AccountVestingInfo (10 properties), AccountConvert (6 properties), AccountProxyInfo (6 properties). Each schema is shown below with its type and property counts.

AccountAssetsApproval
object
6 properties
AccountProxyInfo
object
6 properties
AddressDetails
object
4 properties
BlockIdentifiers
object
2 properties
VestingSchedule
object
Vesting schedule for an account.
4 properties
Error
object
4 properties
AccountValidation
object
4 properties
AccountForeignAssetsBalances
object
5 properties
AccountVestingInfo
object
Sidecar version's =11.0.0, that value will now default as an array when there is no value, and Vec is returned when there is.
10 properties
AccountAssetsBalances
object
5 properties
AccountConvert
object
6 properties
AssetsBalance
object
4 properties
AccountCompare
object
2 properties
AccountPoolAssetsBalances
object
5 properties
AccountBalanceInfo
object
13 properties
ForeignAssetBalance
object
4 properties
BalanceLock
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kusama-accounts-api-openapi.yml Raw ↑

Other APIs Kusama publishes across the network.

Kusama JSON-RPC API
Kusama ahm API
Kusama blocks API
Kusama contracts API
Kusama coretime API
Kusama node API
Kusama pallets API
Kusama paras API
Kusama rc accounts API
Kusama rc API
Kusama rc blocks API
Kusama rc node API