JSON-RPC endpoint
All API methods are available through this single endpoint using JSON-RPC 2.0 protocol. Send the method name in the method field and parameters as a dictionary in params. Useful for calling multiple methods in sequence or when JSON-RPC is preferred over REST.
API key header of the form X-API-Key: <token>, where <token> is the API key. Requests without a key are limited to 1 RPS. Refer to the authentication guide for details.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A JSON-RPC 2.0 request. Set method to the API method name (e.g., "getWalletInformation") and params to a dictionary of parameters.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/jsonRPC" \ -H "Content-Type: application/json" \ -d '{ "jsonrpc": "2.0", "id": "string", "method": "string", "params": {} }'{
"ok": true,
"result": {},
"@extra": "string",
"jsonrpc": "string",
"id": "string"
}{
"ok": false,
"code": 401,
"error": "API key does not exist"
}{
"ok": false,
"code": 403,
"error": "Network not allowed"
}{
"ok": false,
"code": 422,
"error": "params must contain an object"
}{
"ok": false,
"code": 429,
"error": "Ratelimit exceeded"
}{
"ok": false,
"code": 500,
"error": "Exit code <N> != 0"
}{
"ok": false,
"code": 504,
"error": "LITE_SERVER_NETWORK timeout"
}