getminingapiinfo

getminingapiinfo Get mining API connection information and status. Result: { (json object) "available" : true|false, (boolean) Whether mining API is available "connection_healthy" : true|false, (boolean) Connection health status "job_push_endpoint" : "str", (string) Job push ZMQ endpoint "solution_pull_endpoint" : "str", (string) Solution pull ZMQ endpoint "timeout_ms" : n (numeric) ZMQ timeout in milliseconds } Examples: > bitcoin-cli getminingapiinfo > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getminingapiinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getminingapiinfo() → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getminingapiinfo","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getminingapiinfo

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getminingapiinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getminingapiinfo",
        "params": [],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getminingapiinfo",
    params: [],
  }),
});
console.log(await res.json());

Parameters

No parameters.

Result

Type: any

{ (json object) "available" : true|false, (boolean) Whether mining API is available "connection_healthy" : true|false, (boolean) Connection health status "job_push_endpoint" : "str", (string) Job push ZMQ endpoint "solution_pull_endpoint" : "str", (string) Solution pull ZMQ endpoint "timeout_ms" : n (numeric) ZMQ timeout in milliseconds }

Source: services/core-node/bcore/src/rpc/custom.cpp:443

C++ symbol: getminingapiinfo

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"getminingapiinfo","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli getminingapiinfo

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getminingapiinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getminingapiinfo",
        "params": [],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getminingapiinfo",
    params: [],
  }),
});
console.log(await res.json());