getnetworkinfo JSON-RPC command

getnetworkinfo

Returns an object containing various state info regarding P2P networking.

Result

{
  "version": xxxxx,                             (numeric) the server version
  "subversion": "/Bitcoin Cash Node:x.x.x/",    (string) the server subversion string
  "protocolversion": xxxxx,                     (numeric) the protocol version
  "localservices": "xxxxxxxxxxxxxxxx",          (string) the services we offer to the network
  "localrelay": true|false,                     (bool) true if transaction relay is requested from peers
  "timeoffset": xxxxx,                          (numeric) the time offset
  "connections": xxxxx,                         (numeric) the number of connections
  "networkactive": true|false,                  (bool) whether p2p networking is enabled
  "networks": [                                 (array) information per network
  {
    "name": "xxx",                              (string) network (ipv4, ipv6 or onion)
    "limited": true|false,                      (boolean) is the network limited using -onlynet?
    "reachable": true|false,                    (boolean) is the network reachable?
    "proxy": "host:port"                        (string) the proxy that is used for this network, or empty if none
    "proxy_randomize_credentials": true|false,  (bool) whether randomized credentials are used
  }
  ,...
  ],
  "relayfee": x.xxxxxxxx,                       (numeric) minimum relay fee for transactions in BCH/kB
  "excessutxocharge": x.xxxxxxxx,               (numeric) minimum charge for excess utxos in BCH
  "localaddresses": [                           (array) list of local addresses
  {
    "address": "xxxx",                          (string) network address
    "port": xxx,                                (numeric) network port
    "score": xxx                                (numeric) relative score
  }
  ,...
  ]
  "warnings": "..."                             (string) any network and blockchain warnings
}

Examples

> bitcoin-cli getnetworkinfo
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnetworkinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/

---

Bitcoin Cash Node Daemon version v27.1.1-1ce1d89

Documentation on docs.bitcoincashnode.org reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.