API


What is NodeCheck API?

NodeCheck API is a paid API service, that allows you to monitor masternodes with the use of API calls. This is ideal for services such as masternode hosting solutions, which will allow the integration of masternode monitoring, without the need to run a wallet for every single coin. You make all the API calls to our site, and obtain all the information you need to monitor your users' masternodes.

How does it work?

The API works by utilising the following API calls:

  • add - registers the node with our service so that the node can be monitored Without registering the node, it's not possible to provide the status or payout information
  • status - provides the status information of the masternode as well as payout information
  • delete - removes the node from our service
  • ticker - receive a list of all the coins supported on our platform. This allows you to check if a coin is available or not prior to attempt enabling monitoring for a node.
  • coinstats - receive a list of coinstats including - wallet version, current block height, block age, statuses, USD price, BTC price, change_24h, roi, collateral, daily payout, daily payout count, payout period, daily income.
  • apistats - check how many API calls you have made to our site - provides count, and limit.

All API calls require an API token to authenticate with our service. No API calls can be made without it.

What are the requirements for the API call?

  • Always use POST method
  • API URL: https://nodecheck.io/api/{endpoint} - {endpoint} is one of: add, status, delete, ticker, coinstats, apistats
  • Request header: Content-Type:application/json
  • Request body should be in JSON format

API results are returned in JSON format.

Is there a limit to the amount of API calls I can make?

Yes. We sell API calls in packages. This depends on how many API calls you are looking to make each month. Based on your requirements, we are able to calculate the amount of API calls you would need to make to be able to successfully monitor all the nodes you are looking to monitor with our API service.

There is also a limit to the amount of calls you can make per second. This is currently set to 50 API calls per second. Based on this limit, you can monitor approximately 3000 nodes per minute!

How can I get an API token?

Currently, access to our API is by request. Therefore, please make contact with one of the team members via our Discord - click the "Community" link at the top of this page.

How much does the API service cost?

This depends on the amount of calls you wish to make per month. Please make contact with one of the team members via our Discord - click the "Community" link at the top of this page. Pricing is provided once we understand your requirements and are able to calculate the amount of calls you would most likely need to make.


Example API calls:

Registering a node: https://nodecheck.io/api/add

REQUEST:
{
"access-token":"your-api-token-here",
"ticker":"COIN-TICKER-HERE",
"payee":"payee-of-masternode-here",
"txid":"txid-of-masternode-here"
}

RESPONSE:
{
"success": true
}

Monitoring a node: https://nodecheck.io/api/status

REQUEST:
{
"access-token":"your-api-token-here",
"payee":"payee-of-masternode-here",
"txid":"txid-of-masternode-here"
}

RESPONSE:
{
"success": true,
"message": {
"status": "ENABLED",
"last_paid_block_time": null,
"last_payout_coin_value": null,
"lastseen": "YYYY-MM-DD HH:MM:SS",
"current_version": 70210,
"ip_address_port": "xxx.xxx.xxx.xxx:xxxx",
"activetime": time_in_seconds
}
}

Deleting a node: https://nodecheck.io/api/delete

REQUEST:
{
"access-token":"your-api-token-here",
"payee":"payee-of-masternode-here",
"txid":"txid-of-masternode-here"
}

RESPONSE:
{
"success": true
}

Obtain list of supported currencies: https://nodecheck.io/api/ticker

REQUEST:
{
"access-token":"your-api-token-here"
}

RESPONSE:
{
"success": true,
"message": {
"BLOCK": {
"name": "Blocknet"
},
"DASH": {
"name": "Dash"
},
"GBX": {
"name": "GoByte"
},
..........
}

Obtain coin statistics: https://nodecheck.io/api/coinstats

REQUEST:
{
"access-token":"your-api-token-here",
"ticker":"DASH"
}

RESPONSE:
{
"success": true,
"message": {
"DASH": {
"semantic_version": "0.12.3.3",
"last_block": 982197,
"block_age": 446554,
"statuses": {
"ENABLED": 4898,
"SENTINEL_PING_EXPIRED": 11,
"NEW_START_REQUIRED": 46,
"UPDATE_REQUIRED": 60,
"PRE_ENABLED": 1,
"POSE_BAN": 1
},
"usd_price": 111.50325810328,
"btc_price": "0.02107716",
"change_24h": -2.42056,
"roi": 6.77475551,
"collateral": 1000,
"payout_sum_daily": "909.11649250",
"payout_count_daily": 543,
"payout_period": 779350.464,
"daily_income": {
"coin": 0.1856,
"btc": "0.00391213",
"usd": 20.6961
}
}
}
}

Obtain API statistics: https://nodecheck.io/api/apistats

REQUEST:
{
"access-token":"your-api-token-here"
}

RESPONSE:
{
"success": true,
"message": {
"api_call_counter": 1,
"api_call_counter_limit": 100
}
}