# Tezos Bigmaps API
> Read Tezos's on-chain key-value storage (bigmaps) live from the public TzKT indexer — no key. A bigmap is Tezos's lazily-deserialised on-chain map: the data structure smart contracts use for the big stuff — token ledgers (who owns what), NFT ownership, allowances and metadata. The Tezos contract explorer lists contracts and their interface, but it cannot browse the bigmaps themselves, read a bigmap's typed key/value schema, or page through its live key-value entries. This opens that. Browse and rank the bigmaps by size with their pointer, owning contract, path (e.g. "ledger"), tags and total/active key counts; read one bigmap's detail and its typed key/value schema (what shape each row's key and value take, e.g. an address-to-nat token ledger); and page through a bigmap's live key-value entries — the actual on-chain data, such as the address-to-balance rows of a token ledger or the owner rows of an NFT collection. The storage / data layer for Tezos explorers, indexers, token dashboards and analytics. Distinct from the Tezos on-chain reader (account state), the smart-contract explorer, the FA-token registry and the .tez naming reader. Live from the indexer; short cache only.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/tezosbigmaps-api/..."
```

## Pricing
- **Free** (Free) — 9,000 calls/Mo, 3 req/s
- **Starter** ($8/Mo) — 170,000 calls/Mo, 10 req/s
- **Pro** ($29/Mo) — 910,000 calls/Mo, 25 req/s
- **Scale** ($86/Mo) — 5,600,000 calls/Mo, 60 req/s

## Endpoints

### Bigmaps

#### `GET /v1/bigmaps` — Browse/rank bigmaps by key count

**Parameters:**
- `limit` (query, optional, string) — Page size (1-100) Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/tezosbigmaps-api/v1/bigmaps?limit=25"
```

**Response:**
```json
{
    "data": {
        "note": "Browse Tezos bigmaps — the on-chain key-value maps smart contracts use for token ledgers, NFT ownership, allowances and metadata — ranked by total key count. Each carries its pointer (ptr), owning contract, path (e.g. 'ledger'), tags and total/active key counts. Paginate with limit; read one in /v1/bigmap, its rows in /v1/keys.",
        "count": 25,
        "source": "TzKT",
        "bigmaps": [
            {
                "ptr": 511,
                "path": "ledger",
                "tags": [
                    "ledger"
                ],
                "active": true,
                "updates": 21410421,
                "contract": "hic et nunc NFTs",
                "last_level": 13639260,
                "total_keys": 7094521,
                "active_keys": 7094521,
                "first_level": 1365143,
                "contract_address": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton"
            },
            {
                "ptr": 103258,
                "path": "asks",
                "tags": [],
                "active": true,
                "updates": 7734628,
                "contract": "objkt.com Marketplace v2",
                "last_level": 13639275,
                "total_keys": 3373150,
                "active_keys": 1010963,
                "first_level": 2103248,
                "contract_address": "KT1WvzYHCNBvDSdwafTHv7nJ1dWmZ8GCYuuC"
            },
            {
                "ptr": 399689,
                "path": 
…(truncated, see openapi.json for full schema)
```

### Bigmap

#### `GET /v1/bigmap` — One bigmap detail + key/value schema

**Parameters:**
- `ptr` (query, optional, string) — Bigmap pointer (numeric); omit for the largest Example: `511`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/tezosbigmaps-api/v1/bigmap?ptr=511"
```

**Response:**
```json
{
    "data": {
        "ptr": 511,
        "note": "One Tezos bigmap in full: its owning contract and path, total/active key counts, and its typed key/value schema (what shape each row's key and value take — e.g. an address→nat token ledger). Omit ptr to use the largest bigmap.",
        "path": "ledger",
        "tags": [
            "ledger"
        ],
        "active": true,
        "source": "TzKT",
        "updates": 21410421,
        "contract": "hic et nunc NFTs",
        "key_type": {
            "args": [
                {
                    "prim": "address"
                },
                {
                    "prim": "nat"
                }
            ],
            "prim": "pair"
        },
        "last_level": 13639260,
        "total_keys": 7094521,
        "value_type": {
            "prim": "nat"
        },
        "active_keys": 7094521,
        "first_level": 1365143,
        "contract_address": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton"
    },
    "meta": {
        "timestamp": "2026-06-14T17:03:52.360Z",
        "request_id": "6ccd73a6-f8bd-4108-9624-b159364e6839"
    },
    "status": "ok",
    "message": "Bigmap retrieved successfully",
    "success": true
}
```

### Keys

#### `GET /v1/keys` — A bigmap's live key-value entries

**Parameters:**
- `ptr` (query, optional, string) — Bigmap pointer (numeric); omit for the largest Example: `511`
- `limit` (query, optional, string) — Page size (1-100) Example: `25`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/tezosbigmaps-api/v1/keys?ptr=511&limit=25"
```

**Response:**
```json
{
    "data": {
        "ptr": "511",
        "keys": [
            {
                "id": 69977850,
                "key": {
                    "nat": "881107",
                    "address": "KT1PHubm9HtyQEJ4BBpMTVomq6mhbfNZ9z5w"
                },
                "value": "1",
                "active": true,
                "updates": 1,
                "first_level": 13639260
            },
            {
                "id": 69977833,
                "key": {
                    "nat": "881107",
                    "address": "tz1hghbrDGx33HendcHRAdKUDtdFoFP24uaE"
                },
                "value": "0",
                "active": true,
                "updates": 2,
                "first_level": 13639242
            },
            {
                "id": 69977826,
                "key": {
                    "nat": "881106",
                    "address": "KT1PHubm9HtyQEJ4BBpMTVomq6mhbfNZ9z5w"
                },
                "value": "1",
                "active": true,
                "updates": 1,
                "first_level": 13639236
            },
            {
                "id": 69977820,
                "key": {
                    "nat": "881106",
                    "address": "tz1gNa1o9LjxjR6T4iqyAUNTNz3QRzfNdr2E"
                },
                "value": "0",
                "active": true,
                "updates": 2,
                "first_level": 13639227
            },
            {
                "id": 69977789,
                "key":
…(truncated, see openapi.json for full schema)
```

### Meta

#### `GET /v1/meta` — Service metadata

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/tezosbigmaps-api/v1/meta"
```

**Response:**
```json
{
    "data": {
        "sample": {
            "largest": "hic et nunc NFTs/ledger"
        },
        "source": "public TzKT indexer (api.tzkt.io), keyless",
        "service": "tezosbigmaps-api",
        "endpoints": {
            "GET /v1/keys": "A bigmap's live key-value entries (ptr; omit for the largest).",
            "GET /v1/meta": "This document.",
            "GET /v1/bigmap": "One bigmap's detail and typed key/value schema (ptr; omit for the largest).",
            "GET /v1/bigmaps": "Browse/rank bigmaps by key count (limit)."
        },
        "description": "Read Tezos's on-chain key-value storage (bigmaps) live from the public TzKT indexer: browse and rank bigmaps by size, read one bigmap's detail and typed key/value schema, and page through its live key-value entries — the actual on-chain data such as token-ledger rows. The storage / data layer for Tezos explorers, indexers and token dashboards. Live, short cache only.",
        "upstream_status": "ok"
    },
    "meta": {
        "timestamp": "2026-06-14T17:03:52.572Z",
        "request_id": "b721afcd-520e-40de-a43d-0ef1fb20f4bb"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}
```


---
Marketplace page: https://www.oanor.com/api/tezosbigmaps-api
OpenAPI spec: https://www.oanor.com/api/tezosbigmaps-api/openapi.json
