Retrieve a list of accounts.

Retrieve a list of all Kaia accounts.

Size

  • The query parameter size is optional. (Min = 1, Max = 1000, Default = 100)
  • Returns an error when given a negative number
  • Uses default value (size=100) when size=0
  • Uses the maximum value (size=1000) when given a value higher than the maximum value.
Request
Security:
basic
query Parameters
size
integer <int64> <= 1000
Default: 100

Maximum size of the account to be queried

Example: size=100
cursor
string

Information on the last cursor

to-timestamp
integer <int64>

Limit of the time range to be queried (Timestamp in seconds)

from-timestamp
integer <int64>

Starting point of the time range to be queried (Timestamp in seconds)

status
string
Default: "enabled"

State of the account to be retrieved. all retrieves accounts of all states, disabled retrieves deactivated accounts, and corrupted retrieves accounts whose keys have been changed and rendered unusable. Default value will be set as enabled.

header Parameters
x-chain-id
required
string

Kaia Network Chain ID (1001 or 8217)

Responses
200

The request is successful.

400

The request is not valid.

get/v2/account
Request samples
curl -i -X GET \
  -u <username>:<password> \
  'https://wallet-api.klaytnapi.com/v2/account?size=100&cursor=string&to-timestamp=0&from-timestamp=0&status=enabled' \
  -H 'x-chain-id: string'
Response samples
application/json
{
  • "cursor": "",
  • "items": [
    ]
}