Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tezos BigMaps API

The BigMaps API from Tezos — 12 operation(s) for bigmaps.

Tezos BigMaps API is one of 34 APIs that Tezos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BigMaps. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 12 paths, and defines 27 schemas. It is described by OpenAPI 3.0.0, at version 1.17.1.

Requests are made against a single base URL, https://api.tzkt.io.

12 operations 12 paths 27 schemas 12 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.17.1
Base URL
https://api.tzkt.io/v1
Resource Areas
1

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 12 GET. Each is listed below with its method, path, parameters, and response codes.

BigMaps 12
GET
/v1/bigmaps/count
Get bigmaps count
BigMaps_GetBigMapsCount → 200
GET
/v1/bigmaps
Get bigmaps
BigMaps_GetBigMaps 10 params → 200
GET
/v1/bigmaps/keys
Get bigmap keys
BigMaps_GetBigMapKeys 16 params → 200
GET
/v1/bigmaps/updates/count
Get bigmap updates count
BigMaps_GetBigMapUpdates 8 params → 200
GET
/v1/bigmaps/updates
Get bigmap updates
BigMaps_GetBigMapUpdates2 12 params → 200
GET
/v1/bigmaps/{id}
Get bigmap by Id
BigMaps_GetBigMapById 2 params → 200
GET
/v1/bigmaps/{id}/type
Get bigmap type
BigMaps_GetBigMapType 1 param → 200
GET
/v1/bigmaps/{id}/keys
Get bigmap keys
BigMaps_GetKeys 10 params → 200
GET
/v1/bigmaps/{id}/keys/{key}
Get bigmap key
BigMaps_GetKey 3 params → 200
GET
/v1/bigmaps/{id}/keys/{key}/updates
Get bigmap key updates
BigMaps_GetKeyUpdates 6 params → 200
GET
/v1/bigmaps/{id}/historical_keys/{level}
Get historical keys
BigMaps_GetHistoricalKeys 10 params → 200
GET
/v1/bigmaps/{id}/historical_keys/{level}/{key}
Get historical key
BigMaps_GetKey2 4 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are BigMap (12 properties), JsonParameter (11 properties), BigMapKeyFull (11 properties), AccountParameter (9 properties). Each schema is shown below with its type and property counts.

SortParameter
object
2 properties
MichelinePrim
object
3 properties
BigMapKeyFull
object
11 properties
PrimType
integer
ExpressionParameter
object
4 properties
JsonParameter
object
11 properties
OffsetParameter
object
3 properties
BigMapUpdate
object
8 properties
IMicheline
object
1 property
TimestampParameter
object
8 properties
MichelineFormat
string
BigMapKey
object
8 properties
BigMapKeyUpdate
object
5 properties
BigMapActionParameter
object
4 properties
AccountParameter
object
9 properties
SelectionParameter
object
2 properties
BigMapKeyShort
object
3 properties
BigMapKeyHistorical
object
5 properties
MichelineType
integer
BigMap
object
12 properties
IAnnotation
object
2 properties
Alias
object
2 properties
StringParameter
object
7 properties
BigMapTagsParameter
object
3 properties
AnnotationType
integer
Int32Parameter
object
8 properties
SelectParameter
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tezos-bigmaps-api-openapi.yml Raw ↑

Other APIs Tezos publishes across the network.

TzKT Accounts API
TzKT Blocks API
TzKT Operations API
TzKT Contracts API
TzKT Big Maps API
TzKT Tokens API
TzKT Delegations and Staking API
TzKT Governance API
TzKT Protocols API
TzKT WebSocket API
Tezos Accounts API
Tezos Blocks API