---
title: "Get contract bigmaps"
method: GET
path: "/v1/contracts/{address}/bigmaps"
tags: ["Contracts"]
---

# Get contract bigmaps

`GET /v1/contracts/{address}/bigmaps`

Returns all active bigmaps allocated in the contract storage.

## Path parameters

- `address` string, required

## Query parameters

- `tags` BigMapTagsParameter
  - `eq` string[], nullable — **Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a comma-separated list of bigmap tags to get bigmaps with exactly the same set of tags. Avoid using this mode and use `.any` or `.all` instead, because it may not work as expected due to internal 'hidden' tags. Example: `?tags=metadata` or `?tags=token_metadata,metadata`.
  - `any` string[], nullable — **Has any** filter mode. \ Specify a comma-separated list of bigmap tags to get bigmaps where at least one of the specified tags is presented. Example: `?tags.any=metadata` or `?tags.any=token_metadata,metadata`.
  - `all` string[], nullable — **Has all** filter mode. \ Specify a comma-separated list of bigmap tags to get bigmaps where all of the specified tags are presented. Example: `?tags.all=metadata` or `?tags.all=token_metadata,metadata`.
- `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
- `micheline` 'Json' | 'JsonString' | 'Raw' | 'RawString'

## Response `200`

- BigMap[]
  - `ptr` integer — Bigmap pointer
  - `contract` Alias, required
    - `alias` string, nullable — Account alias name (off-chain data).
    - `address` string, required — Account address (public key hash).
  - `path` string, required — Path to the bigmap in the contract storage
  - `tags` string[], nullable — List of tags ( `metadata`, `token_metadata`,`ledger`, or `null` if there are no tags)
  - `active` boolean — Bigmap status (`true` - active, `false` - removed)
  - `firstLevel` integer — Level of the block where the bigmap was seen first time
  - `lastLevel` integer — Level of the block where the bigmap was seen last time
  - `totalKeys` integer — Total number of keys ever added to the bigmap
  - `activeKeys` integer — Total number of currently active keys
  - `updates` integer — Total number of actions with the bigmap
  - `keyType` unknown, required
  - `valueType` unknown, required

---

[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)