Skip to content

API JSON RPC HTTP

Jump to bottom
MaTaXeToS edited this page Oct 20, 2020 · 8 revisions

Contents

JSON RPC API

JSON is a lightweight data-interchange format. It can represent numbers, strings, ordered sequences of values, and collections of name/value pairs.

JSON-RPC is a stateless, light-weight remote procedure call (RPC) protocol. Primarily this specification defines several data structures and the rules around their processing. It is transport agnostic in that the concepts can be used within the same process, over sockets, over HTTP, or in many various message passing environments. It uses JSON (RFC 4627) as data format.

JSON-RPC Endpoint

Default JSON-RPC endpoints:

Client URL
HTTP http://NODE_IP:NODE_PORT/api/

HTTP

You can start use the HTTP JSON-RPC visit url ex.

http://NODE_IP:NODE_PORT/api/?method=net_version
http://NODE_IP:NODE_PORT/api/?method=getBalance&wallet=J4F00000000000000000000000000000000000000000000000000000000

url Info

The examples also do not include the DOMAIN/IP & port combination which must be the last argument given to curl e.x. 127.0.0.1:6969 domain:6969

JSON-RPC methods

JSON RPC API Reference

node_version

Returns the current version of node.

Parameters

none

Returns

INTEGER - The current version.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_version","params":[],"id":1}'

// HTTP Request
http://NODE_IP:NODE_PORT/api/?id=1&method=node_version

// Result
{
  "id":1,
  "jsonrpc": "2.0",
  "result": "0.0.4"
}

node_network

Returns the current network.

Parameters

none

Returns

String - The current network.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_network","params":[],"id":2}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=2&method=node_network

// Result
{
  "id":2,
  "jsonrpc": "2.0",
  "result": "mainnet"
}

node_listening

Returns true if client is actively listening for network connections.

Parameters

none

Returns

Boolean - true when listening, otherwise false.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_listening","params":[],"id":3}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=3&method=node_listening

// Result
{
  "id":3,
  "jsonrpc":"2.0",
  "result":true
}

node_peerCount

Returns number of peers currently connected to the client.

Parameters

none

Returns

INTEGER - integer of the number of connected peers.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_peerCount","params":[],"id":4}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=4&method=node_peerCount

// Result
{
  "id":4,
  "jsonrpc": "2.0",
  "result": "5"
}

node_syncing

Returns an object with data about the sync status or false.

Parameters

none

Returns

Object|Boolean, An object with sync status data or FALSE, when not syncing:

  • currentBlock: INTEGER - The current block, same as j4f_blockNumber
  • highestBlock: INTEGER - The estimated highest block
Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_syncing","params":[],"id":5}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=5&method=node_syncing

Result syncing

{
  "id":5,
  "jsonrpc": "2.0",
  "result": {
    "currentBlock": '728',
    "highestBlock": '1202'
  }
}

Result Not syncing

{
  "id":5,
  "jsonrpc": "2.0",
  "result": false
}

node_mining

Returns true if client is actively mining new blocks.

Parameters

none

Returns

Boolean - returns true of the client is mining, otherwise false.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_mining","params":[],"id":6}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=6&method=node_mining

// Result
{
  "id":6,
  "jsonrpc": "2.0",
  "result": true
}

node_hashrate

Returns the number of hashes per second that the node is mining with.

Parameters

none

Returns

INTEGER - number of hashes per second.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"node_hashrate","params":[],"id":7}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=7&method=node_hashrate

// Result
{
  "id":7,
  "jsonrpc": "2.0",
  "result": "1001231"
}

j4f_coinbase

Returns the client coinbase address.

Parameters

none

Returns

String, the current coinbase address.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_coinbase","params":[],"id":8}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=8&method=j4f_coinbase

// Result
{
  "id":8,
  "jsonrpc": "2.0",
  "result": "J4F00000000000000000000000000000000000000000000000000000000"
}

j4f_accounts

Returns a list of addresses owned by client.

Parameters

none

Returns

Array of STRING, - addresses owned by the client.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_accounts","params":[],"id":9}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=9&method=j4f_accounts

// Result
{
  "id":9,
  "jsonrpc": "2.0",
  "result": ["J4F00000000000000000000000000000000000000000000000000000000"]
}

j4f_addAccount

Create new wallet

Parameters
  1. STRING - Password
params: [
   "password":"example_password"
]
Returns

Object - A block object, or null when no block was found:

  • wallet: STRING - the wallet address.
  • public: STRING, Public key of wallet.
  • private: STRING, Private key of wallet.
Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_addAccount","params":["password":"example_password"],"id":10}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=10&method=j4f_addAccount&password=example_password

// Result
{
  "id":10,
  "jsonrpc": "2.0",
  "result": {
      "wallet":J4F00000000000000000000000000000000000000000000000000000000",
      "public":"PUBLIC KEY....",
      "private":"PRIVATE KEY...."
  }
}

j4f_blockNumber

Returns the number of most recent block.

Parameters

none

Returns

INTEGER - integer of the current block number the client is on.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_blockNumber","params":[],"id":11}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=11&method=j4f_blockNumber

// Result
{
  "id":11,
  "jsonrpc": "2.0",
  "result": "94"
}

j4f_getBalance

Returns the balance of the account of given address.

Parameters
  1. STRING - address to check for balance.
params: [
   "wallet":"J4F00000000000000000000000000000000000000000000000000000000"
]
Returns

INTEGER - integer of the current balance in wei.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getBalance","params":["wallet":"J4F00000000000000000000000000000000000000000000000000000000"],"id":12}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=12&method=j4f_getBalance&wallet=J4F00000000000000000000000000000000000000000000000000000000

// Result
{
  "id":12,
  "jsonrpc": "2.0",
  "result": "1236749512346779.12412440"
}

j4f_getPendingBalance

Returns the pending balance of the account of given address.

Parameters
  1. STRING - address to check for balance.
params: [
   "wallet":"J4F00000000000000000000000000000000000000000000000000000000"
]
Returns

INTEGER - integer of the current balance in wei.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getPendingBalance","params":["wallet":"J4F00000000000000000000000000000000000000000000000000000000"],"id":13}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=13&method=j4f_getPendingBalance&wallet=J4F00000000000000000000000000000000000000000000000000000000

// Result
{
  "id":13,
  "jsonrpc": "2.0",
  "result": "1236749512346779.12412440"
}

j4f_getTransactionCount

Returns the number of transactions sent from an address.

Parameters
  1. STRING - address.
params: [
   "wallet":"J4F00000000000000000000000000000000000000000000000000000000"
]
Returns

Array INTEGER - integer of the number of transactions send from this address. STRING - integer of total amount of transactions send from this address.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getTransactionCount","params":["wallet":"J4F00000000000000000000000000000000000000000000000000000000"],"id":14}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=14&method=j4f_getTransactionCount&wallet=J4F00000000000000000000000000000000000000000000000000000000

// Result
{
  "id":14,
  "jsonrpc": "2.0",
  "result": [32,"7.99977350"]
}

j4f_getBlockTransactionCountByHash

Returns the number of transactions in a block from a block matching the given block hash.

Parameters
  1. STRING - hash of a block.
params: [
   "hash":"00005cd741f6691aaece42e0ede9ec66bd68098a47d7d1f72f4f953e3fe02773"
]
Returns

INTEGER - integer of the number of transactions in this block.

Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getBlockTransactionCountByHash","params":["hash":"00005cd741f6691aaece42e0ede9ec66bd68098a47d7d1f72f4f953e3fe02773"],"id":15}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=15&method=j4f_getBlockTransactionCountByHash&hash=00005cd741f6691aaece42e0ede9ec66bd68098a47d7d1f72f4f953e3fe02773

// Result
{
  "id":15,
  "jsonrpc": "2.0",
  "result": "15"
}

j4f_getBlockTransactionCountByNumber

Returns the number of transactions in a block matching the given block number.

Parameters
  1. INTEGER|TAG - integer of a block number, or the string "earliest", "latest" or "pending", as in the default block parameter.
params: [
   "height":"542"
]
Returns

INTEGER - integer of the number of transactions in this block.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getBlockTransactionCountByNumber","params":["height":"542"],"id":16}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=16&method=j4f_getBlockTransactionCountByNumber&height=542

// Result
{
  "id":16,
  "jsonrpc": "2.0",
  "result": "10"
}

j4f_sendTransaction

Creates new message call transaction

Parameters
  1. Object - The transaction object
  • from: STRING - The address the transaction is send from.
  • to: STRING - The address the transaction is directed to.
  • password: STRING - The password address from.
  • amount: INTEGER - Integer of the value sent with this transaction
params: [{
  "from": "J4F6eb3ed64d9bb395fc4b9cb63aae15b8d8e3a83520670bfd924c1ea49",
  "to": "J4Fcaab3a3087a4c5b3c30dba34adf1726b86c7ba24c96c4b859f6a8a26",
  "password": "PASSWORD_WALLET_FROM",
  "amount": "1"
}]
Returns

STRING - the transaction hash, or the zero hash if the transaction is not yet available.

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_sendTransaction","params":[{see above}],"id":17}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=17&method=j4f_sendTransaction&params...[{see above}]

// Result
{
  "id":17,
  "jsonrpc": "2.0",
  "result": "f2f54a0e6beac9d117c9c1d3287512947c2c17329ae4dd8b5bb89900fc70e499"
}

j4f_getBlockByHash

Returns information about a block by hash.

Parameters
  1. STRING - Hash of a block.
  2. Boolean - If true it returns the full transaction objects, if false only the hashes of the transactions.
params: [
   "hash":"0000cdd334c36ebc602462664b52c3d5df61f5e12b761695b164267bc789e0c5",
   "transactions":false
]
Returns

Object - A block object, or null when no block was found:

  • height: INTEGER - the block number. null when its pending block.
  • hash: STRING, hash of the block. null when its pending block.
  • parentHash: STRING, hash of the parent block.
  • nonce: INTEGER, Integer generated proof-of-work. null when its pending block.
  • transactionsRoot: STRING, the root of the transaction trie of the block.
  • miner: STRING, the address of the beneficiary to whom the mining rewards were given.
  • difficulty: INTEGER - integer of the difficulty for this block.
  • totalDifficulty: INTEGER - integer of the total difficulty of the chain until this block.
  • timestamp: INTEGER - the unix timestamp for when the block was collated.
  • transactions: Array - Array of transaction objects, or transaction hashes depending on the last given parameter.
Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getBlockByHash","params":["0000cdd334c36ebc602462664b52c3d5df61f5e12b761695b164267bc789e0c5", "transactions":false],"id":18}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=18&method=j4f_getBlockByHash&hash=5922fe670445cfa2d8c4bc903917d43aa77df6242024c974606d5ba9909d3e6b9e7112704f09cbe9bdd9faf1f3532ecf2faeeb23520aee22f360051ecaeb3059&transactions=0

// Result
{
   "id":"18",
   "jsonrpc":"2.0",
   "result":{
      "height":"100",
      "hash":"5922fe670445cfa2d8c4bc903917d43aa77df6242024c974606d5ba9909d3e6b9e7112704f09cbe9bdd9faf1f3532ecf2faeeb23520aee22f360051ecaeb3059",
      "parentHash":"d15adf91dc9a00fe2b7c8577535852e66b3e1d40196647bc09856fcf3a6eba613da88c9a1b14a770011e9193a9f2340119bb42f68abb832eea6efeb20f8cd81b",
      "nonce":"2858",
      "merkleRoot":"72dee7eca88831bf057d7fc5d79ac4e36c585d08cbe36dea9357795709eb72c494d15bebd784f34e2bb44936a1c997612c73d54c82f52ad4381669255212ee7d",
      "miner":"J4Ff994e3b5c49c7f41eee4e3a5b0e6621f846b00ddd5142f7d66c888e1",
      "difficulty":"1.46",
      "maxDifficulty":"000FFFFFF00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
      "timestamp":"1580868187",
      "transactions": [{...},{ ... }]
   }
}

j4f_getBlockByNumber

Returns information about a block by block number.

Parameters
  1. INTEGER|TAG - integer of a block number
  2. Boolean - If true it returns the full transaction objects, if false only the hashes of the transactions.
params: [
   "height":"100"
   "transactions":false
]
Returns

See j4f_getBlockByHash

Example
// JSON-RPC Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getBlockByNumber","params":["height":"100", "transactions":false],"id":19}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=19&method=j4f_getBlockByNumber&height=100&transactions=1

Result see j4f_getBlockByHash

j4f_getTransactionByHash

Returns the information about a transaction requested by transaction hash.

Parameters
  1. STRING - hash of a transaction
params: [
   "hash":"c4bf7d7aec6ba3d25bb8933623f8222489506d069c211c32b07a734416d93d43a662a29ad704eab78e473b51bf9ea3aad578d1595f5a3975595a9f1ae83c0389"
]
Returns

Object - A transaction object, or null when no transaction was found:

  • blockHash: STRING, hash of the block where this transaction was in. null when its pending.
  • blockHeight: STRING, height of the block where this transaction was in. null when its pending.
  • hash: STRING, hash of the transaction.
  • from: STRING address of the sender.
  • to: STRING, address of the receiver.
  • fee: INTEGER - transactions fee.
  • amount: INTEGER - value transferred.
  • signature: STRING - signature
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getTransactionByHash","params":["hash":"c4bf7d7aec6ba3d25bb8933623f8222489506d069c211c32b07a734416d93d43a662a29ad704eab78e473b51bf9ea3aad578d1595f5a3975595a9f1ae83c0389"],"id":20}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=20&method=j4f_getTransactionByHash&hash=c4bf7d7aec6ba3d25bb8933623f8222489506d069c211c32b07a734416d93d43a662a29ad704eab78e473b51bf9ea3aad578d1595f5a3975595a9f1ae83c0389

// Result
{
   "id":"20",
   "jsonrpc":"2.0",
   "result":{
      "blockHash":"e61eed040850ff6760324ee3afca27034c8c632e46cfde1a458c59aea8e3cab655f378215ef4536018aa329bee0049b6853bb649e17c0893597d991d7fc3e233",
      "blockHeight":17453,
      "hash":"c4bf7d7aec6ba3d25bb8933623f8222489506d069c211c32b07a734416d93d43a662a29ad704eab78e473b51bf9ea3aad578d1595f5a3975595a9f1ae83c0389",
      "from":"REWARD_MINER",
      "to":"J4Ff994e3b5c49c7f41eee4e3a5b0e6621f846b00ddd5142f7d66c888e1",
      "amount":"2.000000000000000000",
      "gasLimit":"21000",
      "gasPrice":"0.000000000000000000",
      "signature":"dUn2mH8lL12wAuRC21vkSP2L4jsCs+n7DqeM+4O4hNCEjlbfPcPbahzRqAwtg9JRWtZQef5ztmQvJCr7zexGW4iqJ446CjeeZy5Gzg6izs9lO9NayAnHJLiPmuQ4TAyKF3jYnOWnq7je6TDbaf+3NHeCbA1k2FXX1bSlInZNC4twcVxin0H2OSCj6EtRYHmc5\/jCpH4pyI6W4byrpp6AVXdGXxFbuAadmrCDP6vnJvUIqHhps4NStXVD8S\/fHZfkDvLrR3CWDGSEAYx9cb44GaP9oJENO9TDoYnBKAi4zgCKOYMxZ99N2gevPrxJJtap7Ndcs4me63Dbb3cqjckK+Q==",
      "data":"0x"
   }
}

j4f_sign

Check if cant sign this wallet with this password

Parameters
  1. STRING - Wallet to check sign
  2. STRING - Password of wallet
params: [
   "wallet":"J4F00000000000000000000000000000000000000000000000000000000",
   "password":"EXAMPLE_PASSWORD"
]
Returns

String - Message informing if it was possible to sign

Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_sign","params":["wallet":"J4F00000000000000000000000000000000000000000000000000000000","password":"EXAMPLE_PASSWORD"],"id":20}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=20&method=j4f_sign&wallet=J4F00000000000000000000000000000000000000000000000000000000&password=EXAMPLE_PASSWORD

// Result
{
  "jsonrpc":"2.0",
  "id":20,
  "result":{
    "ILPjd7CjCJj36NfoCg2ojY8gZyXSUKYCy3iiKn1H52WT+TZyMmgIwrVZ+BKNv+qQ1Qo+dmA46wi5X72L9jthKFnhbfRs/7xpQP8W9sglbrIRBhTZ0HqB70R6yg5flHgTAIPKKuO7QKW+5PYiQKaSsSztMaeryMe619BRyMeQI7/qRScc/AZUzshQdDqedjkb+2eiVNdQzvNn0oKQ5A0kt7Txd117vRXYxkkdcHl7WMTnBiwlyM0luTBSe6hGZRXD5MqOSj8p5zGKveIPzyxdbwX77e8KB/bLNuw8rGaZwdg2jYj9VjK1ILaiRsyhWi6HWvjLCpECY0QNlynbO4MDBw=="
  }
}

j4f_parse

Parse a string in hexadecimal

Parameters
  1. STRING - Data to parse
params: [
   "date":"This message will be parsed",
]
Returns

String - Data parsed in hexadecimal

Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_parse","params":["data":"This message will be parsed"],"id":21}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=21&method=j4f_parse&data=This+message+will+be+parsed

// Result
{
  "jsonrpc":"2.0",
  "id":21,
  "result":{
    "0x78da0bc9c82c56c84d2d2e4e4c4f5528cfccc951484a5528482c2a4e4d01008b8e09fc"
  }
}

j4f_getContractByHash

Return contract info by hash

Parameters
  1. STRING - Hash of contract
params: [
   "hash":"6f326172a9cf1a3e48ab1dc0cd61423a1ad7bb2e221a079f035608496042fbb49beac10ad825fa7a68c03c723773f043252d172de8bf804e12598c036222ce6b",
]
Returns

Object - A transaction object, or null when no transaction was found:

  • txnHash: STRING, hash of transaction who created the contract
  • contractHash: STRING, Hash of contract
  • code: STRING, Code parsed in hexadecimal
Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_getContractByHash","params":["hash":"6f326172a9cf1a3e48ab1dc0cd61423a1ad7bb2e221a079f035608496042fbb49beac10ad825fa7a68c03c723773f043252d172de8bf804e12598c036222ce6b"],"id":22}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=22&method=j4f_getContractByHash&hash=6f326172a9cf1a3e48ab1dc0cd61423a1ad7bb2e221a079f035608496042fbb49beac10ad825fa7a68c03c723773f043252d172de8bf804e12598c036222ce6b

// Result
{
  "jsonrpc":"2.0",
  "id":21,
  "result":{
	"txnHash":"883cce61cad69e45c3b....",
	"contractHash":"6f326172a9cf1a3e48....",
	"code":"0x78dacd5....."
  }
}

j4f_callReadFunctionContractByHash

Call a read function of contract

Parameters
  1. STRING - Hash of contract
  2. STRING - OPCode Call parsed in hexadecimal
params: [
   "hash":"6f326172a9cf1a3e48ab1dc0cd61423a1ad7bb2e221a079f035608496042fbb49beac10ad825fa7a68c03c723773f043252d172de8bf804e12598c036222ce6b",
   "data" "0x78da0bc9c82c56c84d2d2e4e4c4f5528cfccc951484a5528482c2a4e4d01008b8e09fc"
]
Returns

string - Return of function call parsed in hexadecimal

Example
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"j4f_callReadFunctionContractByHash","params":["hash":"6f326172a9cf1a3e48ab1dc0cd61423a1ad7bb2e221a079f035608496042fbb49beac10ad825fa7a68c03c723773f043252d172de8bf804e12598c036222ce6b","data":"0x78da0bc9c82c56c84d2d2e4e4c4f5528cfccc951484a5528482c2a4e4d01008b8e09fc"],"id":23}'

//HTTP Request
http://NODE_IP:NODE_PORT/api/?id=23&method=j4f_callReadFunctionContractByHash&hash=6f326172a9cf1a3e48ab1dc0cd61423a1ad7bb2e221a079f035608496042fbb49beac10ad825fa7a68c03c723773f043252d172de8bf804e12598c036222ce6b&data=0x78da0bc9c82c56c84d2d2e4e4c4f5528cfccc951484a5528482c2a4e4d01008b8e09fc

// Result
{
  "jsonrpc":"2.0",
  "id":23,
  "result": "0x6f326172a9cf1a3e48...."
}
Clone this wiki locally