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

Kadena payload API

Raw literal Block Payloads in the form in which they are stored on the chain.By default only the payload data is returned which is sufficient for validatingthe blockchain Merkle Tree. It is also sufficient as input to Pact forexecuting the Pact transactions of the block and recomputing the outputs.It is also possible to query the transaction outputs along with the payload data.

Kadena payload API is one of 16 APIs that Kadena publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include payload. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 0.0.

Requests are made against 5 base URLs: https://api.chainweb.com/chainweb/{apiVersion}/mainnet01, https://api.testnet.chainweb.com/chainweb/{apiVersion}/testnet04, {schema}://{domain}:{port}/chainweb/{apiVersion}/{chainwebVersion}, https://{location}.chainweb.com/chainweb/{apiVersion}/mainnet01, https://{location}.testnet.chainweb.com/chainweb/{apiVersion}/testnet04.

4 operations 4 paths 8 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.0
Base URL
https://api.chainweb.com/chainweb/0.0/mainnet01
Resource Areas
1

Paths & Operations 4

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

payload 4

Raw literal Block Payloads in the form in which they are stored on the chain. By default only the payload data is returned which is sufficient for validating the blockchain Merkle…

GET
/chain/{chain}/payload/{payloadHash}
Get Block Payload
3 params → 200404
POST
/chain/{chain}/payload/batch
Get Batch of Block Payload
1 param body → 200
GET
/chain/{chain}/payload/{payloadHash}/outputs
Get Block Payload With Outputs
3 params → 200404
POST
/chain/{chain}/payload/outputs/batch
Get Batch of Block Payload With Outputs
1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are payloadWithOutputs (6 properties), payload (5 properties), payloadBatchBody (2 properties). Each schema is shown below with its type and property counts.

payloadWithOutputs
object
Payload with outputs of a Block including the Merkle roots for transactions and transaction outputs
6 properties 6 required
payloadHash
Base64Url (without padding) encoded block payload hash
hostAddress
string
Host address containing IPv4 and port
payloadBatchBody
object
2 properties
payload
object
Payload of a Block including the Merkle roots for transactions and transaction outputs.
5 properties 5 required
sha256Hash
string
Base64Url (without padding) encoded SHA256 hash
payloadHashArray
array
posixTimestamp
integer
Seconds since POSIX epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kadena-payload-api-openapi.yml Raw ↑

Other APIs Kadena publishes across the network.

Kadena block API
Kadena blockhash API
Kadena config API
Kadena cut API
Kadena endpoint-listen API
Kadena endpoint-local API
Kadena endpoint-poll API
Kadena endpoint-private API
Kadena endpoint-send API
Kadena endpoint-spv API
Kadena header API
Kadena mempool API