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:
Code | Message | Meaning | Category |
---|---|---|---|
-32700 | Parse error | Invalid JSON | standard |
-32600 | Invalid request | JSON is not a valid request object | standard |
-32601 | Method not found | Method does not exist | standard |
-32602 | Invalid params | Invalid method parameters | standard |
-32603 | Internal error | Internal JSON-RPC error | standard |
-32000 | Invalid input | Missing or invalid parameters | non-standard |
-32001 | Resource not found | Requested resource not found | non-standard |
-32002 | Resource unavailable | Requested resource not available | non-standard |
-32003 | Transaction rejected | Transaction creation failed | non-standard |
-32004 | Method not supported | Method is not implemented | non-standard |
-32005 | Limit exceeded | Request exceeds defined limit | non-standard |
-32006 | JSON-RPC version not supported | Version of JSON-RPC protocol is not supported | non-standard |
-
db - getHex POST {{ENVIRONMENT}}
-
personal - sign POST {{ENVIRONMENT}}
-
shh - getMessages POST {{ENVIRONMENT}}
-
xcb - submitHashrate POST {{ENVIRONMENT}}
-
admin - stopWS POST {{ENVIRONMENT}}
-
miner - setCoreBase POST {{ENVIRONMENT}}
-
txpool - status POST {{ENVIRONMENT}}
-
debug - writeMemProfile POST {{ENVIRONMENT}}
-
web3 - sha3 POST {{ENVIRONMENT}}
-
net - listening POST {{ENVIRONMENT}}