Node

1. Get round history of a node
url：/v2/nodes/round-history?page_size=5&page_number=1
method：GET
Request Parameter
Type
Description
page_number
int
current page number, starting from 1
page_size
int
entries on each page
Example response
{
    "code": 0,
    "msg": "SUCCESS",
    "result": {
        "rnd_history_list": [
            {
                "id": 63,
                "rnd_start_blk": 8574300,
                "rnd_end_blk": 8634299,
                "rnd_start_time": 1592737389,
                "cycle": 85
            },
            {
                "id": 62,
                "rnd_start_blk": 8514300,
                "rnd_end_blk": 8574299,
                "rnd_start_time": 1591858049,
                "rnd_end_time": 1592737388,
                "cycle": 84
            },
            {
                "id": 61,
                "rnd_start_blk": 8454300,
                "rnd_end_blk": 8514299,
                "rnd_start_time": 1590983140,
                "rnd_end_time": 1591858045,
                "cycle": 83
            },
            {
                "id": 60,
                "rnd_start_blk": 8394300,
                "rnd_end_blk": 8454299,
                "rnd_start_time": 1590252541,
                "rnd_end_time": 1590983110,
                "cycle": 82
            },
            {
                "id": 59,
                "rnd_start_blk": 8334300,
                "rnd_end_blk": 8394299,
                "rnd_start_time": 1589414958,
                "rnd_end_time": 1590252540,
                "cycle": 81
            }
        ],
        "count": 11
    }
}
Response Parameter
Type
Description
code
int
error code
msg
String
if successful returns SUCCESS, if failed returns failure description 
result
String
if successful returns round history, if failed returns ""
2. Get incentives information of a node
url：/v2/nodes/inspire/all?page_number=1&page_size=10
method：GET
Request Parameter
Type
Description
page_number
int
current page number, starting from 1
page_size
int
entries on each page
Example Response
{
    "code": 0,
    "msg": "SUCCESS",
    "result": {
        "total": 48,
        "records": [
            {
                "public_key": "02107546a6a21ac45ebc3e5cdb96f100fb1efac548339926c5ab05dde175e720f4",
                "address": "ALMCC2PCT9YjzMyftvt9ifvK8jKteQfXoY",
                "name": "Node_021075",
                "status": 1,
                "current_stake": 102500,
                "node_released_ong_incentive": 8731,
                "node_released_ong_incentive_rate": "4.06%",
                "user_released_ong_incentive": 78580,
                "user_released_ong_incentive_rate": "1463.22%",
                "node_gas_fee_incentive": 0,
                "node_gas_fee_incentive_rate": "0.00%",
                "user_gas_fee_incentive": 0,
                "user_gas_fee_incentive_rate": "0.00%",
                "node_foundation_bonus_incentive": 19926,
                "node_foundation_bonus_incentive_rate": "9.28%",
                "user_foundation_bonus_incentive": 0,
                "user_foundation_bonus_incentive_rate": "0.00%"
            },
            {
                "public_key": "0223c8669cc98e82284ac2f6197c17bbd587e259260f71ffeb3e1ee5358f3c1cc7",
                "address": "AXwfq4jnhvByDmvuFhFzHSSdKJ3GQTwZ8Z",
                "name": "Node_0223c8",
                "status": 1,
                "current_stake": 893000,
                "node_released_ong_incentive": 608538,
                "node_released_ong_incentive_rate": "283.29%",
                "user_released_ong_incentive": 152134,
                "user_released_ong_incentive_rate": "8.93%",
                "node_gas_fee_incentive": 0,
                "node_gas_fee_incentive_rate": "0.00%",
                "user_gas_fee_incentive": 0,
                "user_gas_fee_incentive_rate": "0.00%",
                "node_foundation_bonus_incentive": 173599,
                "node_foundation_bonus_incentive_rate": "80.81%",
                "user_foundation_bonus_incentive": 0,
                "user_foundation_bonus_incentive_rate": "0.00%"
            },
            {
                "public_key": "02299bd4cf2c81f3e724ba267d5d4e6fbd68cf1282fd4811922a6fb7bb7661df82",
                "address": "AczZ2AmTeAPgpsZZKzT6USBPJ93Er9ThBW",
                "name": "Node_02299b",
                "status": 1,
                "current_stake": 10000,
                "node_released_ong_incentive": 8518,
                "node_released_ong_incentive_rate": "39.65%",
                "user_released_ong_incentive": 0,
                "user_released_ong_incentive_rate": "0.00%",
                "node_gas_fee_incentive": 0,
                "node_gas_fee_incentive_rate": "0.00%",
                "user_gas_fee_incentive": 0,
                "user_gas_fee_incentive_rate": "0.00%",
                "node_foundation_bonus_incentive": 1944,
                "node_foundation_bonus_incentive_rate": "9.05%",
                "user_foundation_bonus_incentive": 0,
                "user_foundation_bonus_incentive_rate": "0.00%"
            }
        ]
    }
}
Response Parameter
Type
Description
code
int
error code
msg
String
if successful returns SUCCESS, if failed returns failure description 
result
String
if successful returns incentive details, if failed returns ""
3. Get ncentives information of a node using its public key
url：/v2/nodes/inspire?public_key={public_key}
method：GET
Request Parameter
Type
Description
public_key
String
public key of a node
Example response
{
    "code": 0,
    "msg": "SUCCESS",
    "result": {
        "public_key": "02107546a6a21ac45ebc3e5cdb96f100fb1efac548339926c5ab05dde175e720f4",
        "address": "ALMCC2PCT9YjzMyftvt9ifvK8jKteQfXoY",
        "name": "Node_021075",
        "status": 1,
        "current_stake": 102500,
        "node_released_ong_incentive": 8731,
        "node_released_ong_incentive_rate": "4.06%",
        "user_released_ong_incentive": 78580,
        "user_released_ong_incentive_rate": "1463.22%",
        "node_gas_fee_incentive": 0,
        "node_gas_fee_incentive_rate": "0.00%",
        "user_gas_fee_incentive": 0,
        "user_gas_fee_incentive_rate": "0.00%",
        "node_foundation_bonus_incentive": 19926,
        "node_foundation_bonus_incentive_rate": "9.28%",
        "user_foundation_bonus_incentive": 0,
        "user_foundation_bonus_incentive_rate": "0.00%"
    }
}
Response Parameter
Type
Description
code
int
error code
msg
String
if successful returns SUCCESS, if failed returns failure description 
result
String
if successful returns incentive details, if failed returns ""
Fields in an incentive details object:
Field Name
Type
Description
public_key
String
public key of the node
address
String
wallet address of the node
name
String
node name
status
int
node type, 1 represents candidate node, 2 represents consensus node
current_stake
long
current stake of a node
node_released_ong_incentive
long
ONG incentive released to a node
node_released_ong_incentive_rate
String
ONG incentive earnings yield ratio of a node
user_released_ong_incentive
long
ONG incentive released to a user
user_released_ong_incentive_rate
String
ONG incentive earnings yield ratio of a user
node_gas_fee_incentive
long
gas fee received by a node
node_gas_fee_incentive_rate
String
gas fee earnings yield ratio of a node
user_gas_fee_incentive
long
gas fee received by a user
user_gas_fee_incentive_rate
String
gas fee earnings yield ratio of a user
node_foundation_bonus_incentive
long
foundation bonus received by a node
node_foundation_bonus_incentive_rate
String
foundation bonus earnings yield ratio of a node
user_foundation_bonus_incentive
long
foundation bonus received by a user
user_foundation_bonus_incentive_rate
String
foundation bonus earnings yield ratio of a user

Request Parameter	Type	Description
page_number	int	current page number, starting from 1
page_size	int	entries on each page

Response Parameter	Type	Description
code	int	error code
msg	String	if successful returns `SUCCESS`, if failed returns failure description
result	String	if successful returns round history, if failed returns ""

Request Parameter	Type	Description
page_number	int	current page number, starting from 1
page_size	int	entries on each page

Response Parameter	Type	Description
code	int	error code
msg	String	if successful returns `SUCCESS`, if failed returns failure description
result	String	if successful returns incentive details, if failed returns ""

Request Parameter	Type	Description
public_key	String	public key of a node

Response Parameter	Type	Description
code	int	error code
msg	String	if successful returns `SUCCESS`, if failed returns failure description
result	String	if successful returns incentive details, if failed returns ""

Field Name	Type	Description
public_key	String	public key of the node
address	String	wallet address of the node
name	String	node name
status	int	node type, `1` represents candidate node, `2` represents consensus node
current_stake	long	current stake of a node
node_released_ong_incentive	long	ONG incentive released to a node
node_released_ong_incentive_rate	String	ONG incentive earnings yield ratio of a node
user_released_ong_incentive	long	ONG incentive released to a user
user_released_ong_incentive_rate	String	ONG incentive earnings yield ratio of a user
node_gas_fee_incentive	long	gas fee received by a node
node_gas_fee_incentive_rate	String	gas fee earnings yield ratio of a node
user_gas_fee_incentive	long	gas fee received by a user
user_gas_fee_incentive_rate	String	gas fee earnings yield ratio of a user
node_foundation_bonus_incentive	long	foundation bonus received by a node
node_foundation_bonus_incentive_rate	String	foundation bonus earnings yield ratio of a node
user_foundation_bonus_incentive	long	foundation bonus received by a user
user_foundation_bonus_incentive_rate	String	foundation bonus earnings yield ratio of a user

Summary

Native Token API

Last modified 3mo ago