CoinWarz API Documentation
CoinWarz provides API access to the cryptocurrency 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.
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 | $10 USD | Purchase |
| Paid Pro Access Level | 1,500 API calls | 250,000 | $25 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
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, Scrypt, X11, Groestl, NeoScrypt, Lyra2REv2, Equihash, RandomX, KawPow, ETCHASH, Verthash
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
Required 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 the following values for this parameter:
all, sha-256, scrypt, x11, groestl, neoscrypt, lyra2rev2, equihash, randomx, kawpow, etchash, verthash |
Optional Input Parameters
The following input parameters are optional, not case sensitive, and will use the specified
default value if not provided.
| Parameter | Data Type | Default Value | Description |
|---|---|---|---|
| sha256HashRate | Number |
200,000.00 ( 200,000.00 GH/s) |
Provide the SHA-256 Hash Rate in GH/s when using all or sha-256 for the Algo parameter. |
| sha256Power | Number |
3,500.00 (3,500.00 Watts) |
Provide the SHA-256 Power wattage when using all or sha-256 for the Algo parameter. |
| sha256PowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the SHA-256 Power Cost (USD) per KWh when using all or sha-256 for the Algo parameter. |
| scryptHashRate | Number |
14,400,000.00 ( 14,400,000.00 KH/s) |
Provide the Scrypt Hash Rate in KH/s when using all or scrypt for the Algo parameter. |
| scryptPower | Number |
3,950.00 (3,950.00 Watts) |
Provide the Scrypt Power wattage when using all or scrypt for the Algo parameter. |
| scryptPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the Scrypt Power Cost (USD) per KWh when using all or scrypt for the Algo parameter. |
| x11HashRate | Number |
65,000.00 ( 65,000.00 MH/s) |
Provide the X11 Hash Rate in MH/s when using all or x11 for the Algo parameter. |
| x11Power | Number |
1,500.00 (1,500.00 Watts) |
Provide the X11 Power wattage when using all or x11 for the Algo parameter. |
| x11PowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the X11 Power Cost (USD) per KWh when using all or x11 for the Algo parameter. |
| groestlHashRate | Number |
45.00 ( 45.00 MH/s) |
Provide the Groestl Hash Rate in MH/s when using all or groestl for the Algo parameter. |
| groestlPower | Number |
825.00 (825.00 Watts) |
Provide the Groestl Power wattage when using all or groestl for the Algo parameter. |
| groestlPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the Groestl Power Cost (USD) per KWh when using all or groestl for the Algo parameter. |
| neoscryptHashRate | Number |
400.00 ( 400.00 KH/s) |
Provide the NeoScrypt Hash Rate in KH/s when using all or neoscrypt for the Algo parameter. |
| neoscryptPower | Number |
400.00 (400.00 Watts) |
Provide the NeoScrypt Power wattage when using all or neoscrypt for the Algo parameter. |
| neoscryptPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the NeoScrypt Power Cost (USD) per KWh when using all or neoscrypt for the Algo parameter. |
| lyra2rev2HashRate | Number |
30.00 ( 30.00 MH/s) |
Provide the Lyra2REv2 Hash Rate in MH/s when using all or lyra2rev2 for the Algo parameter. |
| lyra2rev2Power | Number |
600.00 (600.00 Watts) |
Provide the Lyra2REv2 Power wattage when using all or lyra2rev2 for the Algo parameter. |
| lyra2rev2PowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the Lyra2REv2 Power Cost (USD) per KWh when using all or lyra2rev2 for the Algo parameter. |
| equihashHashRate | Number |
140,000.00 ( 140,000.00 H/s) |
Provide the Equihash Hash Rate in H/s when using all or equihash for the Algo parameter. |
| equihashPower | Number |
1,550.00 (1,550.00 Watts) |
Provide the Equihash Power wattage when using all or equihash for the Algo parameter. |
| equihashPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the Equihash Power Cost (USD) per KWh when using all or equihash for the Algo parameter. |
| randomxHashRate | Number |
54,000.00 ( 54,000.00 H/s) |
Provide the RandomX Hash Rate in H/s when using all or randomx for the Algo parameter. |
| randomxPower | Number |
280.00 (280.00 Watts) |
Provide the RandomX Power wattage when using all or randomx for the Algo parameter. |
| randomxPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the RandomX Power Cost (USD) per KWh when using all or randomx for the Algo parameter. |
| kawpowHashRate | Number |
350.00 ( 350.00 MH/s) |
Provide the KawPow Hash Rate in MH/s when using all or kawpow for the Algo parameter. |
| kawpowPower | Number |
2,900.00 (2,900.00 Watts) |
Provide the KawPow Power wattage when using all or kawpow for the Algo parameter. |
| kawpowPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the KawPow Power Cost (USD) per KWh when using all or kawpow for the Algo parameter. |
| etchashHashRate | Number |
5,800.00 ( 5,800.00 MH/s) |
Provide the ETCHASH Hash Rate in MH/s when using all or etchash for the Algo parameter. |
| etchashPower | Number |
1,900.00 (1,900.00 Watts) |
Provide the ETCHASH Power wattage when using all or etchash for the Algo parameter. |
| etchashPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the ETCHASH Power Cost (USD) per KWh when using all or etchash for the Algo parameter. |
| verthashHashRate | Number |
2.50 ( 2.50 MH/s) |
Provide the Verthash Hash Rate in MH/s when using all or verthash for the Algo parameter. |
| verthashPower | Number |
450.00 (450.00 Watts) |
Provide the Verthash Power wattage when using all or verthash for the Algo parameter. |
| verthashPowerCost | Number |
0.10 (0.10 $/kWh) |
Provide the Verthash Power Cost (USD) per KWh when using all or verthash for the Algo 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 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
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
