#Info
#Get core version
#Method
1info.coreVersion
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.currentVersion |
string |
Used core version. |
No |
result.installedVersion |
string |
Installed core version. |
Yes |
result.latestVersion |
string |
Latest core version from NPM. |
Yes |
result.manager |
object |
Core-manager versions. |
Yes |
result.manager.currentVersion |
string |
Used core-manager version. |
Yes |
result.manager.installedVersion |
string |
Installed core-manager version. |
Yes |
result.manager.latestVersion |
string |
Latest core-manager version from NPM. |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.coreVersion",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "currentVersion": "4.0.0-next.0",
6 "installedVersion": "4.0.0-next.0",
7 "latestVersion": "4.0.0-next.0",
8 "manager": {
9 "currentVersion": "3.0.2",
10 "installedVersion": "3.0.2",
11 "latestVersion": "3.0.2"
12 }
13 }
14}
#Update core
#Method
1info.coreUpdate
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.coreUpdate",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {}
5}
#Get core status
#Method
1info.coreStatus
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
params.token |
string |
Token name. |
No |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.status |
string |
Core / rely process status. |
Yes |
result.syncing |
boolean |
Determine if node is currently syncing |
No |
#Process statuses
- undefined
- online
- stopped
- stopping
- waiting restart
- launching
- errored
- one-launch-status
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.coreStatus",
5 "params": { "token": "ark" }
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "processStatus": "online",
6 "syncing": false
7 }
8}
#Get blockchain height
#Method
1info.blockchainHeight
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.height |
number |
Node height. |
Yes |
result.randomNodeHeight |
number |
Random node height. |
No |
result.randomNodeIp |
string |
Random node ip. |
No |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.blockchainHeight",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "height": 766,
6 "randomNodeHeight": 765,
7 "randomNodeIp": "127.0.0.1"
8 }
9}
#Get system resources
#Method
1info.resources
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.cpu |
object |
CPU information. |
Yes |
result.cpu.total |
number |
Total CPU resources (%). |
Yes |
result.cpu.used |
number |
Used CPU resources (%). |
Yes |
result.cpu.available |
number |
Available CPU resources (%). |
Yes |
result.ram |
object |
RAM information. |
Yes |
result.ram.total |
number |
Total memory (KB). |
Yes |
result.ram.used |
number |
Used memory (KB). |
Yes |
result.ram.available |
number |
Available memory (KB). |
Yes |
result.disk |
object |
Disk information. |
Yes |
result.disk.filesystem |
string |
Filesystem identification. |
Yes |
result.disk.total |
number |
Total disk space (KB). |
Yes |
result.disk.used |
number |
Used disk space (KB). |
Yes |
result.disk.available |
number |
Available disk space (KB). |
Yes |
result.disk.mountpoint |
string |
Mountpoint. |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.resources",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "cpu": {
6 "total": 100,
7 "used": 12.37319548903266,
8 "available": 87.62680451096733
9 },
10 "ram": {
11 "total": 16777216,
12 "used": 16711196,
13 "available": 66020
14 },
15 "disk": {
16 "filesystem": "/dev/disk1s2",
17 "total": 488245288,
18 "used": 334654912,
19 "available": 153590376,
20 "mountpoint": "/System/Volumes/Data"
21 }
22 }
23}
#Get database size
#Method
1info.databaseSize
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.size |
number |
Database size (KB). |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.databaseSize",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "size": 100000
6 }
7}
#Get next forging slot
#Method
1info.nextForgingSlot
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
params.token |
string |
Token name. |
No |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.remainingTime |
number |
Remaining time till next slot. (ms). |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.nextForgingSlot",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "remainingTime": 7000
6 }
7}
#Get last forged block
#Method
1info.lastForgedBlock
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
params.token |
string |
Token name. |
No |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.lastForgedBlock",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "serialized": "0000000068b3da0653040000e4a912ff56bd69a80000000000000000000000000000000000000000000000000000000000000000e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b85503807f9abe33fb390546bb5dcab075dd1136d0b98c54420c8c463c4ed3545161b23045022100eee1e9bea6895793cc1ce1811c8c9b327fb050d229834f20f10fc3d2e0551ac402204d0cc4e557cdc16d002c71e2dddaac7ec6c3f356e677985da1a74becea3e0acc",
6 "verification": {
7 "errors": [],
8 "containsMultiSignatures": false,
9 "verified": true
10 },
11 "transactions": [],
12 "data": {
13 "id": "963100951063532680",
14 "idHex": "0d5d9f3656fb9488",
15 "blockSignature": "3045022100eee1e9bea6895793cc1ce1811c8c9b327fb050d229834f20f10fc3d2e0551ac402204d0cc4e557cdc16d002c71e2dddaac7ec6c3f356e677985da1a74becea3e0acc",
16 "generatorPublicKey": "03807f9abe33fb390546bb5dcab075dd1136d0b98c54420c8c463c4ed3545161b2",
17 "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
18 "payloadLength": 0,
19 "reward": "0",
20 "totalFee": "0",
21 "totalAmount": "0",
22 "numberOfTransactions": 0,
23 "previousBlock": "16476721599592884648",
24 "previousBlockHex": "e4a912ff56bd69a8",
25 "height": 1107,
26 "timestamp": 114996072,
27 "version": 0
28 }
29 }
30}
#Get current delegate
#Method
1info.currentDelegate
#Parameters
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
method |
string |
The method name. |
Yes |
params |
object |
The parameters of the request. |
Yes |
params.token |
string |
Token name. |
No |
#Result
Name |
Type |
Description |
Required |
id |
string / number |
The identifier of the request. |
Yes |
jsonrpc |
string |
The protocol version. |
Yes |
result |
object |
Result. |
Yes |
result.rank |
number |
Delegate rank. |
Yes |
result.username |
string |
Delegate username. |
Yes |
#Request
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "method": "info.currentDelegate",
5 "params": {}
6}
#Response
1{
2 "id": "unique-request-id",
3 "jsonrpc": "2.0",
4 "result": {
5 "rank": 9,
6 "username": "genesis_30"
7 }
8}