CoinWarz API Documentation

CoinWarz provides API access to the crypto currency data listed on coinwarz.com with JSON responses. All API requests require an API key. To generate an API key, please click the "Generate API key" button. In order for an API key to be approved a valid email address is required.

Generate API Key

API Access Levels

Free Access
The free access level is the default access level for all approved API keys. This level allows up to 25 API calls within a 24 hour period and an API usage limit of 1,000 API calls.
Paid Access
The paid access level provides additional API calls within a 24 hour period and a substantially higher API usage limit.
Access Level API Calls within a 24 hour period Usage Limit Fee
Free Access Level 25 API calls 1,000 FREE FREE
Paid Access Level 300 API calls 50,000 $20.00 USD Purchase
Paid Pro Access Level 1,500 API calls 250,000 $50.00 USD Purchase

Any Paid Access Level purchase will automatically add to your existing usage limit. For example, if you have 990 API calls remaining from your Free Access Level usage limit and you purchase the standard Paid Access Level, your usage limit would be increased to 50,990 and your API calls within a 24 hour period would be increased to 300.

If your API usage limit reaches 0 you must purchase a Paid Access Level to replenish your API usage limit and continue using the API.


API Methods

RESTful

All API methods are RESTful APIs:

  • All API calls should be made with HTTP GET
  • All HTTP responses will be in JSON.
  • You can consider any non-200 HTTP response an error. The returned response will contain more information about the error.

Example JSON Response

{ "Success": true, "Message": "Message about the API call" , "Data": {} }

Parameter Data Type Description
Success Boolean This parameter indicates if the API call was successful or unsuccessful.
Message String This parameter provides messages about the API call for both successful or unsuccessful API calls.
Data JSON Object or JSON Array This parameter provides the JSON Object or JSON Array data for the given API call. If the API call was unsuccessful, this parameter may be null.

API Key Information API

The API Key Information API provides information about the API Key provided.

API Endpoint

http://www.coinwarz.com/v1/api/apikeyinfo?apikey=YOUR_API_KEY

API Call Usage
This value will be deducted from your API usage limit each time you successfully call this API.

0 API Call Usage

Input Parameters
All input parameters are required and not case sensitive.

Parameter Data Type Description
ApiKey String Provide your approved API key for this parameter.

Output JSON Parameters

Parameter Data Type Description
Success Boolean This parameter indicates if the API call was successful or unsuccessful.
Message String This parameter provides messages about the API call for both successful or unsuccessful API calls.
Data JSON Object This parameter provides the JSON Object information for the API Key. If the API call was unsuccessful, this parameter may be null.

Data JSON Object Parameters

Parameter Data Type Description
ApiKey String This parameter provides the API Key.
AccessLevel String This parameter provides the access level for the given API Key.
ApiUsageLimit Number This parameter provides the API usage limit based on the access level for the given API Key.
ApiUsageAvailable Number This parameter provides the total number of API calls left or available for the given API Key.
DailyUsageLimit Number This parameter provides the Daily API usage limit based on the access level for the given API Key.
DailyUsageAvailable Number This parameter provides the number of daily (within the last 24 hours) API calls left or available for the given API Key.
Approved Boolean This parameter indicates if the API Key has been approved or not.

Example JSON Response

Example API Key Information API JSON Response


Mining Profitability API

The Mining Profitability API provides profitability data listed on CoinWarz.com. This data can be for all coins or for specific hashing algorithms: SHA-256 or Scrypt

API Endpoint

http://www.coinwarz.com/v1/api/profitability/?apikey=YOUR_API_KEY&algo=all

API Call Usage
This value will be deducted from your API usage limit each time you successfully call this API.

1 API Call Usage

Input Parameters
All input parameters are required and not case sensitive.

Parameter Data Type Description
ApiKey String Provide your approved API key for this parameter.
Algo String Provide one of the three values for this parameter: all, scrypt, or sha-256

Output JSON Parameters

Parameter Data Type Description
Success Boolean This parameter indicates if the API call was successful or unsuccessful.
Message String This parameter provides messages about the API call for both successful or unsuccessful API calls.
Data JSON Array This parameter provides the JSON Array data for the coin data. If the API call was unsuccessful, this parameter will be null.

Data JSON Array Parameters

Parameter Data Type Description
CoinName String This parameter provides the Coin Name.
CoinTag String This parameter provides the Coin Tag.
Algorithm String This parameter provides the hashing algorithm used.
Difficulty Number This parameter provides the current difficulty.
BlockReward Number This parameter provides the current block reward.
BlockCount Number This parameter provides the current block count.
ProfitRatio Number This parameter provides the profit ratio against Bitcoin.
AvgProfitRatio Number This parameter provides the average profit ratio against Bitcoin for the last 14 days.
Exchange String This parameter provides the name of the exchange with the current highest exchange rate.
ExchangeRate Number This parameter provides the numeric value of the current highest exchange rate.
ExchangeVolume Number This parameter provides the volume of the current highest exchange rate.
IsBlockExplorerOnline Boolean This parameter indicates if the coin daemon or block explorer is offline. If the value is false, the data for this coin may be out dated and you should be cautious when using the profit ratio for this coin.
IsExchangeOnline Boolean This parameter indicates if the exchange is offline. If the value is false, the data for this coin may be out dated and you should be cautious when using the profit ratio for this coin.
Message String This parameter provides messages about the coin. This parameter is usually empty, unless the coin daemon/block explorer or exchange is offline.
BlockTimeInSeconds Number This parameter provides the block time in seconds for this coin.
HealthStatus String This parameter provides the health status of the coin; Healthy or Unhealthy. If the health status of the coin is Unhealthy you should be cautious when using the profit ratio for this coin. For more information about the Unhealthy status, see the value in the Message parameter.

Example JSON Response

Example Mining Profitability API JSON Response


Coin Information API

The Coin Information API provides coin information listed on CoinWarz.com for a given coin.

API Endpoint

http://www.coinwarz.com/v1/api/coininformation/?apikey=YOUR_API_KEY&cointag=BTC

API Call Usage
This value will be deducted from your API usage limit each time you successfully call this API.

1 API Call Usage

Input Parameters
All input parameters are required and not case sensitive.

Parameter Data Type Description
ApiKey String Provide your approved API key for this parameter.
CoinTag String Provide a valid coin tag for the coin.

Output JSON Parameters

Parameter Data Type Description
Success Boolean This parameter indicates if the API call was successful or unsuccessful.
Message String This parameter provides messages about the API call for both successful or unsuccessful API calls.
Data JSON Object This parameter provides the JSON Object data for the coin data. If the API call was unsuccessful, this parameter will be null.

Data JSON Object Parameters

Parameter Data Type Description
CoinName String This parameter provides the Coin Name.
CoinTag String This parameter provides the Coin Tag.
Algorithm String This parameter provides the hashing algorithm used.
Difficulty Number This parameter provides the current difficulty.
BlockReward Number This parameter provides the current block reward.
BlockCount Number This parameter provides the current block count.
IsBlockExplorerOnline Boolean This parameter indicates if the coin daemon or block explorer is offline. If the value is false, the data for this coin may be out dated and you should be cautious when using the profit ratio for this coin.
IsExchangeOnline Boolean This parameter indicates if the exchange is offline. If the value is false, the data for this coin may be out dated and you should be cautious when using the profit ratio for this coin.
Message String This parameter provides messages about the coin. This parameter is usually empty, unless the coin daemon/block explorer or exchange is offline.
ExchangeRates JSON Array This parameter provides a JSON Array for the list of exchanges.
BlockTimeInSeconds Number This parameter provides the block time in seconds for this coin.
HealthStatus String This parameter provides the health status of the coin; Healthy or Unhealthy. If the health status of the coin is Unhealthy you should be cautious when using the profit ratio for this coin. For more information about the Unhealthy status, see the value in the Message parameter.

ExchangeRates JSON Array Parameters

Parameter Data Type Description
Exchange String This parameter provides the Exchange Name.
ToUSD Number This parameter provides the USD value if any.
ToBTC Number This parameter provides the coin to BTC exchange rate.
Volume Number This parameter provides the trading volume.
TimeStamp Number This parameter is a UNIX timestamp.

Example JSON Response

Example Coin Information API JSON Response