getnetworkinfo

getnetworkinfo Returns an object containing Result: { "version" : n, "subversion" : "str", "protocolversion" : n, "localservices" : "hex", "localservicesnames" : [ "str", ... ], "localrelay" : true|false, "timeoffset" : n, "connections" : n, "connections_in" : n, "connections_out" : n, "networkactive" : true|false, "networks" : [ { "name" : "str", "limited" : true|false, "reachable" : true|false, "proxy" : "str", "proxy_randomize_credentials" }, ... ], "relayfee" : n, "incrementalfee" : n, "localaddresses" : [ { "address" : "str", "port" : n, "score" : n }, ... ], "warnings" : [ "str", ... ] } Examples: > bitcoin-cli getnetworkinfo > curl --user myusername various state info regarding P2P networking. (json object) (numeric) the server version (string) the server subversion string (numeric) the protocol version (string) the services we offer to the network (json array) the services we offer to the network, in human-readable form (string) the service name (boolean) true if transaction relay is requested from peers (numeric) the time offset (numeric) the total number of connections (numeric) the number of inbound connections (numeric) the number of outbound connections (boolean) whether p2p networking is enabled (json array) information per network (json object) (string) network (ipv4, ipv6, onion, i2p, cjdns) (boolean) is the network limited using -onlynet? (boolean) is the network reachable? (string) ("host:port") the proxy that is used for this network, or empty if none : true|false (boolean) Whether randomized credentials are used (numeric) minimum relay fee rate for transactions in BTC/kvB (numeric) minimum fee rate increment for mempool limiting or replacement in BTC/kvB (json array) list of local addresses (json object) (string) network address (numeric) network port (numeric) relative score (json array) any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string) (string) warning --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getnetworkinfo", "params": []}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

getnetworkinfo() → any

Code samples

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

bitcoin-cli getnetworkinfo

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getnetworkinfo", "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": "getnetworkinfo",
        "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: "getnetworkinfo",
    params: [],
  }),
});
console.log(await res.json());

Parameters

No parameters.

Result

Type: any

{ (json object) "version" : n, (numeric) the server version "subversion" : "str", (string) the server subversion string "protocolversion" : n, (numeric) the protocol version "localservices" : "hex", (string) the services we offer to the network "localservicesnames" : [ (json array) the services we offer to the network, in human-readable form "str", (string) the service name ... ], "localrelay" : true|false, (boolean) true if transaction relay is requested from peers "timeoffset" : n, (numeric) the time offset "connections" : n, (numeric) the total number of connections "connections_in" : n, (numeric) the number of inbound connections "connections_out" : n, (numeric) the number of outbound connections "networkactive" : true|false, (boolean) whether p2p networking is enabled "networks" : [ (json array) information per network { (json object) "name" : "str", (string) network (ipv4, ipv6, onion, i2p, cjdns) "limited" : true|false, (boolean) is the network limited using -onlynet? "reachable" : true|false, (boolean) is the network reachable? "proxy" : "str", (string) ("host:port") the proxy that is used for this network, or empty if none "proxy_randomize_credentials" : true|false (boolean) Whether randomized credentials are used }, ... ], "relayfee" : n, (numeric) minimum relay fee rate for transactions in BTC/kvB "incrementalfee" : n, (numeric) minimum fee rate increment for mempool limiting or replacement in BTC/kvB "localaddresses" : [ (json array) list of local addresses { (json object) "address" : "str", (string) network address "port" : n, (numeric) network port "score" : n (numeric) relative score }, ... ], "warnings" : [ (json array) any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string) "str", (string) warning ... ] }

Source: services/core-node/bcore/src/rpc/net.cpp:618

C++ symbol: getnetworkinfo

Code samples

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

bitcoin-cli getnetworkinfo

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "getnetworkinfo", "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": "getnetworkinfo",
        "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: "getnetworkinfo",
    params: [],
  }),
});
console.log(await res.json());