Skip to main content

Account Information

Account Information (v1.0.0)

Download OpenAPI specification:Download

API Documentation for Account Information

AccountInfo

AccountInfo queries account info which is common to all account types.

Since: cosmos-sdk 0.47

Authorizations:
bearerAuth
path Parameters
address
required
string (address)

address is the account address string.

Responses

Response samples

Content type
application/json
{
  • "info": {
    }
}

Accounts

Accounts returns all the existing accounts.

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Since: cosmos-sdk 0.43

Authorizations:
bearerAuth
query Parameters
pagination.key
string <byte> (key)

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
integer or string <int64> (offset)

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
integer or string <int64> (limit)

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.countTotal
boolean (count_total)

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean (reverse)

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "pagination": {
    }
}

Account

Account returns account details based on address.

Authorizations:
bearerAuth
path Parameters
address
required
string (address)

address defines the address to query for.

Responses

Response samples

Content type
application/json
{
  • "account": {
    }
}

AccountAddressByID

AccountAddressByID returns account address based on account number.

Since: cosmos-sdk 0.46.2

Authorizations:
bearerAuth
path Parameters
id
required
integer or string <int64> (id)
Deprecated

Deprecated, use account_id instead

id is the account number of the address to be queried. This field should have been an uint64 (like all account numbers), and will be updated to uint64 in a future version of the auth query.

query Parameters
accountId
integer or string <int64> (account_id)

account_id is the account number of the address to be queried.

Since: cosmos-sdk 0.47

Responses

Response samples

Content type
application/json
{
  • "accountAddress": "string"
}