Tezos BigMaps API

openapi: 3.2.0
info:
  title: TzKT Accounts Big Maps 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: BigMaps
paths:
  /v1/bigmaps/count:
    get:
      tags:
      - BigMaps
      summary: Get bigmaps count
      description: Returns the total number of bigmaps.
      operationId: BigMaps_GetBigMapsCount
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int32
  /v1/bigmaps:
    get:
      tags:
      - BigMaps
      summary: Get bigmaps
      description: Returns a list of bigmaps.
      operationId: BigMaps_GetBigMaps
      parameters:
      - name: contract
        in: query
        description: Filters bigmaps by smart contract address.
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountParameter'
        x-position: 1
        x-tzkt-extension: query-parameter
      - name: path
        in: query
        description: Filters bigmaps by path in the contract storage.
        schema:
          oneOf:
          - $ref: '#/components/schemas/StringParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
      - name: tags
        in: query
        description: 'Filters bigmaps by tags: `metadata`, `token_metadata`, `ledger`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/BigMapTagsParameter'
        x-position: 3
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: metadata,token_metadata,ledger
      - name: active
        in: query
        description: 'Filters bigmaps by status: `true` - active, `false` - removed.'
        schema:
          type:
          - boolean
          - 'null'
        x-position: 4
      - name: lastLevel
        in: query
        description: Filters bigmaps by the last update level.
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 5
        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: 6
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 7
        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: 8
        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: 9
      - name: micheline
        in: query
        description: 'Format of the bigmap key and value type: `0` - JSON, `2` - Micheline'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BigMap'
  /v1/bigmaps/keys:
    get:
      tags:
      - BigMaps
      summary: Get bigmap keys
      description: Returns a list of all bigmap keys.
      operationId: BigMaps_GetBigMapKeys
      parameters:
      - name: id
        in: query
        description: "Filter by internal TzKT id.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 1
        x-tzkt-extension: query-parameter
      - name: bigmap
        in: query
        description: "Filter by bigmap ptr.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 2
        x-tzkt-extension: query-parameter
      - name: active
        in: query
        description: 'Filters by status: `true` - active, `false` - removed.'
        schema:
          type:
          - boolean
          - 'null'
        x-position: 3
      - name: hash
        in: query
        description: "Filter by key hash.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/ExpressionParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
      - name: key
        in: query
        description: "Filter by key.  \nNote, this parameter supports the following format: `key{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?key.foo.in=bar,baz`).  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 5
        x-tzkt-extension: json-parameter
      - name: value
        in: query
        description: "Filter by value.  \nNote, this parameter supports the following format: `value{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?value.foo.in=bar,baz`).  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 6
        x-tzkt-extension: json-parameter
      - name: firstLevel
        in: query
        description: "Filter by level of the block where the key was first seen.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 7
        x-tzkt-extension: query-parameter
      - name: firstTime
        in: query
        description: "Filter by timestamp (ISO 8601) of the block where the key was first seen.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/TimestampParameter'
        x-position: 8
        x-tzkt-extension: query-parameter
      - name: lastLevel
        in: query
        description: "Filter by level of the block where the key was last seen.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 9
        x-tzkt-extension: query-parameter
      - name: lastTime
        in: query
        description: "Filter by timestamp (ISO 8601) of the block where the key was last seen.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/TimestampParameter'
        x-position: 10
        x-tzkt-extension: query-parameter
      - name: updates
        in: query
        description: "Filter by number of actions with the bigmap key.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 11
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: "Sorts items (asc or desc) by the specified field.\nYou can see what fields can be used for sorting in the response description, below.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 12
        x-tzkt-extension: query-parameter
      - name: offset
        in: query
        description: "Specifies which or how many items should be skipped.  \nClick on the parameter to expand more details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/OffsetParameter'
        x-position: 13
        x-tzkt-extension: query-parameter
      - name: limit
        in: query
        description: Maximum number of items to return.
        schema:
          type: integer
          format: int32
          maximum: 10000.0
          minimum: 0.0
        x-position: 14
      - name: select
        in: query
        description: "Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.\nThis parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection\n(for example, `?select=balance,token.metadata.symbol as token,...`).  \nNote, if you select just one field, the response will be flatten into a simple array of values.  \nClick on the parameter to expand the details."
        schema:
          oneOf:
          - $ref: '#/components/schemas/SelectionParameter'
        x-position: 15
        x-tzkt-extension: query-parameter
      - name: micheline
        in: query
        description: 'Format of the `key` and `value` fields: `0` - JSON, `2` - Micheline'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 16
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BigMapKeyFull'
  /v1/bigmaps/updates/count:
    get:
      tags:
      - BigMaps
      summary: Get bigmap updates count
      description: Returns a total number of bigmap updates.
      operationId: BigMaps_GetBigMapUpdates
      parameters:
      - name: bigmap
        in: query
        description: Filters by bigmap ptr
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 1
        x-tzkt-extension: query-parameter
      - name: path
        in: query
        description: Filters by bigmap path
        schema:
          oneOf:
          - $ref: '#/components/schemas/StringParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
      - name: contract
        in: query
        description: Filters by bigmap contract
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountParameter'
        x-position: 3
        x-tzkt-extension: query-parameter
      - name: tags
        in: query
        description: 'Filters by bigmap tags: `metadata`, `token_metadata`, `ledger`'
        schema:
          oneOf:
          - $ref: '#/components/schemas/BigMapTagsParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: metadata,token_metadata,ledger
      - name: action
        in: query
        description: Filters by action
        schema:
          oneOf:
          - $ref: '#/components/schemas/BigMapActionParameter'
        x-position: 5
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: allocate,add_key,update_key,remove_key,remove
      - name: value
        in: query
        description: "Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n            so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 6
        x-tzkt-extension: json-parameter
      - name: level
        in: query
        description: Filters by level
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 7
        x-tzkt-extension: query-parameter
      - name: timestamp
        in: query
        description: Filters by timestamp
        schema:
          oneOf:
          - $ref: '#/components/schemas/TimestampParameter'
        x-position: 8
        x-tzkt-extension: query-parameter
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BigMapUpdate'
  /v1/bigmaps/updates:
    get:
      tags:
      - BigMaps
      summary: Get bigmap updates
      description: Returns a list of all bigmap updates.
      operationId: BigMaps_GetBigMapUpdates2
      parameters:
      - name: bigmap
        in: query
        description: Filters by bigmap ptr
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 1
        x-tzkt-extension: query-parameter
      - name: path
        in: query
        description: Filters by bigmap path
        schema:
          oneOf:
          - $ref: '#/components/schemas/StringParameter'
        x-position: 2
        x-tzkt-extension: query-parameter
      - name: contract
        in: query
        description: Filters by bigmap contract
        schema:
          oneOf:
          - $ref: '#/components/schemas/AccountParameter'
        x-position: 3
        x-tzkt-extension: query-parameter
      - name: tags
        in: query
        description: 'Filters by bigmap tags: `metadata`, `token_metadata`, `ledger`'
        schema:
          oneOf:
          - $ref: '#/components/schemas/BigMapTagsParameter'
        x-position: 4
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: metadata,token_metadata,ledger
      - name: action
        in: query
        description: Filters by action
        schema:
          oneOf:
          - $ref: '#/components/schemas/BigMapActionParameter'
        x-position: 5
        x-tzkt-extension: query-parameter
        x-tzkt-query-parameter: allocate,add_key,update_key,remove_key,remove
      - name: value
        in: query
        description: "Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n            so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 6
        x-tzkt-extension: json-parameter
      - name: level
        in: query
        description: Filters by level
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 7
        x-tzkt-extension: query-parameter
      - name: timestamp
        in: query
        description: Filters by timestamp
        schema:
          oneOf:
          - $ref: '#/components/schemas/TimestampParameter'
        x-position: 8
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 9
        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: 10
        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: 11
      - name: micheline
        in: query
        description: 'Format of the bigmap key and value type: `0` - JSON, `2` - Micheline'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 12
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BigMapUpdate'
  /v1/bigmaps/{id}:
    get:
      tags:
      - BigMaps
      summary: Get bigmap by Id
      description: Returns a bigmap with the specified Id.
      operationId: BigMaps_GetBigMapById
      parameters:
      - name: id
        in: path
        required: true
        description: Bigmap Id
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: micheline
        in: query
        description: 'Format of the bigmap key and value type: `0` - JSON, `2` - Micheline'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigMap'
  /v1/bigmaps/{id}/type:
    get:
      tags:
      - BigMaps
      summary: Get bigmap type
      description: Returns a type of the bigmap with the specified Id in Micheline format (with annotations).
      operationId: BigMaps_GetBigMapType
      parameters:
      - name: id
        in: path
        required: true
        description: Bigmap Id
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MichelinePrim'
  /v1/bigmaps/{id}/keys:
    get:
      tags:
      - BigMaps
      summary: Get bigmap keys
      description: Returns a list of bigmap keys.
      operationId: BigMaps_GetKeys
      parameters:
      - name: id
        in: path
        required: true
        description: Bigmap Id
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: active
        in: query
        description: 'Filters keys by status: `true` - active, `false` - removed.'
        schema:
          type:
          - boolean
          - 'null'
        x-position: 2
      - name: key
        in: query
        description: "Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`,\n            so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 3
        x-tzkt-extension: json-parameter
      - name: value
        in: query
        description: "Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n            so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 4
        x-tzkt-extension: json-parameter
      - name: lastLevel
        in: query
        description: Filters bigmap keys by the last update level.
        schema:
          oneOf:
          - $ref: '#/components/schemas/Int32Parameter'
        x-position: 5
        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: 6
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
        description: 'Sorts bigmap keys by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `updates`.'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 7
        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: 8
        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: 9
      - name: micheline
        in: query
        description: 'Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BigMapKey'
  /v1/bigmaps/{id}/keys/{key}:
    get:
      tags:
      - BigMaps
      summary: Get bigmap key
      description: Returns the specified bigmap key.
      operationId: BigMaps_GetKey
      parameters:
      - name: id
        in: path
        required: true
        description: Bigmap Id
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: key
        in: path
        required: true
        description: "Either a key hash (`expr123...`) or a plain value (`foo...`).\n            Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`."
        schema:
          type: string
        x-position: 2
      - name: micheline
        in: query
        description: 'Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BigMapKey'
  /v1/bigmaps/{id}/keys/{key}/updates:
    get:
      tags:
      - BigMaps
      summary: Get bigmap key updates
      description: Returns updates history for the specified bigmap key.
      operationId: BigMaps_GetKeyUpdates
      parameters:
      - name: id
        in: path
        required: true
        description: Bigmap Id
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: key
        in: path
        required: true
        description: "Either a key hash (`expr123...`) or a plain value (`foo...`).\n            Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`."
        schema:
          type: string
        x-position: 2
      - name: sort
        in: query
        description: 'Sorts bigmap updates by specified field. Supported fields: `id` (default).'
        schema:
          oneOf:
          - $ref: '#/components/schemas/SortParameter'
        x-position: 3
        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: 4
        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: 5
      - name: micheline
        in: query
        description: 'Format of the key value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string'
        schema:
          default: Json
          oneOf:
          - $ref: '#/components/schemas/MichelineFormat'
        x-position: 6
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BigMapKeyUpdate'
  /v1/bigmaps/{id}/historical_keys/{level}:
    get:
      tags:
      - BigMaps
      summary: Get historical keys
      description: Returns a list of bigmap keys at the specific block.
      operationId: BigMaps_GetHistoricalKeys
      parameters:
      - name: id
        in: path
        required: true
        description: Bigmap Id
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: level
        in: path
        required: true
        description: Level of the block at which you want to get bigmap keys
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: active
        in: query
        description: 'Filters keys by status: `true` - active, `false` - removed.'
        schema:
          type:
          - boolean
          - 'null'
        x-position: 3
      - name: key
        in: query
        description: "Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`,\n            so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 4
        x-tzkt-extension: json-parameter
      - name: value
        in: query
        description: "Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n            so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`."
        schema:
          oneOf:
          - $ref: '#/components/schemas/JsonParameter'
        x-position: 5
        x-tzkt-extension: json-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: 6
        x-tzkt-extension: query-parameter
      - name: sort
        in: query
   

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