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

The Mining API of Chainweb node is disabled by default. It can be enabledand configured in the configuration file.The mining API consists of the following endpoints thatare described in detail on the[Chainweb mining wiki page](https://github.com/kadena-io/chainweb-node/wiki/Mining-API)* `GET mining/work`* `POST mining/solved`* `GET mining/updates`

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

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

This API exposes 3 operations across 3 paths, and defines 4 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.

3 operations 3 paths 4 schemas 2 GET1 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 3

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

mining 3

The Mining API of Chainweb node is disabled by default. It can be enabled and configured in the configuration file. The mining API consists of the following endpoints that are des…

GET
/mining/work
Get Mining Work
body → 200
POST
/chainweb/0.0/mainnet01/mining/solved
Solved Mining Work
body → 204
GET
/mining/updates
Notification of Updated Work
body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed is minerInfo (3 properties). Each schema is shown below with its type and property counts.

miningUpdateEventStream
array
A stream of server-sent events. This is not a JSON array. Events are separated by empty lines (\n\n). Each event consists of a single line: event:New Cut
minerInfo
object
3 properties
posixTimestamp
integer
Seconds since POSIX epoch
hostAddress
string
Host address containing IPv4 and port

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kadena-mining-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