Core Blockchain JSON-RPC

Number of APIs: 10

A collection holding the Core Blockchain JSON RPC API calls.

Abstract

Boids created by the current generation of Core clients expose remote procedure call (RPC) methods.

Specification

RFC-2119

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC-2119.

JSON-RPC

Communication with Boids is accomplished using JSON-RPC, a stateless, lightweight remote procedure call protocol that uses JSON as its data format. Core RPC methods MUST be called using JSON-RPC request objects and MUST respond with JSON-RPC response objects.

Error codes

If an Core RPC method encounters an error, the error member included on the response object MUST be an object containing a code member and descriptive message member. The following list contains all possible error codes and associated messages:

CodeMessageMeaningCategory
-32700Parse errorInvalid JSONstandard
-32600Invalid requestJSON is not a valid request objectstandard
-32601Method not foundMethod does not existstandard
-32602Invalid paramsInvalid method parametersstandard
-32603Internal errorInternal JSON-RPC errorstandard
-32000Invalid inputMissing or invalid parametersnon-standard
-32001Resource not foundRequested resource not foundnon-standard
-32002Resource unavailableRequested resource not availablenon-standard
-32003Transaction rejectedTransaction creation failednon-standard
-32004Method not supportedMethod is not implementednon-standard
-32005Limit exceededRequest exceeds defined limitnon-standard
-32006JSON-RPC version not supportedVersion of JSON-RPC protocol is not supportednon-standard
  1. db - getHex POST {{ENVIRONMENT}}

  2. personal - sign POST {{ENVIRONMENT}}

  3. shh - getMessages POST {{ENVIRONMENT}}

  4. xcb - submitHashrate POST {{ENVIRONMENT}}

  5. admin - stopWS POST {{ENVIRONMENT}}

  6. miner - setCoreBase POST {{ENVIRONMENT}}

  7. txpool - status POST {{ENVIRONMENT}}

  8. debug - writeMemProfile POST {{ENVIRONMENT}}

  9. web3 - sha3 POST {{ENVIRONMENT}}

  10. net - listening POST {{ENVIRONMENT}}