Tezos Accounts API

openapi: 3.2.0
info:
  title: TzKT Accounts API
  description: "# Introduction\n\nTzKT is the most widely used tool in Tezos that provides you with convenient and flexible access to the Tezos blockchain data, processed and indexed by its own indexer. \nYou can fetch all historical data via REST API, or subscribe for real-time data via WebSocket API. TzKT was built by the joint efforts of the entire Tezos community \nto help developers build more services and dapps on top of Tezos.\n\nTzKT Indexer and API are [open-source](https://github.com/baking-bad/tzkt), so don't be afraid to depend on the third-party service,\nbecause you can always clone, build and run it yourself to have full control over all the components.\n\nFeel free to contact us if you have any questions or feature requests.\nYour feedback is much appreciated!\n\n- Discord: https://discord.gg/aG8XKuwsQd\n- Telegram: https://t.me/baking_bad_chat\n- X: https://x.com/TezosBakingBad\n- Email: hello@bakingbad.dev\n\nAnd don't forget to star TzKT [on GitHub](https://github.com/baking-bad/tzkt) if you like it \U0001F60A\n\n# Get Started\n\nThere are two API services provided for public use:\n- **Free TzKT API** with free anonymous access;\n- **TzKT Pro** with paid subscriptions with increased rate limits, off-chain data, extended support and business-level SLA.\n\nYou can find more details about differences between available tiers [here](https://tzkt.io/api).\n\n## Free TzKT API\n\nFree-tier TzKT API is the best way to get started and explore available Tezos data and API functionality.\nIt doesn't require authorization and is free for everyone and for both commercial and non-commercial use.\n\n> #### Note: attribution required\nIf you use free-tier TzKT API, you **must** mention it on your website or application by placing the label\n\"Powered by TzKT API\", or \"Built with TzKT API\", or \"Data provided by TzKT API\" with a direct link to [tzkt.io](https://tzkt.io).\n\nIt's available for the following Tezos networks with the following base URLs:\n\n- Mainnet: `https://api.tzkt.io/` or `https://api.mainnet.tzkt.io/` ([view docs](https://api.tzkt.io))\n- Ghostnet: `https://api.ghostnet.tzkt.io/` ([view docs](https://api.ghostnet.tzkt.io))\n- Shadownet: `https://api.shadownet.tzkt.io/` ([view docs](https://api.shadownet.tzkt.io))\n- Seoulnet: `https://api.seoulnet.tzkt.io/` ([view docs](https://api.seoulnet.tzkt.io))\n- Tallinnnet: `https://api.tallinnnet.tzkt.io/` ([view docs](https://api.tallinnnet.tzkt.io))\n\n### Sending Requests\n\nTo send a request to Free TzKT API you need literally nothing. Just take the base URL of the particular network\n(for example, Tezos mainnet: `https://api.tzkt.io`) and append the path of the particular endpoint\n(for example, chain's head: `/v1/head`), that's pretty much it: \n\n```bash\ncurl https://api.tzkt.io/v1/head\n```\n\nRead through this documentation to explore available endpoints, query parameters\n(note, if you click on a query parameter, you will see available modes, such as `.eq`, `.in`, etc.)\nand response models. If you have any questions, do not hesitate to ask for support, Tezos community has always been very friendly! \U0001F609\n\n### Rate Limits\n\nPlease, refer to https://tzkt.io/api to check relevant rate limits.\n\nIf you exceed the limit, the API will respond with `HTTP 429` status code.\n\n## TzKT Pro\n\nTzKT Pro is intended for professional use, for those who seek for extended capabilities, performance, reliability and business-level SLA.\nTzKT Pro service is provided via paid subscriptions. Please, refer to [Pricing Plans](https://tzkt.io/api) to check available tiers.\n\nIt's available for the following Tezos networks with the following base URLs:\n\n- Mainnet: `https://pro.tzkt.io/` ([view docs](https://api.tzkt.io))\n- Testnets: *let us know if you need TzKT Pro for testnets*\n\n### Authorization\n\nTo access TzKT Pro you will need to authorize requests with your personal API key, that you will receive on your email after purchasing a subscription.\nThis can be done by adding the query string parameter `?apikey={your_key}` or by adding the HTTP header `apikey: {your_key}`.\n\nNote that you can have multiple API keys within a single subscription.\n\nKeep your API keys private, do not publish it anywhere and do not hardcode it, especially in public repositories.\nIf your key was compromised, just let us know and we will issue a new one.\n\nAlso note that passing the API key via HTTP headers is more secure, because in HTTPS headers are encrypted,\nbut query string is not, so the key can be unintentionally exposed to third parties.\n\n### Sending Requests\n\nSending a request with the API key passed as a query string parameter:\n\n```bash\ncurl https://pro.tzkt.io/v1/head?apikey={your_key}\n```\n\nSending a request with the API key passed via an HTTP header:\n\n```bash\ncurl https://pro.tzkt.io/v1/head \\\n    -H 'apikey: {your_key}'\n```\n\n### Rate Limits\n\nPlease, refer to https://tzkt.io/api to check relevant rate limits for different pricing plans.\n\nAlso, TzKT Pro provides you with the additional HTTP headers to show the allowed limits, number of available requests\nand the time remaining (in seconds) until the quota is reset. Here's an example:\n\n```\nRateLimit-Limit: 50\nRateLimit-Remaining: 49\nRateLimit-Reset: 1\n```\n\nIt also sends general information about your rate limits per second and per day:\n\n```\nX-RateLimit-Limit-Second: 50\nX-RateLimit-Remaining-Second: 49\nX-RateLimit-Limit-Day: 3000000\nX-RateLimit-Remaining-Day: 2994953\n```\n\nIf you exceed the limit, the API will respond with `HTTP 429` status code.\n"
  contact:
    name: Baking Bad Team
    url: https://bakingbad.dev
    email: hello@bakingbad.dev
  version: 1.17.1
  x-logo:
    url: https://tzkt.io/logo.png
    href: https://tzkt.io/
servers:
- url: https://api.tzkt.io
tags:
- name: Accounts
paths:
  /v1/accounts:
    get:
      tags:
      - Accounts
      summary: Get accounts
      description: Returns a list of accounts.
      operationId: Accounts_Get
      parameters:
      - name: id
        in: query
        description: Filters by internal id.
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 1
        x-tzkt-extension: query-parameter
      - name: address
        in: query
        description: Filters by address.
        schema:
          oneOf:
          - $ref: '#/components/schemas/AddressParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
      - name: type
        in: query
        description: Filters accounts by type (`user`, `delegate`, `contract`, `rollup`, `smart_rollup`, `ghost`).
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountTypeParameter'
        x-position: 3
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: user,contract,delegate
      - name: kind
        in: query
        description: Filters accounts by contract kind (`delegator_contract` or `smart_contract`)
        schema:
          oneOf:
          - $ref: '#/components/schemas/ContractKindParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: delegator_contract,smart_contract
      - name: delegate
        in: query
        description: 'Filters accounts by delegate. Allowed fields for `.eqx` mode: none.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountParameter'
        x-position: 5
        x-tzkt-extension: query-parameter
      - name: stakedPseudotokens
        in: query
        description: Filters accounts by amount of staked pseudotokens.
        schema:
          oneOf:
          - $ref: '#/components/schemas/BigIntegerNullableParameter'
        x-position: 6
        x-tzkt-extension: query-parameter
      - name: balance
        in: query
        description: Filters accounts by balance
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int64Parameter'
        x-position: 7
        x-tzkt-extension: query-parameter
      - name: staked
        in: query
        description: Filters accounts by participation in staking
        schema:
          oneOf:
          - $ref: '#/components/schemas/BoolParameter'
        x-position: 8
        x-tzkt-extension: query-parameter
      - name: lastActivity
        in: query
        description: Filters accounts by last activity level (where the account was updated)
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 9
        x-tzkt-extension: query-parameter
      - name: select
        in: query
        description: 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.
        schema:
          oneOf:
          - $ref: '#/components/schemas/SelectParameter'
        x-position: 10
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sorts delegators by specified field. Supported fields: `id` (default), `balance`, `rollupBonds`, `firstActivity`, `lastActivity`, `numTransactions`, `numContracts`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 11
        x-tzkt-extension: query-parameter
      - name: offset
        in: query
        description: Specifies which or how many items should be skipped
        schema:
          oneOf:
          - $ref: '#/components/schemas/OffsetParameter'
        x-position: 12
        x-tzkt-extension: query-parameter
      - name: limit
        in: query
        description: Maximum number of items to return
        schema:
          type: integer
          format: int32
          default: 100
          maximum: 10000.0
          minimum: 0.0
        x-position: 13
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Account'
  /v1/accounts/activity:
    get:
      tags:
      - Accounts
      summary: Get accounts activity
      operationId: Accounts_GetActivity
      parameters:
      - name: addresses
        in: query
        description: Comma-separated list of account addresses to get activity of.
        schema:
          type: string
        x-position: 1
      - name: roles
        in: query
        description: Comma-separated list of activity roles (`sender`, `target`, `initiator`, `mention`) to filter activity by.
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: types
        in: query
        description: "Comma-separated list of activity types (`activation`, `autostaking`, `baking`, `ballot`, `dal_attestation_reward`,\n            `dal_entrapment_evidence`, `dal_publish_commitment`, `delegation`, `double_baking`, `double_consensus`, `drain_delegate`, \n            `attestation`, `attestation_reward`, `increase_paid_storage`, `migration`, `nonce_revelation`, `origination`, `preattestation`, `proposal`,\n            `register_constant`, `reveal`, `revelation_penalty`, `set_delegate_parameters`, `set_deposits_limit`, `sr_add_messages`, `sr_cement`, `sr_execute`,\n            `sr_originate`, `sr_publish`, `sr_recover_bond`, `sr_refute`, `staking`, `transaction`, `transfer_ticket`, `tx_rollup_commit`, `tx_rollup_dispatch_tickets`,\n            `tx_rollup_finalize_commitment`, `tx_rollup_origination`, `tx_rollup_rejection`, `tx_rollup_remove_commitment`, `tx_rollup_return_bond`, `tx_rollup_submit_batch`,\n            `vdf_revelation`, `update_secondary_key`, `ticket_transfer`, `token_transfer`)"
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: timestamp
        in: query
        description: Filter activity by timestamp.
        schema:
          oneOf:
          - $ref: '#/components/schemas/TimestampParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sort mode: 0 - asc (oldest to newest), 1 - desc (newest to oldest).'
        schema:
          default: Descending
          oneOf:
          - $ref: '#/components/schemas/SortMode'
        x-position: 5
      - name: lastId
        in: query
        description: Id of the last activity element received, which is used for cursor pagination.
        schema:
          type:
          - integer
          - 'null'
          format: int64
        x-position: 6
      - name: limit
        in: query
        description: Number of elements to return.
        schema:
          type: integer
          format: int32
          default: 100
          maximum: 1000.0
          minimum: 0.0
        x-position: 7
      - name: micheline
        in: query
        description: 'Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string.'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 8
      - name: quote
        in: query
        description: Comma-separated list of ticker symbols to inject historical prices into response.
        schema:
          default: None
          oneOf:
          - $ref: '#/components/schemas/Symbols'
        x-position: 9
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Activity'
  /v1/accounts/count:
    get:
      tags:
      - Accounts
      summary: Get accounts count
      description: Returns a number of accounts.
      operationId: Accounts_GetCount
      parameters:
      - name: type
        in: query
        description: Filters accounts by type (`user`, `delegate`, `contract`, `rollup`, `smart_rollup`, `ghost`).
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountTypeParameter'
        x-position: 1
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: user,contract,delegate
      - name: kind
        in: query
        description: Filters accounts by contract kind (`delegator_contract` or `smart_contract`)
        schema:
          oneOf:
          - $ref: '#/components/schemas/ContractKindParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: delegator_contract,smart_contract
      - name: balance
        in: query
        description: Filters accounts by balance
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int64Parameter'
        x-position: 3
        x-tzkt-extension: query-parameter
      - name: staked
        in: query
        description: Filters accounts by participation in staking
        schema:
          oneOf:
          - $ref: '#/components/schemas/BoolParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
      - name: firstActivity
        in: query
        description: Filters accounts by first activity level (where the account was created)
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 5
        x-tzkt-extension: query-parameter
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int32
  /v1/accounts/{address}:
    get:
      tags:
      - Accounts
      summary: Get account by address
      description: Returns an account with the specified address.
      operationId: Accounts_GetByAddress
      parameters:
      - name: address
        in: path
        required: true
        description: Account address
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
  /v1/accounts/{address}/contracts:
    get:
      tags:
      - Accounts
      summary: Get account contracts
      description: Returns a list of contracts created by (or related to) the specified account.
      operationId: Accounts_GetContracts
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      - name: sort
        in: query
        description: 'Sorts contracts by specified field. Supported fields: `id` (default, desc), `balance`, `creationLevel`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
      - name: offset
        in: query
        description: Specifies which or how many items should be skipped
        schema:
          oneOf:
          - $ref: '#/components/schemas/OffsetParameter'
        x-position: 3
        x-tzkt-extension: query-parameter
      - name: limit
        in: query
        description: Maximum number of items to return
        schema:
          type: integer
          format: int32
          default: 100
          maximum: 10000.0
          minimum: 0.0
        x-position: 4
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelatedContract'
  /v1/accounts/{address}/delegators:
    get:
      tags:
      - Accounts
      summary: Get account delegators
      description: Returns a list of accounts delegated to the specified account.
      operationId: Accounts_GetDelegators
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz)
        schema:
          type: string
        x-position: 1
      - name: type
        in: query
        description: Filters delegators by type (`user`, `delegate`, `contract`, `rollup`, `smart_rollup`, `ghost`).
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountTypeParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: user,contract,delegate
      - name: balance
        in: query
        description: Filters delegators by balance.
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int64Parameter'
        x-position: 3
        x-tzkt-extension: query-parameter
      - name: delegationLevel
        in: query
        description: Number of items to skip
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 4
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sorts delegators by specified field. Supported fields: `delegationLevel` (default, desc), `balance`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 5
        x-tzkt-extension: query-parameter
      - name: offset
        in: query
        description: Specifies which or how many items should be skipped
        schema:
          oneOf:
          - $ref: '#/components/schemas/OffsetParameter'
        x-position: 6
        x-tzkt-extension: query-parameter
      - name: limit
        in: query
        description: Maximum number of items to return
        schema:
          type: integer
          format: int32
          default: 100
          maximum: 10000.0
          minimum: 0.0
        x-position: 7
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Delegator'
  /v1/accounts/{address}/counter:
    get:
      tags:
      - Accounts
      summary: Get counter
      description: Returns account counter
      operationId: Accounts_GetCounter
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int32
  /v1/accounts/{address}/balance:
    get:
      tags:
      - Accounts
      summary: Get balance
      description: Returns account balance
      operationId: Accounts_GetBalance
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int64
  /v1/accounts/{address}/balance_history/{level}:
    get:
      tags:
      - Accounts
      summary: Get balance at level
      description: "Returns account balance* at the specified block.  \n\\* - for non-baker tz-accounts historical balances do not include staked tez,\nbecause stakers do not really have staked tez on their balance, they have staking pseudotokens instead.\nIf you want to get a full historical balance, including staked tez, use the Tezos node RPC:\n`/chains/main/blocks/{level}/context/contracts/{address}/full_balance`."
      operationId: Accounts_GetBalanceAtLevel
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      - name: level
        in: path
        required: true
        description: Block height at which you want to know account balance
        schema:
          type: integer
          format: int32
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int64
  /v1/accounts/{address}/balance_history/{datetime}:
    get:
      tags:
      - Accounts
      summary: Get balance at date
      description: "Returns account balance* at the specified datetime.  \n\\* - for non-baker tz-accounts historical balances do not include staked tez,\nbecause stakers do not really have staked tez on their balance, they have staking pseudotokens instead.\nIf you want to get a full historical balance, including staked tez, use the Tezos node RPC:\n`/chains/main/blocks/{level}/context/contracts/{address}/full_balance`."
      operationId: Accounts_GetBalanceAtDate
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      - name: datetime
        in: path
        required: true
        description: Datetime at which you want to know account balance (e.g. `2020-01-01`, or `2019-12-30T23:42:59Z`)
        schema:
          type: string
          format: date-time
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int64
  /v1/accounts/{address}/balance_history:
    get:
      tags:
      - Accounts
      summary: Get balance history
      description: "Returns time series with historical balances* (only changes, without duplicates).  \n\\* - for non-baker tz-accounts historical balances do not include staked tez,\nbecause stakers do not really have staked tez on their balance, they have staking pseudotokens instead.\nIf you want to get a full historical balance, including staked tez, use the Tezos node RPC:\n`/chains/main/blocks/{level}/context/contracts/{address}/full_balance`."
      operationId: Accounts_GetBalanceHistory
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      - name: step
        in: query
        description: Step of the time series, for example if `step = 1000` you will get balances at blocks `1000, 2000, 3000, ...`.
        schema:
          type:
          - integer
          - 'null'
          format: int32
        x-position: 2
      - name: select
        in: query
        description: 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.
        schema:
          oneOf:
          - $ref: '#/components/schemas/SelectParameter'
        x-position: 3
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sorts historical balances by specified field. Supported fields: `level`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
      - name: offset
        in: query
        description: Specifies which or how many items should be skipped
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 5
      - name: limit
        in: query
        description: Maximum number of items to return
        schema:
          type: integer
          format: int32
          default: 100
          maximum: 10000.0
          minimum: 0.0
        x-position: 6
      - name: quote
        in: query
        description: Comma-separated list of ticker symbols to inject historical prices into response
        schema:
          default: None
          oneOf:
          - $ref: '#/components/schemas/Symbols'
        x-position: 7
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoricalBalance'
  /v1/accounts/{address}/report:
    get:
      tags:
      - Accounts
      summary: Get account report
      description: Exports account balance report in .csv format
      operationId: Accounts_GetBalanceReport
      parameters:
      - name: address
        in: path
        required: true
        description: Account address (starting with tz or KT)
        schema:
          type: string
        x-position: 1
      - name: from
        in: query
        description: Start of the datetime range to filter by (ISO 8601, e.g. 2019-11-31)
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 2
      - name: to
        in: query
        description: End of the datetime range to filter by (ISO 8601, e.g. 2019-12-31)
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 3
      - name: currency
        in: query
        description: Currency to convert amounts to (`btc`, `eur`, `usd`, `cny`, `jpy`, `krw`, `eth`, `gbp`)
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: historical
        in: query
        description: '`true` if you want to use historical prices, `false` to use current price'
        schema:
          type: boolean
          default: false
        x-position: 5
      - name: delimiter
        in: query
        description: Column delimiter (`comma`, `semicolon`)
        schema:
          type: string
          default: comma
        x-position: 6
      - name: separator
        in: query
        description: Decimal separator (`comma`, `point`)
        schema:
          type: string
          default: point
        x-position: 7
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
components:
  schemas:
    AddressParameter:
      type: object
      additionalProperties: false
      properties:
        eq:
          type:
          - string
          - 'null'
          description: '**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:
          type:
          - string
          - 'null'
          description: '**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:
          type:
          - array
          - 'null'
          description: '**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..`.'
          items:
            type: string
        ni:
          type:
          - array
          - 'null'
          description: '**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..`.'
          items:
            type: string
      x-tzkt-extension: query-parameter
    SortParameter:
      type: object
      additionalProperties: false
      properties:
        asc:
          type:
          - string
          - 'null'
          description: '**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:
          type:
          - string
          - 'null'
          description: '**Descending** sort mode. \

            Specify a field name to sort by descending.


            Example: `?sort.desc=id`.'
      x-tzkt-extension: query-parameter
    Int32Parameter:
      type: object
      additionalProperties: false
      properties:
        eq:
          type:
          - integer
          - 'null'
          description: '**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`.'
          format: int32
        ne:
          type:
          - integer
          - 'null'
          description: '**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`.'
          format: int32
        gt:
          type:
          - integer
          - 'null'
          description: '**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`.'
          format: int32
        ge:
          type:
          - integer
          - 'null'
          description: '**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`.'
          format: int32
        lt:
          type:
          - integer
          - 'null'
          description: '**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`.'
          format: int32
        le:
          type:
          - integer
          - 'null'
          description: '**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`.'
          format: int32
        in:
          type:
          - array
          - 'null'
          description: '**In list** (any of) filter mode. \

     

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tezos/refs/heads/main/openapi/tezos-accounts-api-openapi.yml