API Reference

TODO: break this out into a separate space, organizing the methods by category.

Raylz Native

Returns array of all accounts owned by the client.

post
Responses
200
OK
application/json
post
POST /eth_accounts HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the number of most recent block.

post
Responses
200
OK
application/json
post
POST /eth_blockNumber HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Executes a new message call immediately without creating a transaction on the block chain.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_call","params":[{ "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567" }, "latest"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_call HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_estimateGas","params":[{ "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567" }, "latest"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_estimateGas HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the current gas price in the default EVM denomination parameter.

post
Responses
200
OK
application/json
post
POST /eth_gasPrice HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the balance of the account of given address.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getBalance","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1", "latest"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getBalance HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns information about a block by hash.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getBlockByHash","params":["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae", false],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getBlockByHash HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns information about a block by block number.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getBlockByNumber","params":["0x1b4", true],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getBlockByNumber HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the number of transactions sent from an address.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getTransactionCount","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1","latest"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getBlockTransactionCountByHash HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

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

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getBlockTransactionCountByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getBlockTransactionCountByNumber HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns code at a given address.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getCode HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Polling method for a filter, which returns an array of logs which occurred since last poll.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getFilterChanges","params":["0x16"],"id":73}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getFilterChanges HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns an array of all logs matching filter with given id.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getFilterLogs","params":["0x16"],"id":74}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getFilterLogs HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns an array of all logs matching a given filter object.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getLogs","params":[{"topics":["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]}],"id":74}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getLogs HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the value from a storage position at a given address.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getBalance","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1", "latest"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getStorageAt HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns information about a transaction by block hash and transaction index position.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getTransactionByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getTransactionByBlockHashAndIndex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns information about a transaction by block number and transaction index position.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getTransactionByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getTransactionByBlockNumberAndIndex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the information about a transaction requested by transaction hash.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getTransactionByHash","params":["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getTransactionByHash HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the value from a storage position at a given address.

post

Request body sample: {"jsonrpc":"2.0", "method": "/eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getTransactionCount HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the receipt of a transaction by transaction hash.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getTransactionReceipt","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getTransactionReceipt HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns information about a uncle of a block by hash and uncle index position.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getUncleByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getUncleByBlockHashAndIndex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns information about a uncle of a block by number and uncle index position.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getUncleByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getUncleByBlockNumberAndIndex HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

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

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getUncleCountByBlockHash HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the number of uncles in a block from a block matching the given block number.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_getUncleCountByBlockNumber","params":["0xe8"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_getUncleCountByBlockNumber HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Creates a filter in the node, to notify when a new block arrives.

post
Responses
200
OK
application/json
post
POST /eth_newBlockFilter HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Creates a filter object, based on filter options, to notify when the state changes (logs).

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_newFilter","params":[{ "fromBlock": "0x1", "toBlock": "0x2", "address": "0x8888f1f195afa192cfee860698584c030f4c9db1", "topics": ["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b", null, ["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x0000000000000000000000000aff3454fce5edbc8cca8697c15331677e6ebccc"]] }],"id":73}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_newFilter HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Creates a filter in the node, to notify when new pending transactions arrive.

post
Responses
200
OK
application/json
post
POST /eth_newPendingTransactionFilter HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Returns the current ethereum protocol version.

post
Responses
200
OK
application/json
post
POST /eth_protocolVersion HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Creates new message call transaction or a contract creation for signed transactions.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_sendRawTransaction","params":["0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_sendRawTransaction HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Creates new message call transaction or a contract creation, if the data field contains code.

post

Request body sample: { "id": 1, "jsonrpc": "2.0", "method": "/eth_sendTransaction", "params": [{ "from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155", "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675" }] }

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_sendTransaction HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

The sign method calculates an Ethereum specific signature with: sign(keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))).

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_sign","params":["0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", "0xdeadbeaf"],"id":1}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_sign HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

The sync status object may need to be different depending on the details of Tendermint's sync protocol. However, the 'synced' result is simply a boolean, and can easily be derived from Tendermint's internal sync state.

post
Responses
200
OK
application/json
post
POST /eth_syncing HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Uninstalls a filter with given id. Should always be called when watch is no longer needed.

post

Request body sample: {"jsonrpc":"2.0","method":"/eth_uninstallFilter","params":["0xb"],"id":73}

Body
idintegerOptional
jsonrpcstringOptional
methodstringOptional
Responses
200
OK
application/json
post
POST /eth_uninstallFilter HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "id": 1,
  "jsonrpc": "text",
  "method": "text",
  "params": []
}
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Raylz Transactions

Create Transaction

post
Body
wallet_idstring · min: 1Optional
passwordstring | nullableOptional
indexinteger · int32 | nullableOptional
Responses
200
OK
application/json
post
POST /transaction HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "wallet_id": "text",
  "password": "text",
  "index": 1,
  "transaction": {
    "to": "text",
    "data": "text",
    "value": "text"
  }
}
{
  "tx_hash": "text"
}
post
Responses
200
OK
application/json
post
POST /list_all_transfers HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Raylz Wallets

Get wallet List

get
Responses
200
OK
application/json
get
GET /wallet HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "type": "KEYSTORE_V3",
    "address": "text",
    "public_key": "text",
    "index": 1,
    "data": "text"
  }
]

Create new wallet

post
Body
typestring · enumRequiredPossible values:
passwordstring | nullableOptional
address_quantityinteger · int32Required
Responses
200
OK
application/json
post
POST /wallet HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "type": "KEYSTORE_V3",
  "password": "text",
  "address_quantity": 1
}
[
  {
    "id": "text",
    "type": "KEYSTORE_V3",
    "address": "text",
    "public_key": "text",
    "index": 1,
    "data": "text"
  }
]

Get wallet By Id

get
Path parameters
idstringRequired
Query parameters
indexinteger · int32Optional
Responses
200
OK
application/json
get
GET /wallet/{id} HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "type": "KEYSTORE_V3",
    "address": "text",
    "public_key": "text",
    "index": 1,
    "data": "text"
  }
]

Raylz Members

post
Responses
200
OK
application/json
post
POST /register_new_member HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /list_all_members HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}

Raylz Token Management

post
Responses
200
OK
application/json
post
POST /trasport_token HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /transport_token_with_data HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /transport_arbitrary_message HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /transfer_tokens HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /list_all_transports HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /deploy_new_contract HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /create_new_ERC20_token HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
post
Responses
200
OK
application/json
post
POST /create_new_ERC721_token HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "id": 1,
  "jsonrpc": "text",
  "result": "text"
}
PreviousDeploy a Smart Contract with RemixNextFAQ

Last updated