Skip to content
LogoLogo

Mining

Node API v1.0.0 (Arrekta Node API).

MethodPathSummary
POST/v1/mining/submitMining Submit
GET/v1/mining/templateMining Template

POST /v1/mining/submit

Mining Submit.

curl -s -X POST http://127.0.0.1:28332/v1/mining/submit -H 'content-type: application/json' -d '{…}'

Request body (application/json, required): HexBody

FieldTypeRequiredNotes
hexstringyesHex-encoded serialized object. max length 16000002

Response 200 (application/json): BlockSubmitted

FieldTypeRequiredNotes
hashstringyes
heightintegeryes
statusstringyesone of connected, side-chain, duplicate, orphan

Unknown fields may be added within v1; clients must ignore them.

Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.

operationId: mining_submit_v1_mining_submit_post

GET /v1/mining/template

Mining Template.

curl -s http://127.0.0.1:28332/v1/mining/template

Parameters

NameInTypeRequiredNotes
addressquerystringyes

Response 200 (application/json): MiningTemplate

FieldTypeRequiredNotes
aux_hashstringyes
bitsstringyes
chain_idintegeryes
coinbase_valuestringyes
hashstringyes
header_hexstringyes
heightintegeryes
powstringyes
prev_hashstringyes
targetstringyes
timestampintegeryes
tx_countintegeryes
txs_hexstringyes

Unknown fields may be added within v1; clients must ignore them.

Errors 400, 404, 409, 422, 429: application/problem+json Problem with a stable code.

operationId: mining_template_v1_mining_template_get

Schemas

BlockSubmitted

FieldTypeRequiredNotes
hashstringyes
heightintegeryes
statusstringyesone of connected, side-chain, duplicate, orphan

Unknown fields may be added within v1; clients must ignore them.

HexBody

FieldTypeRequiredNotes
hexstringyesHex-encoded serialized object. max length 16000002

MiningTemplate

FieldTypeRequiredNotes
aux_hashstringyes
bitsstringyes
chain_idintegeryes
coinbase_valuestringyes
hashstringyes
header_hexstringyes
heightintegeryes
powstringyes
prev_hashstringyes
targetstringyes
timestampintegeryes
tx_countintegeryes
txs_hexstringyes

Unknown fields may be added within v1; clients must ignore them.