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 Contracts API

The Contracts API from Tezos — 25 operation(s) for contracts.

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

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

This API exposes 26 operations across 25 paths, and defines 32 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.

26 operations 25 paths 32 schemas 25 GET1 POST

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 26

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

Contracts 26
GET
/v1/contracts
Get contracts
Contracts_Get 20 params → 200
GET
/v1/contracts/count
Get contracts count
Contracts_GetCount 15 params → 200
GET
/v1/contracts/{address}
Get contract by address
Contracts_GetByAddress 1 param → 200
GET
/v1/contracts/{address}/same
Get same contracts
Contracts_GetSame 6 params → 200
GET
/v1/contracts/{address}/similar
Get similar contracts
Contracts_GetSimilar 6 params → 200
GET
/v1/contracts/{address}/code
Get contract code
Contracts_GetCode 3 params → 200
GET
/v1/contracts/{address}/interface
Get JSON Schema [2020-12] interface for the contract
Contracts_GetInterface 1 param → 200
GET
/v1/contracts/{address}/entrypoints
Get contract entrypoints
Contracts_GetEntrypoints 5 params → 200
GET
/v1/contracts/{address}/entrypoints/{name}
Get entrypoint by name
Contracts_GetEntrypointByName 5 params → 200
GET
/v1/contracts/{address}/views
Get contract views
Contracts_GetContractViews 4 params → 200
GET
/v1/contracts/{address}/views/{name}
Get view by name
Contracts_GetContractViewByName 5 params → 200
GET
/v1/contracts/{address}/entrypoints/{name}/build
Build entrypoint parameters
Contracts_BuildEntrypointParametersGET 3 params → 200
POST
/v1/contracts/{address}/entrypoints/{name}/build
Build entrypoint parameters
Contracts_BuildEntrypointParametersPOST 2 params body → 200
GET
/v1/contracts/{address}/storage
Get contract storage
Contracts_GetStorage 3 params → 200
GET
/v1/contracts/{address}/storage/schema
Get contract storage schema
Contracts_GetStorageSchema 2 params → 200
GET
/v1/contracts/{address}/storage/history
Get contract storage history
Contracts_GetStorageHistory 3 params → 200
GET
/v1/contracts/{address}/storage/raw
Get raw contract storage
Contracts_GetRawStorage 2 params → 200
GET
/v1/contracts/{address}/storage/raw/schema
Get raw contract storage schema
Contracts_GetRawStorageSchema 2 params → 200
GET
/v1/contracts/{address}/storage/raw/history
Get raw contract storage history
Contracts_GetRawStorageHistory 3 params → 200
GET
/v1/contracts/{address}/bigmaps
Get contract bigmaps
Contracts_GetBigMaps 7 params → 200
GET
/v1/contracts/{address}/bigmaps/{name}
Get bigmap by name
Contracts_GetBigMapByName 3 params → 200
GET
/v1/contracts/{address}/bigmaps/{name}/keys
Get bigmap keys
Contracts_GetBigMapByNameKeys 11 params → 200
GET
/v1/contracts/{address}/bigmaps/{name}/keys/{key}
Get bigmap key
Contracts_GetKey 4 params → 200
GET
/v1/contracts/{address}/bigmaps/{name}/keys/{key}/updates
Get bigmap key updates
Contracts_GetKeyUpdates 7 params → 200
GET
/v1/contracts/{address}/bigmaps/{name}/historical_keys/{level}
Get historical keys
Contracts_GetHistoricalKeys 11 params → 200
GET
/v1/contracts/{address}/bigmaps/{name}/historical_keys/{level}/{key}
Get historical key
Contracts_GetKey2 5 params → 200

Schemas 32

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

ContractView
object
7 properties
SortParameter
object
2 properties
BigMapInterface
object
4 properties
JsonParameter
object
11 properties
OffsetParameter
object
3 properties
Int64Parameter
object
9 properties
IMicheline
object
1 property
EntrypointInterface
object
2 properties
MichelineFormat
string
BigMapKey
object
8 properties
BigMapKeyUpdate
object
5 properties
TimestampParameter
object
8 properties
Contract
AddressParameter
object
4 properties
EventInterface
object
2 properties
TxParameter
object
2 properties
ContractKindParameter
object
4 properties
AccountParameter
object
9 properties
ContractTagsParameter
object
3 properties
SelectionParameter
object
2 properties
DelegateInfo
object
3 properties
ContractInterface
object
4 properties
BigMapKeyHistorical
object
5 properties
MichelineType
integer
BigMap
object
12 properties
Alias
object
2 properties
BigMapTagsParameter
object
3 properties
SourceOperation
object
5 properties
Entrypoint
object
5 properties
StorageRecord
object
5 properties
Int32Parameter
object
8 properties
SelectParameter
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tezos-contracts-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 BigMaps API