v3 - ICON DevPortal

Search…
ICON JSON-RPC APIs (version 3) are interfaces to interact with ICON nodes. This document explains ICON JSON-RPC API (version 3) data structures, rules and the list of methods.
ICON JSON-RPC API v3 Specification
API Convention
Follows JSON-RPC 2.0 Specification.
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "$STRING1",
5
    "id": $INT,
6
    "params": {
7
        "$KEY1": "$VALUE1",
8
        "$KEY2": {
9
            "method": "$STRING2",
10
            "params": {
11
                "$KEY3": "$VALUE3"
12
            }
13
        }
14
    }
15
}
16
​
17
// Response - success
18
{
19
    "jsonrpc": "2.0",
20
    "id": $INT,
21
    "result": "$STRING"
22
    // or
23
    "result": {
24
      "$KEY1": "$VALUE1",
25
      "$KEY2": "$VALUE2"
26
    }
27
}
28
​
29
// Response - error
30
{
31
    "jsonrpc": "2.0",
32
    "id": $INT1,
33
    "error": {
34
        "code": $INT2,
35
        "message": "$STRING"
36
    }
37
}
Copied!
"KEY" naming follows camel case.
VALUE Types
Basically, every VALUE in JSON-RPC message is string. Below table shows the most common "VALUE types".
VALUE type
Description
Example
T_ADDR_EOA
"hx" + 40 digit HEX string
hxbe258ceb872e08851f1f59694dac2558708ece11
T_ADDR_SCORE
"cx" + 40 digit HEX string
cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32
T_HASH
"0x" + 64 digit HEX string
0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238
T_INT
"0x" + lowercase HEX string
0xa
T_BIN_DATA
"0x" + lowercase HEX string. Length must be even.
0x34b2
T_SIG
base64 encoded string
VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=
T_DATA_TYPE
Type of data
call, deploy, message or deposit
JSON-RPC Error Codes
This chapter explains the error codes used in ICON JSON-RPC API response.
Below table shows the default error messages for the error code. Actual message may vary depending on the implementation.
Error Codes
Error code
Message
Description
-32700
Parse error
Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.
-32600
Invalid Request
The JSON sent is not a valid Request object.
-32601
Method not found
The method does not exist / is not available.
-32602
Invalid params
Invalid method parameter(s).
-32603
Internal error
Internal JSON-RPC error.
-32000
Server error
IconServiceEngine internal error.
-32100
Score error
Score internal error.
Some error codes may change
JSON-RPC Error Response
1
{
2
    "jsonrpc": "2.0",
3
    "id": 1,
4
    "error": {
5
        "code": -32601,
6
        "message": "Method not found"
7
    }
8
}
Copied!
JSON-RPC API v3 ChangeLog
Fixed to conform to JSON-RPC 2.0 specification
Success response: result
Failure response: error
Removed additional response generated by loopchain such as "response_code" in SCORE's JSON-PRC Response.
v2: "result": {"response_code": "0x0", "response": "0x12345"}
v3: "result": "0x12345"
Fixed inconsistent KEY naming in v2 API
v2: icx_getBlockByHeight: "time_stamp"
v2: icx_sendTransaction: "timestamp"
v3: "timestamp"
Fixed inconsistent VALUE format in v2 API
timestamp
v2: icx_sendTransaction: "timestamp": "1234567890"
v2: icx_getBlockByHeight: "timestamp": 1234567890
v3: "timestamp": "0x499602d2"
hash
v2: icx_getBlockByHash: "hash": "af5570f5a1810b7af78caf4bc70a660f0df51e42baf91d4de5b2328de0e83dfc"
v3: "hash": "0xaf5570f5a1810b7af78caf4bc70a660f0df51e42baf91d4de5b2328de0e83dfc"
KEY naming follows camel case.
v2: "data_type"
v3: "dataType"
Removed tx_hash from the icx_sendTransaction message.
JSON-RPC APIs
For multichannel requests, add /<channel_name> at the end of the API path.
Main API
API path : <scheme>://<host>/api/v3
​icx_getLastBlock​
​icx_getBlockByHeight​
​icx_getBlockByHash​
​icx_call​
​icx_getBalance​
​icx_getScoreApi​
​icx_getTotalSupply​
​icx_getTransactionResult​
​icx_getTransactionByHash​
​icx_sendTransaction​
IISS API
API path : <scheme>://<host>/api/v3
​setStake​
​getStake​
​setDelegation​
​getDelegation​
​setBonderList​
​getBonderList​
​setBond​
​getBond​
​claimIScore​
​queryIScore​
​registerPRep​
​unregisterPRep​
​setPRep​
​setGovernanceVariables​
​getPRep​
​getPReps​
​getScoreOwner​
​setScoreOwner​
Debug API
API path : <scheme>://<host>/api/v3d
​debug_estimateStep​
Other API
API path : <scheme>://<host>/api/v3
​ise_getStatus​
​rep_getList​
JSON-RPC Methods
icx_getLastBlock
Returns the last block information.
Parameters
None
Returns
Block data
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getLastBlock",
5
    "id": 1234
6
}
7
​
8
// Response - success
9
{
10
    "jsonrpc": "2.0",
11
    "id": 1234,
12
    "result": {
13
        "version": "0.1a",  // NOTE: Block data itself still uses ICON JSON-RPC v2 representation. This will be fixed in the future.
14
        "prev_block_hash": "48757af881f76c858890fb41934bee228ad50a71707154a482826c39b8560d4b",
15
        "merkle_tree_root_hash": "fabc1884932cf52f657475b6d62adcbce5661754ff1a9d50f13f0c49c7d48c0c",
16
        "time_stamp": 1516498781094429,
17
        "confirmed_transaction_list": [  // Transaction data could be either v2 or v3 depending on its original request
18
            {
19
                "version": "0x3",
20
                "from": "hxbe258ceb872e08851f1f59694dac2558708ece11",
21
                "to": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32",
22
                "value": "0xde0b6b3a7640000",
23
                "stepLimit": "0x12345",
24
                "timestamp": "0x563a6cf330136",
25
                "nid": "0x3",
26
                "nonce": "0x1",
27
                "signature": "VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=",
28
                "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
29
                "dataType": "call",
30
                "data": {
31
                    "method": "transfer",
32
                    "params": {
33
                        "to": "hxab2d8215eab14bc6bdd8bfb2c8151257032ecd8b",
34
                        "value": "0x1"
35
                    }
36
                }
37
            }
38
        ],
39
        "block_hash": "1fcf7c34dc875681761bdaa5d75d770e78e8166b5c4f06c226c53300cbe85f57",
40
        "height": 3,
41
        "peer_id": "hx86aba2210918a9b116973f3c4b27c41a54d5dafe",
42
        "signature": "MEQCICT8mTIL6pRwMWsJjSBHcl4QYiSgG8+0H3U32+05mO9HAiBOhIfBdHNm71WpAZYwJWwQbPVVXFJ8clXGKT3ScDWcvw=="
43
    }
44
}
Copied!
icx_getBlockByHeight
Returns block information by block height.
Parameters
KEY
VALUE type
Description
height
T_INT
Integer of a block height
Returns
Block data
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getBlockByHeight",
5
    "id": 1234,
6
    "params": {
7
        "height": "0x3"
8
    }
9
}
10
​
11
// Response - success
12
{
13
    "jsonrpc": "2.0",
14
    "id": 1234,
15
    "result": {
16
        "version": "0.1a",  // NOTE: Block data itself still uses ICON JSON-RPC v2 representation. This will be fixed in the future.
17
        "prev_block_hash": "48757af881f76c858890fb41934bee228ad50a71707154a482826c39b8560d4b",
18
        "merkle_tree_root_hash": "fabc1884932cf52f657475b6d62adcbce5661754ff1a9d50f13f0c49c7d48c0c",
19
        "time_stamp": 1516498781094429,
20
        "confirmed_transaction_list": [  // Transaction data could be either v2 or v3 depending on its original request
21
            {
22
                "version": "0x3",
23
                "from": "hxbe258ceb872e08851f1f59694dac2558708ece11",
24
                "to": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32",
25
                "value": "0xde0b6b3a7640000",
26
                "stepLimit": "0x12345",
27
                "timestamp": "0x563a6cf330136",
28
                "nid": "0x3",
29
                "nonce": "0x1",
30
                "signature": "VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=",
31
                "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
32
                "dataType": "call",
33
                "data": {
34
                    "method": "transfer",
35
                    "params": {
36
                        "to": "hxab2d8215eab14bc6bdd8bfb2c8151257032ecd8b",
37
                        "value": "0x1"
38
                    }
39
                }
40
            }
41
        ],
42
        "block_hash": "1fcf7c34dc875681761bdaa5d75d770e78e8166b5c4f06c226c53300cbe85f57",
43
        "height": 3,
44
        "peer_id": "hx86aba2210918a9b116973f3c4b27c41a54d5dafe",
45
        "signature": "MEQCICT8mTIL6pRwMWsJjSBHcl4QYiSgG8+0H3U32+05mO9HAiBOhIfBdHNm71WpAZYwJWwQbPVVXFJ8clXGKT3ScDWcvw=="
46
    }
47
}
48
​
49
// Response - error
50
{
51
    "jsonrpc": "2.0",
52
    "id": 1234,
53
    "error": {
54
        "code": -32602,
55
        "message": "Invalid params height"
56
    }
57
}
Copied!
icx_getBlockByHash
Returns block information by block hash.
Parameters
KEY
VALUE type
Description
hash
T_HASH
Hash of a block
Returns
Block data
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getBlockByHash",
5
    "id": 1234,
6
    "params": {
7
        "hash": "0x1fcf7c34dc875681761bdaa5d75d770e78e8166b5c4f06c226c53300cbe85f57"
8
    }
9
}
10
​
11
// Response - success
12
{
13
    "jsonrpc": "2.0",
14
    "id": 1234,
15
    "result": {
16
        "version": "0.1a",  // NOTE: Block data itself still uses ICON JSON-RPC v2 representation. This will be fixed in the future.
17
        "prev_block_hash": "48757af881f76c858890fb41934bee228ad50a71707154a482826c39b8560d4b",
18
        "merkle_tree_root_hash": "fabc1884932cf52f657475b6d62adcbce5661754ff1a9d50f13f0c49c7d48c0c",
19
        "time_stamp": 1516498781094429,
20
        "confirmed_transaction_list": [  // Transaction data could be either v2 or v3 depending on its original request
21
            {
22
                "version": "0x3",
23
                "from": "hxbe258ceb872e08851f1f59694dac2558708ece11",
24
                "to": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32",
25
                "value": "0xde0b6b3a7640000",
26
                "stepLimit": "0x12345",
27
                "timestamp": "0x563a6cf330136",
28
                "nid": "0x3",
29
                "nonce": "0x1",
30
                "signature": "VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=",
31
                "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
32
                "dataType": "call",
33
                "data": {
34
                    "method": "transfer",
35
                    "params": {
36
                        "to": "hxab2d8215eab14bc6bdd8bfb2c8151257032ecd8b",
37
                        "value": "0x1"
38
                    }
39
                }
40
            }
41
        ],
42
        "block_hash": "1fcf7c34dc875681761bdaa5d75d770e78e8166b5c4f06c226c53300cbe85f57",
43
        "height": 3,
44
        "peer_id": "hx86aba2210918a9b116973f3c4b27c41a54d5dafe",
45
        "signature": "MEQCICT8mTIL6pRwMWsJjSBHcl4QYiSgG8+0H3U32+05mO9HAiBOhIfBdHNm71WpAZYwJWwQbPVVXFJ8clXGKT3ScDWcvw=="
46
    }
47
}
48
​
49
// Response - error
50
{
51
    "jsonrpc": "2.0",
52
    "id": 1234,
53
    "error": {
54
        "code": -32602,
55
        "message": "Invalid params hash"
56
    }
57
}
Copied!
icx_call
Calls SCORE's external function.
Does not make state transition (i.e., read-only).
Parameters
KEY
VALUE type
Required
Description
from
T_ADDR_EOA
O
Message sender's address.
to
T_ADDR_SCORE
O
SCORE address that will handle the message.
height
T_INT
X
Integer of a block height
dataType
T_DATA_TYPE
O
call is the only possible data type.
data
T_DICT
O
See Parameters - data.
data.method
String
O
Name of the function.
data.params
T_DICT
O
Parameters to be passed to the function.
Returns
Values returned by the executed SCORE function.
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_call",
5
    "id": 1234,
6
    "params": {
7
        "from": "hxbe258ceb872e08851f1f59694dac2558708ece11", // TX sender address
8
        "to": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32",   // SCORE address
9
        "dataType": "call",
10
        "data": {
11
            "method": "get_balance", // SCORE external function
12
            "params": {
13
                "address": "hx1f9a3310f60a03934b917509c86442db703cbd52" // input parameter of "get_balance"
14
            }
15
        }
16
    }
17
}
18
​
19
// Response - success
20
{
21
    "jsonrpc": "2.0",
22
    "id": 1234,
23
    "result": "0x2961fff8ca4a62327800000"
24
}
25
​
26
// Response - error
27
{
28
    "jsonrpc": "2.0",
29
    "id": 1234,
30
    "error": {
31
        "code": -32601,
32
        "message": "Method not found"
33
    }
34
}
35
​
36
// Response - error
37
{
38
    "jsonrpc": "2.0",
39
    "id": 1234,
40
    "error": {
41
        "code": -32602,
42
        "message": "Invalid params"
43
    }
44
}
Copied!
icx_getBalance
Returns the ICX balance of the given EOA or SCORE.
Parameters
KEY
VALUE type
Requried
Description
address
T_ADDR_EOA or T_ADDR_SCORE
O
Address of EOA or SCORE
height
T_INT
X
Integer of a block height
Returns
Number of ICX coins.
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getBalance",
5
    "id": 1234,
6
    "params": {
7
        "address": "hxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32"
8
    }
9
}
10
​
11
// Response - success
12
{
13
    "jsonrpc": "2.0",
14
    "id": 1234,
15
    "result": "0xde0b6b3a7640000"
16
}
17
​
18
// Response - error
19
{
20
    "jsonrpc": "2.0",
21
    "id": 1234,
22
    "error": {
23
        "code": -32602,
24
        "message": "Invalid address"
25
    }
26
}
Copied!
icx_getScoreApi
Returns SCORE's external API list.
Parameters
KEY
VALUE type
Requried
Description
address
T_ADDR_SCORE
O
SCORE address to be examined
height
T_INT
X
Integer of a block height
Returns
Fields containing information about the function
KEY
VALUE type
Description
type
String
function, fallback, or eventlog
name
String
function name
inputs
T_LIST(T_DICT)
parameters in array - name : parameter - nametype : parameter type (int, str, bytes, bool, Address) - indexed : 0x1 if the parameter is indexed (when this is eventlog)
outputs
T_LIST(T_DICT)
return value - type : return value type (int, str, bytes, bool, Address, dict, list)
readonly
T_INT
0x1 if this is declared as external(readonly=True)
payable
T_INT
0x1 if this has payable decorator
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getScoreApi",
5
    "id": 1234,
6
    "params": {
7
        "address": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32"  // SCORE address
8
    }
9
}
10
​
11
// Response - success
12
{
13
    "jsonrpc": "2.0",
14
    "id": 1234,
15
    "result": [
16
        {
17
            "type": "function",
18
            "name": "balanceOf",
19
            "inputs": [
20
                {
21
                    "name": "_owner",
22
                    "type": "Address"
23
                }
24
            ],
25
            "outputs": [
26
                {
27
                    "type": "int"
28
                }
29
            ],
30
            "readonly": "0x1"
31
        },
32
        {
33
            "type": "eventlog",
34
            "name": "FundTransfer",
35
            "inputs": [
36
                {
37
                    "name": "backer",
38
                    "type": "Address",
39
                    "indexed": "0x1"
40
                },
41
                {
42
                    "name": "amount",
43
                    "type": "int",
44
                    "indexed": "0x1"
45
                },
46
                {
47
                    "name": "is_contribution",
48
                    "type": "bool",
49
                    "indexed": "0x1"
50
                }
51
            ]
52
        },
53
        {...}
54
    ]
55
}
56
​
57
// Response - error
58
{
59
    "jsonrpc": "2.0",
60
    "id": 1234,
61
    "error": {
62
        "code": -32602,
63
        "message": "Invalid address"
64
    }
65
}
Copied!
icx_getTotalSupply
Returns total ICX coin supply that has been issued.
Parameters
KEY
VALUE type
Required
Description
height
T_INT
X
Integer of a block height
Returns
Total number of ICX coins issued.
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getTotalSupply",
5
    "id": 1234
6
}
7
​
8
// Response - success
9
{
10
    "jsonrpc": "2.0",
11
    "id": 1234,
12
    "result": "0x2961fff8ca4a62327800000"
13
}
Copied!
icx_getTransactionResult
Returns the transaction result requested by transaction hash.
Parameters
KEY
VALUE type
Description
txHash
T_HASH
Hash of the transaction
Returns
KEY
VALUE type
Description
status
T_INT
0x1 on success, 0x0 on failure.
to
T_ADDR_EOA or T_ADDR_SCORE
Recipient address of the transaction
failure
T_DICT
This field exists when status is 0x1. Contains code(string) and message(string).
txHash
T_HASH
Transaction hash
txIndex
T_INT
Transaction index in the block
blockHeight
T_INT
Height of the block that includes the transaction.
blockHash
T_HASH
Hash of the block that includes the transation.
cumulativeStepUsed
T_INT
Sum of stepUsed by this transaction and all preceeding transactions in the same block.
stepUsed
T_INT
The amount of step used by this transaction.
stepPrice
T_INT
The step price used by this transaction.
scoreAddress
T_ADDR_SCORE
SCORE address if the transaction created a new SCORE. (optional)
eventLogs
T_ARRAY
Array of eventlogs, which this transaction generated.
logsBloom
T_BIN_DATA
Bloom filter to quickly retrieve related eventlogs.
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getTransactionResult",
5
    "id": 1234,
6
    "params": {
7
        "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
8
    }
9
}
10
​
11
// Response - success
12
{
13
    "jsonrpc": "2.0",
14
    "id": 1234,
15
    "result": {
16
        "status": "0x1",
17
        "to": "cx4d6f646441a3f9c9b91019c9b98e3c342cceb114",
18
        "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
19
        "txIndex": "0x1",
20
        "blockHeight": "0x1234",
21
        "blockHash": "0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
22
        "cumulativeStepUsed": "0x1234",
23
        "stepUsed": "0x1234",
24
        "stepPrice": "0x5678",
25
        "scoreAddress": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32",
26
        "eventLogs":[
27
            {
28
                "scoreAddress": "cx4d6f646441a3f9c9b91019c9b98e3c342cceb114",
29
                "indexed": [
30
                    "Transfer(Address,Address,int)",
31
                    "hx4873b94352c8c1f3b2f09aaeccea31ce9e90bd31",
32
                    "hx0000000000000000000000000000000000000000",
33
                    "0x8ac7230489e80000"
34
                ],
35
                "data":[]
36
            }
37
        ],
38
        "logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000002000000000021000000000000000000000000000000000000000000000000003000000000031400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000"
39
    }
40
}
41
​
42
// Response - failed tx
43
{
44
    "jsonrpc": "2.0",
45
    "id": 1234,
46
    "result": {
47
        "status": "0x0",
48
        "failure": {
49
            "code": "0x7d00",
50
            "message": "Out of balance"
51
        },
52
        "to": "cx4d6f646441a3f9c9b91019c9b98e3c342cceb114",
53
        "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
54
        "txIndex": "0x1",
55
        "blockHeight": "0x1234",
56
        "blockHash": "0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
57
        "cumulativeStepUsed": "0x1234",
58
        "stepUsed": "0x1234",
59
        "stepPrice": "0x5678"
60
    }
61
}
62
​
63
// Response - error (invalid txHash was given)
64
{
65
    "jsonrpc": "2.0",
66
    "id": 1234,
67
    "error": {
68
        "code": -32602,
69
        "message": "Invalid txHash"
70
    }
71
}
72
​
73
// Response - pending tx
74
{
75
    "jsonrpc": "2.0",
76
    "id": 1234,
77
    "error": {
78
        "code": -32602,
79
        "message": "Pending transaction"
80
    }
81
}
Copied!
icx_getTransactionByHash
Returns the transaction information requested by transaction hash.
Parameters
KEY
VALUE type
Description
txHash
T_HASH
Hash of the transaction
Returns
KEY
VALUE type
Description
version
T_INT
Protocol version (0x3 for V3)
from
T_ADDR_EOA
EOA address that created the transaction
to
T_ADDR_EOA or T_ADDR_SCORE
EOA address to receive coins, or SCORE address to execute the transaction.
value
T_INT
Amount of ICX coins in loop to transfer. When ommitted, assumes 0. (1 icx = 1 ^ 18 loop)
stepLimit
T_INT
Maximum step allowance that can be used by the transaction.
timestamp
T_INT
Transaction creation time. timestamp is in microsecond.
nid
T_INT
Network ID
nonce
T_INT
An arbitrary number used to prevent transaction hash collision.
txHash
T_HASH
Transaction hash
txIndex
T_INT
Transaction index in a block. Null when it is pending.
blockHeight
T_INT
Block height where this transaction was in. Null when it is pending.
blockHash
T_HASH
Hash of the block where this transaction was in. Null when it is pending.
signature
T_SIG
Signature of the transaction.
dataType
T_DATA_TYPE
Type of data. (call, deploy, or message)
data
T_DICT or String
Contains various type of data depending on the dataType. See Parameters - data.
Example
1
// Request
2
{
3
    "jsonrpc": "2.0",
4
    "method": "icx_getTransactionByHash",
5
    "id": 1234,
6
    "params": {
7
        "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"
8
    }
9
}
10
​
11
// Response - coin transfer
12
{
13
    "jsonrpc": "2.0",
14
    "id": 1234,
15
    "result": {
16
        "version": "0x3",
17
        "from": "hxbe258ceb872e08851f1f59694dac2558708ece11",
18
        "to": "hx5bfdb090f43a808005ffc27c25b213145e80b7cd",
19
        "value": "0xde0b6b3a7640000",
20
        "stepLimit": "0x12345",
21
        "timestamp": "0x563a6cf330136",
22
        "nid": "0x3",
23
        "nonce": "0x1",
24
        "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
25
        "txIndex": "0x1",
26
        "blockHeight": "0x1234",
27
        "blockHash": "0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
28
        "signature": "VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA="
29
    }
30
}
31
​
32
// Response - SCORE function call
33
{
34
    "jsonrpc": "2.0",
35
    "id": 1234,
36
    "result": {
37
        "version": "0x3",
38
        "from": "hxbe258ceb872e08851f1f59694dac2558708ece11",
39
        "to": "cxb0776ee37f5b45bfaea8cff1d8232fbb6122ec32",
40
        "stepLimit": "0x12345",
41
        "timestamp": "0x563a6cf330136",
42
        "nid": "0x3",
43
        "nonce": "0x1",
44
        "txHash": "0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
45
        "txIndex": "0x1",
46
        "blockHeight": "0x1234",
47
        "blockHash": "0xc71303ef8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238",
48
        "signature": "VAia7YZ2Ji6igKWzjR2YsGa2m53nKPrfK7uXYW78QLE+ATehAVZPC40szvAiA6NEU5gCYB4c4qaQzqDh2ugcHgA=",
49
        "dataType": "call",
50
        "data": {
51
            "method": "transfer",
52
            "params": {
53
                "to": "hxab2d8215eab14bc6bdd8bfb2c8151257032ecd8b",
54
                "value": "0x1"
55
            }
56
        }
57
    }
58
}
59
​
60
// Response - error
61
{
62
    "jsonrpc": "2.0",
63
    "id": 1234,
64
    "error": {
65
        "code": -32602,
66
        "message": "Invalid params txHash"
67
    }
68
}
Copied!
icx_sendTransaction
You can do one of the followings using this method.
Transfer designated amount of ICX coins from 'from' address to 'to' address.
Install a new SCORE.
Update the SCORE in the 'to' address.
Invoke a function of the SCORE in the 'to' address.
Transfer a message.
This function causes state transitions.
Parameters
KEY
VALUE type
Required
Description
version
T_INT
O
Protocol version (0x3 for V3)
from
T_ADDR_EOA
O
EOA address that created the transaction
to
T_ADDR_EOA or T_ADDR_SCORE
O
EOA address to receive coins, or SCORE address to execute the transaction.
value
T_INT
X
Amount of ICX coins in loop to transfer. When omitted, assumes 0. (1 icx = 1 ^ 18 loop)
stepLimit
T_INT
O
Maximum step allowance that can be used by the transaction.
timestamp
T_INT
O
Transaction creation time. timestamp is in microsecond.
nid
T_INT
O