Monero API docs

Notes

This docs are build with Slate which doesn't support nesting objects. To overcome this limitation all nested structures are described in hierarchical order, one after another.

Let's take getbans call for example. The nested version of its response would be a 2-level deep list:

• bans - List of banned nodes:
  • ip - unsigned int; Banned IP address, in Int format.
  • seconds - unsigned int; Local Unix time that IP is banned until.
• status - string; General RPC error code. "OK" means everything looks good.

Instead, an ip list item description will be given right after after the root object description

Parameter	Type	Description
bans	array	List of banned nodes(see below)
status	string	General RPC error code. "OK" means everything looks good.

bans[] field structure

Parameter	Type	Description
ip	unsigned int	Banned IP address, in Int format.
seconds	unsigned int	Local Unix time that IP is banned until.

[] in the in the bans[] filed name means a list of objects under the bans key(primitive data types doesn't contrusct nested objects).

If objects are more than 2 levels deep, than .(dot) is used to denote parent - children relationship. For example: miner_tx.vout[].target (See getblock call), what reads as target filed in the each entry of the vout array under the miner_tx key.

A JavaScript terminology is used to describe data types, hence array and object.

Building

You're going to need:

• Linux or OS X — Windows may work, but is unsupported.
• Ruby, version 2.3.1 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Building:

bundle exec middleman build --clean

Running develpment server:

# either run this to run locally
bundle install
bundle exec middleman server

You can now see the docs at http://localhost:4567

Use deploy.sh for deploying

Checkout Slate README and Wiki for more detailed instructions