Hashrate IndexAPI DocumentationEnergy
Get Electricity Overview
/energy/electricity-overview has rate limitation:
Initially, the API allows for a burst of 20 requests, and afterward, it gradually restores 1 request every 15 seconds until reaching the maximum allowable limit of 20. This limitation is imposed to manage and control the rate at which requests can be made to the API, preventing potential misuse or excessive use of resources.
Electricity Overview
This endpoint offers a comprehensive look at electricity metrics, including demand, generation, and net generation. This overview is crucial for energy sector analysis, providing a snapshot of the current state of electricity supply and demand.
Authorization
ApiKeyAuth X-Hi-Api-Key<token>
In: header
Query Parameters
span?string
Time span
Default
"7D"Value in
- "7D"
- "1M"
- "1Y"
- "5Y"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/energy/electricity-overview?span=1Y"{ "$schema": "https://api.hashrateindex.com/v1/hashrateindex/schemas/ElectricityOverviewData.json", "data": [ { "demand": 0, "demandForecast": 0, "netGeneration": 0, "timestamp": "2019-08-24T14:15:22Z" } ]}{ "$schema": "https://api.hashrateindex.com/v1/hashrateindex/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "$schema": "https://api.hashrateindex.com/v1/hashrateindex/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}{ "$schema": "https://api.hashrateindex.com/v1/hashrateindex/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}