β‘Energy Consumption API
This API provides comprehensive data about Filecoin Storage Providers' energy consumption metric.
Good to know: In addition to below there is an Open API documentation available here.
Data Model
The Data Model end point is listing all available data models (e.g. Energy intensity, Energy used to seal data, Energy used to store data, etc.).
List available API data models
GET
https://api.filgreen.d.interplanetary.one/models/list
Energy Consumption: Daily, weekly and monthly data granularity
This endpoint provides energy consumption data for selected data model grouped on a daily, weekly or monthly scale.
Energy consumption grouped on a daily, weekly and monthly scale for selected model, date range and Storage Provider
GET
https://api.filgreen.d.interplanetary.one/models/model
Query Parameters
Name | Type | Description |
---|---|---|
id* | Integer | Id of the data model. (either "id" or associated "code_name" query parameter have to be provided) |
code_name* |
| Code name of the data model, see 'Available data models' above. (either "id" or associated "code_name" query parameter have to be provided) |
filter |
| Data granulation. Possible values are: "day", "week" or "month". If not provided "day" is considered as default value. |
miner | String | Miner Id (e.g. f01234). If not listed data is provided without filtering per miner Id. |
start | Date / String | ISO 8601 formatted start date. If not provided data points are listed from the epoch 0. |
end | Date / String | ISO 8601 formatted end date. If not provided data points are listed up to the most recent measurement. |
Energy Consumption: All data points
This endpoint provides all measured energy consumption data points for selected data model.
Energy consumption
GET
https://api.filgreen.d.interplanetary.one/models/export
Query Parameters
Name | Type | Description |
---|---|---|
id* | Integer | Id of the data model. (either "id" or associated "code_name" query parameter have to be provided) |
code_name* |
| Code name of the data model, see 'Available data models' above. (either "id" or associated "code_name" query parameter have to be provided) |
miner | String | Miner Id (e.g. f01234). If not listed data is provided without filtering per miner Id. |
start | Date / String | ISO 8601 formatted start date. If not provided data points are listed from the epoch 0. |
end | Date / String | ISO 8601 formatted end date. If not provided data points are listed up to the most recent measurement. |
offset | Integer | Number of data points to skip from the beginning of the record set. Default 0. |
limit | Integer | Maximal number of data points to be listed. Default 10000. |
Last updated