$40103
w

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. You can then display all this information on your own website with your own look and feel instead of registering as a regular user on the NodeCheck website.

Can regular user accounts utilise the API service?

No. Our service provides two types of accounts: User accounts, API accounts. They are not connected in any way.

What is the API access token under My Profile --> Preferences for?

The API access token under Preferences is for use with our monitoring scripts found on our github page. This allows you to check/compare your wallet version with our version so that we can provide notifications when a new wallet is available so that you can upgrade. It doesn't allow you to monitor your masternodes, that is a separate API service and requires purchasing an API key from us.

How does the API 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. Also shows when your API is due to expire.

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!

My API stopped working, and I am getting the following message: "message": "Number of allowed API calls exceeded or API package has expired, contact support".

Each API package is valid for 1 month. Also, each API package has an API call limit. Therefore either one, or the other, or both limits have been reached.

If you only use some of your API calls, and the API expiry date is reached, the API stops working.
If you use your monthly API call limit before the API expiry date, the API stops working.

In such situation, you need to contact us to renew your API service.

Can I purchase/renew my API account for more than one month?

Yes! When you purchase/renew the API, we can do it for as long as you want. If you want to purchase for two months, no problem. If you want to renew quarterly, this is also possible. You can even purchase an API account for one year if you wish! Or even longer. The choice is yours!

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?

Pricing is based on total number of API calls per month. This is example pricing based on reasonable API usage from our personal experience to provide appropriate masternode monitoring, or calls for statistics If you find yourself using your API calls too quickly, then it means you need to be purchasing a larger API package. For more information or pricing outside the example pricing below, please make contact with one of the team members via our Discord - click the "Community" link at the top of this page.

 Pricing
No. of API calls Price Monthly Price per API call
30,000 €10 €0.00033
60,000 €20 €0.00033
150,000 €30 €0.00020
300,000 €40 €0.00013
600,000 €60 €0.00010
1,500,000 €100 €0.000067
3,300,000 €200 €0.000061
5,000,000 €300 €0.000060
Over 5m calls Contact Us! Contact Us!
Net prices in Euro

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.14.0.3",
				"last_block": 1127070,
				"block_age": 146,
				"statuses": {
					"ENABLED": 4903,
					"POSE_BANNED": 110
				},
				"usd_price": 92.18833017394,
				"btc_price": "0.00890507",
				"change_24h": -0.740456,
				"roi": 6.337955265,
				"collateral": 1000,
				"payout_sum_daily": "851.36969343",
				"payout_count_daily": 548,
				"payout_period": 773027.712,
				"daily_income": {
					"coin": 0.1736,
					"btc": "0.00154630",
					"usd": 16.0078
				},
				"links": {
					"Explorer": "https://explorer.dash.org/chain/Dash",
					"WWW": "https://www.dash.org/",
					"Twitter": "https://twitter.com/dashpay",
					"Discord": "https://discord.gg/9z8zX5j",
					"Reddit": "https://www.reddit.com/r/dashpay",
					"Bitcointalk": "https://bitcointalk.org/index.php?topic=421615.0",
					"Github": "https://github.com/dashpay/dash"
				}
			}
		}
	}

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": 1000000,
			"api_expiry": "2019-09-05"
		}
	}