Accounts

Get accounts

Returns a list of accounts.

get/v1/accounts

Query parameters

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filters by internal id.

eqstring nullable

Equal filter mode (optional, i.e. param.eq= is the same as param=).
Specify an account address to get items where the specified field is equal to the specified value.

Example: ?address=tz123...

nestring nullable

Not equal filter mode.
Specify an account address to get items where the specified field is not equal to the specified value.

Example: ?address.ne=tz123...

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of account addresses to get items where the specified field is equal to one of the specified values.

Example: ?address.in=tz123..,tz345...

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of account addresses to get items where the specified field is not equal to all the specified values.

Example: ?address.ni=tz123..,tz345...

Filters by address.

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an account type to get items where the specified field is equal to the specified value.

Example: ?type=delegate.

nestring nullable

Not equal filter mode.
Specify an account type to get items where the specified field is not equal to the specified value.

Example: ?type.ne=contract.

Filters accounts by type (user, delegate, contract, rollup, smart_rollup, ghost).

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify a contract kind to get items where the specified field is equal to the specified value.

Example: ?kind=smart_contract.

nestring nullable

Not equal filter mode.
Specify a contract kind to get items where the specified field is not equal to the specified value.

Example: ?kind.ne=delegator_contract.

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of contract kinds to get items where the specified field is equal to one of the specified values.

Example: ?kind.in=smart_contract,asset.

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of contract kinds to get items where the specified field is not equal to all the specified values.

Example: ?kind.ni=smart_contract,asset.

Filters accounts by contract kind (delegator_contract or smart_contract)

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify a tz or KT address to get items where the specified field is equal to the specified value.

Example: ?sender=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8.

nestring nullable

Not equal filter mode.
Specify a tz or KT address to get items where the specified field is not equal to the specified value.

Example: ?sender.ne=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8.

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of addresses to get items where the specified field is equal to one of the specified values.

Example: ?sender.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M.

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of addresses to get items where the specified field is not equal to all the specified values.

Example: ?sender.ni=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M.

eqxstring nullable

Equal to another field filter mode.
Specify a field name to get items where the specified fields are equal.

Example: ?sender.eqx=target.

nexstring nullable

Not equal to another field filter mode.
Specify a field name to get items where the specified fields are not equal.

Example: ?sender.nex=initiator.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?initiator.null or ?initiator.null=false.

Filters accounts by delegate. Allowed fields for .eqx mode: none.

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

nestring nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtstring nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

gestring nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltstring nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

lestring nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?nonce.null or ?nonce.null=false.

Filters accounts by amount of staked pseudotokens.

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

emptyboolean

Filters accounts by balance

eqboolean nullable

Equal filter mode (optional, i.e. param.eq=true is the same as param=true).
Specify a bool flag to get items where the specified field is equal to the specified value.

Example: ?active=true or ?active=1 or ?active.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?active.null or ?active.null=false.

Filters accounts by participation in staking

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filters accounts by last activity level (where the account was updated)

fieldsstring[] nullable

Fields selection mode (optional, i.e. select.fields=balance is the same as select=balance).
Specify a comma-separated list of fields to include into response.

Example: ?select=address,balance => [ { "address": "asd", "balance": 10 } ].

valuesstring[] nullable

Values selection mode.
Specify a comma-separated list of fields to include their values into response.

Example: ?select.values=address,balance => [ [ "asd", 10 ] ].

Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.

ascstring nullable

Ascending sort mode (optional, i.e. sort.asc=id is the same as sort=id).
Specify a field name to sort by.

Example: ?sort=balance.

descstring nullable

Descending sort mode.
Specify a field name to sort by descending.

Example: ?sort.desc=id.

Sorts delegators by specified field. Supported fields: id (default), balance, rollupBonds, firstActivity, lastActivity, numTransactions, numContracts.

elinteger nullable

Elements offset mode (optional, i.e. offset.el=123 is the same as offset=123).
Skips specified number of elements.

Example: ?offset=100.

pginteger nullable

Page offset mode.
Skips page * limit elements. This is a classic pagination.

Example: ?offset.pg=1.

crinteger nullable

Cursor offset mode.
Skips all elements with the cursor before (including) the specified value. Cursor is a field used for sorting, e.g. id. Avoid using this offset mode with non-unique or non-sequential cursors such as amount, balance, etc.

Example: ?offset.cr=45837.

Specifies which or how many items should be skipped

limitinteger

Maximum number of items to return

Response

typestring required

Type of the account (user - simple wallet account, delegate - account, registered as a delegate (baker), contract - smart contract programmable account, ghost - non-existent contract, empty - account hasn't appeared in the blockchain yet, rollup - transactional optimistic rollup, smart_rollup - smart contract optimistic rollup)

addressstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.