JSON-RPC description
Our JSON-RPC interface is conceptually based on XML-RPC but addresses some of its shortcomings for easier use.
The name of the called method is the path in the URL, so for example calling the items method is written as /items.
Calling options
This JSON-RPC server allows calling methods in several ways:
- HTTP GET - basic method call. Method parameters are passed as GET parameters.
- HTTP GET - JSONP - when calling from JS you can use JSONP, where the callback can be specified in the
_, _callback, or callback parameter. When the call includes one of these parameters, the response is automatically returned via JSONP. More about JSONP on Wikipedia.
- HTTP POST - method call parameters are sent via POST as form values. Values sent by POST are processed when they arrive with the HTTP header
Content-Type: application/x-www-form-urlencoded.
- HTTP POST JSON/BSON - parameters are passed as a JSON/BSON object where keys are the call parameters. To process parameters you need to send the HTTP header
application/json, text/json, or text/plain for JSON and application/bson for BSON.
Response format
The interface responds either with JSON or BSON depending on the Accept HTTP header. The default response format is JSON.
The response always contains an object with keys status and status_message. Status is a numeric completion state similar to HTTP status codes, but may differ where no corresponding HTTP status exists. Status_message contains a text description of the call result. For a successful call the response is {"status":200, "status_message": "OK"}.
If the call returns data, the root object also contains a key with the name of the called method.
Example:
GET /system_list_methods HTTP/1.0
User-Agent: curl/7.37.1
Host: dummy.grandit.cz:1200
Accept: */*
HTTP/1.1 200 OK
Content-Type: application/json
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: Reply-OK-Only
Connection: Close
Content-Length: __
{
"status_message": "OK",
"system_list_methods": [
"system_alive",
"system_list_methods",
"system_method_help",
"system_method_info",
"system_method_sig",
"system_multicall",
"system_status",
],
"status": 200
}
How to use this tool
If you enter the address of our RPC interface in the input field, you can load its configuration by clicking the button. Loading the interface configuration loads both method signatures and help. Using this interface you can also call individual methods and view the return values.
Legend
Parameters
Data types
any
Choice from the options below; if none are given, it means anything.
time
Standard 24-hour time format, always zero-padded to 2 digits. Seconds may have decimal places (after a dot), e.g. 13:01:15.4589.
datetime date
String in ISO-8601 format.
int
Integer of unlimited length.
float
Floating-point number with precision up to 15 decimal places.
decimal
Fixed-point decimal number.
bool
Boolean values True/False.
list
Ordered sequence of data written with square brackets ([]) and commas (,).
enum
Set of symbolic names (members) bound to unique values.
dict
Unordered sequence of data written with curly braces ({}), in the form {key:value}.
uuid
Universally unique identifier generated using random numbers. Version 4.