--- title: "Get accounts" method: GET path: "/v1/accounts" tags: ["Accounts"] --- # Get accounts `GET /v1/accounts` Returns a list of accounts. ## Query parameters - `id` Int32Parameter - `eq` integer, 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`. - `ne` integer, 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`. - `gt` integer, 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`. - `ge` integer, 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`. - `lt` integer, 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`. - `le` integer, 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`. - `in` integer[], 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`. - `ni` integer[], 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`. - `address` AddressParameter - `eq` string, 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..`. - `ne` string, 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..`. - `in` string[], 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..`. - `ni` string[], 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..`. - `type` AccountTypeParameter - `eq` string, 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`. - `ne` string, 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`. - `kind` ContractKindParameter - `eq` string, 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`. - `ne` string, 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`. - `in` string[], 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`. - `ni` string[], 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`. - `delegate` AccountParameter - `eq` string, 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`. - `ne` string, 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`. - `in` string[], 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`. - `ni` string[], 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`. - `eqx` string, nullable — **Equal to another field** filter mode. \ Specify a field name to get items where the specified fields are equal. Example: `?sender.eqx=target`. - `nex` string, 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`. - `null` boolean, 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`. - `stakedPseudotokens` BigIntegerNullableParameter - `eq` string, 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`. - `ne` string, 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`. - `gt` string, 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`. - `ge` string, 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`. - `lt` string, 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`. - `le` string, 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`. - `in` string[], 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`. - `ni` string[], 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`. - `null` boolean, 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`. - `balance` Int64Parameter - `eq` integer, 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`. - `ne` integer, 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`. - `gt` integer, 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`. - `ge` integer, 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`. - `lt` integer, 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`. - `le` integer, 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`. - `in` integer[], 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`. - `ni` integer[], 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`. - `empty` boolean - `staked` BoolParameter - `eq` boolean, 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`. - `null` boolean, 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`. - `lastActivity` Int32Parameter - `eq` integer, 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`. - `ne` integer, 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`. - `gt` integer, 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`. - `ge` integer, 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`. - `lt` integer, 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`. - `le` integer, 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`. - `in` integer[], 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`. - `ni` integer[], 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`. - `select` SelectParameter - `fields` string[], 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 } ]`. - `values` string[], nullable — **Values** selection mode. \ Specify a comma-separated list of fields to include their values into response. Example: `?select.values=address,balance` => `[ [ "asd", 10 ] ]`. - `sort` SortParameter - `asc` string, 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`. - `desc` string, nullable — **Descending** sort mode. \ Specify a field name to sort by descending. Example: `?sort.desc=id`. - `offset` OffsetParameter - `el` integer, nullable — **Elements** offset mode (optional, i.e. `offset.el=123` is the same as `offset=123`). \ Skips specified number of elements. Example: `?offset=100`. - `pg` integer, nullable — **Page** offset mode. \ Skips `page * limit` elements. This is a classic pagination. Example: `?offset.pg=1`. - `cr` integer, 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`. - `limit` integer ## Response `200` - Account[] - `type` string, 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) - `address` string --- [API](https://skmtc.dev/tzkt/apis/tzkt-api.md) · [All operations](https://skmtc.dev/tzkt/apis/tzkt-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tzkt/tzkt-api/revisions/a2e2aba5e534/schema)