API Description

dbachm123 edited this page May 25, 2018 · 12 revisions

Table of Contents


Overview

Nano Node Monitor comes with an API that can be accessed via HTTP at URL http://<node-monitor-url>/api.php, e.g. http://138.197.179.164/api.php

The node monitor will respond with a JSON struct that looks as follows. All the information that is available at the node monitor's frontend (and more) is also delivered via the API.

{  
   "nanoNodeAccount":"xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj",
   "nanoNodeAccountShort":"xrb_1f56s...89ehj",   
   "nanoNodeAccountUrl":"https:\/\/nano.meltingice.net\/explorer\/account\/xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj",
   "version":"12.1",
   "newNodeVersionAvailable":false,
   "nodeMonitorVersion":"1.4.2",
   "currentBlock":8361435,
   "uncheckedBlocks":1937,
   "blockSync":100,
   "numPeers":689,
   "accBalanceMnano":0,
   "accBalanceRaw":0,
   "accPendingMnano":0,
   "accPendingRaw":0,
   "repAccount":"xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj",
   "repAccountShort":"xrb_1f56s...89ehj",
   "repAccountUrl":"https:\/\/nano.meltingice.net\/explorer\/account\/xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj",
   "votingWeight":2948.5985790953,
   "systemLoad":1.65,
   "systemUptime":"1 days, 20 hrs, 40 mins",
   "usedMem":318,
   "totalMem":992,
   "nanoNodeName":"dbachm123-nanoNode",
   "nodeNinja":{  
      "account":"xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj",
      "lastVoted":"2018-04-23T17:54:49.640Z",
      "alias":"dbachm123's Nano Node",
      "description":"This is an awesome Nano node",
      "location":"DigitalOcean, Germany ",
      "website":"http:\/\/138.197.179.164\/",
      "uptime":98.088235294118,
      "monitor":{  
         "sync":100,
         "url":"http:\/\/138.197.179.164\/",
         "version":"12.1",
         "blocks":8361434
      },
      "delegators":20,
      "votingweight":2.8186967460668e+33
   }
}

Description

nanoNodeAccount

{  
   "nanoNodeAccount":"xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj"
}

The account of the Nano node being monitored.

Since version 1.3.6

nanoNodeAccountShort

{  
   "nanoNodeAccountShort":"xrb_1f56s...89ehj"
}

Short address of the account of the Nano node being monitored.

Since version 1.3.6

nanoNodeAccountUrl

{  
   "nanoNodeAccountUrl":"https:\/\/nano.meltingice.net\/explorer\/account\/xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj"
}

URL of block explorer showing information about the account of the monitored Nano node.

Since version 1.3.6

version

{  
    "version":"12.1"
}

Software version of the monitored Nano node.

Since version 1.3.6

newNodeVersionAvailable

{  
    "newNodeVersionAvailable":false
}

Indicator for a new available version of the Nano node software.

Since version 1.4.0

nodeMonitorVersion

{  
    "nodeMonitorVersion":"1.4.2"
}

Version of the Nano node monitor.

Since version 1.4.2

currentBlock

{  
   "currentBlock":8361435
}

The latest block that your node has synced.

Since version 1.3.6

uncheckedBlocks

{  
   "uncheckedBlocks":1937
}

The number of blocks that are currently not in the local ledger. At normal operation this should be less than 1000 but can increase over time.

Since version 1.3.6

blockSync

{  
    "blockSync":100
}

Sync status of the monitored Nano node in percent.

Since version 1.4.0

numPeers

{  
    "numPeers":689
}

The number of neighbor nodes that this node is connected to.

Since version 1.3.6

accBalanceMnano

{  
   "accBalanceMnano":0
}

Account balance in Nano.

Since version 1.3.6

accBalanceRaw

{  
   "accBalanceRaw":0
}

Account balance in Raw.

Since version 1.3.6

accPendingMnano

{  
   "accPendingMnano":0
}

Pending account balance in Nano.

Since version 1.3.6

accPendingRaw

{  
   "accPendingRaw":0
}

Pending account balance in Raw.

Since version 1.3.6

repAccount

{  
   "repAccount":"xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj"
}

Account of the representative of the monitored Nano node.

Since version 1.3.6

repAccountShort

{  
   "repAccountShort":"xrb_1f56s...89ehj"
}

Short account of the representative of the monitored Nano node.

Since version 1.3.6

repAccountUrl

{  
   "repAccountUrl":"https:\/\/nano.meltingice.net\/explorer\/account\/xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj"
}

URL of block explorer showing information about the representative account of the monitored Nano node.

Since version 1.3.6

votingWeight

{  
      "votingWeight":2948.5985790953
}

The combined balances of all accounts who set up their representative to the monitored node's address. This is determining the voting power of the node account in the whole Nano network.

Since version 1.3.6

systemLoad

{  
   "systemLoad":1.65
}

The load of the system.

Since version 1.3.6

systemUptime

{  
   "systemUptime":"1 days, 20 hrs, 40 mins"
}

System uptime.

Since version 1.3.6

usedMem

{  
   "usedMem":318
}

Amount of used memory in MB.

Since version 1.3.6

totalMem

{  
   "totalMem":992
}

Amount of total memory installed in MB.

Since version 1.3.6

nanoNodeName

{  
   "nanoNodeName":"dbachm123-nanoNode"
}

Name of the monitored Nano node.

Since version 1.3.6

nodeLocation

{  
   "nodeLocation":"Germany"
}

Location of the monitored Nano node.

Since version 1.4.6

nodeNinja

{  
   "nodeNinja":{  
      "account":"xrb_1f56swb9qtpy3yoxiscq9799nerek153w43yjc9atoaeg3e91cc9zfr89ehj",
      "lastVoted":"2018-04-23T17:54:49.640Z",
      "alias":"dbachm123's Nano Node",
      "description":"This is an awesome Nano node",
      "location":"DigitalOcean, Germany ",
      "website":"http:\/\/138.197.179.164\/",
      "uptime":98.088235294118,
      "monitor":{  
         "sync":100,
         "url":"http:\/\/138.197.179.164\/",
         "version":"12.1",
         "blocks":8361434
      },
      "delegators":20,
      "votingweight":2.8186967460668e+33
   }
}

A JSON struct containing the API response of Nano Node Ninja.

Since version 1.4.0

currency

{  
   "currency":"nano"
}

Currency of the monitored node, e.g. nano or banano.

Since version 1.4.6

currencySymbol

{  
   "currencySymbol":"NANO"
}

Currency symbol of the monitored node, e.g. NANO or BANANO.

Since version 1.4.6

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.