The Hyphen Climate API and Oracle Network allows organizations to interact with and verify GHG and ODS data provided by ICOS (Integrated Carbon Observation System - "https://www.icos-cp.eu/index.php/"), NOAA and other scientific organizations undearneath the WMO via the Blockchain.
As more and more public sector guidance rolls out and regulatory oversight focuses on climate risk mitigation, the Hyphen Framework is ready to serve relevant GHG and ODS data to smart contracts automating and augmenting climate action.
Our Framework is built on a REST-based API, Solidity Smart Contracts, Avalanche Blockchain and the Chainlink Oracle network.
Find more information on Hyphen Global and our initiatives on our website https://www.hyphen.earth/
Gases: CH4(PPB), CO(PPM), CO2(PPM), N2O(PPM).
Organisations: ICOS (https://www.icos-cp.eu/), NOAA (https://www.noaa.gov/).
- Documentation Update outstanding (08/02/2023)
Base Endpoint
Endpoint: https://portal-api.hyphen.earth/
- All endpoints return a JSON object
- All endpoints return
200code in a successful case
Description: Returns information about what we have in our database:
- averagingIntervals;
- stations;
- gases;
- responsibleOrganizations;
- gasesMeasured: a list of measurements ranges for each gas/averagingInterval combination;
- stationGasMeasuredCombinations: a list of measurements ranges for each station/gas/averagingInterval combination.
Request URL: https://portal-api.hyphen.earth/api/station_gas_measured
Description: Returns a list of all measurement stations
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| PageNumber | query | Number of a page | No | integer |
| PageSize | query | Items count per one page | No | integer |
Request URL: https://portal-api.hyphen.earth/api/stations
Description: Returns specific measurement station
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | Station ID number | Yes | long |
Request URL: https://portal-api.hyphen.earth/api/stations/1007
Description: Returns a list of all data objects.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| themeName | query | Theme of climate data (like atmospheric, oceanic) | No | string |
| samplingHeight | query | Station measurement sampling height | No | double |
| time_from | query | Data acquisition start time | No | dateTime |
| time_to | query | Data acquisition end time | No | dateTime |
| station_id | query | Station ID number | No | long |
| dataTypeLabel | query | Descption of the data object | No | string |
| dataLevel | query | Data level | No | integer |
| PageNumber | query | Number of a page | No | integer |
| PageSize | query | Items count per one page | No | integer |
Request URL: https://portal-api.hyphen.earth/api/layers
Description: Returns a daily average measurement
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| stationCode | query | Station code, e.g.: HPB, WAO, ZEP, ZSF |
Yes | string |
| gasName | query | Gas name, e.g.: CO2, CH4 |
Yes | string |
| year | query | Year, format: YYYY |
Yes | integer |
| month | query | Month, format: M |
Yes | integer |
| day | query | Day, format: D |
Yes | integer |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage?stationCode=HPB&gasName=CO2&year=2022&month=11&day=11
Description: Returns detailed daily average measurement
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| stationCode | query | Station code, e.g.: HPB, WAO, ZEP, ZSF |
Yes | string |
| gasName | query | Gas name, e.g.: CO2, CH4 |
Yes | string |
| year | query | Year, format: YYYY |
Yes | integer |
| month | query | Month, format: M |
Yes | integer |
| day | query | Day, format: D |
Yes | integer |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage_detailed?stationCode=HPB&gasName=CO2&year=2022&month=11&day=11
Description: Returns the latest daily average measurement
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| stationCode | query | Station code, e.g.: HPB, WAO, ZEP, ZSF |
Yes | string |
| gasName | query | Gas name, e.g.: CO2, CH4 |
Yes | string |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage_latest?stationCode=HPB&gasName=CO2
Description: Returns the detailed latest daily average measurement
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| stationCode | query | Station code, e.g.: HPB, WAO, ZEP, ZSF |
Yes | string |
| gasName | query | Gas name, e.g.: CO2, CH4 |
Yes | string |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage_latest_detailed?stationCode=HPB&gasName=CO2
Description: Returns a list of daily average measurements of specific station of all gases
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| stationCode | query | Station code, e.g.: HPB, WAO, ZEP, ZSF |
Yes | string |
| year | query | Year, format: YYYY |
Yes | integer |
| month | query | Month, format: M |
Yes | integer |
| day | query | Day, format: D |
Yes | integer |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage_combinations_oneStationAllGases_specifiedDate?stationCode=HPB&year=2022&month=11&day=11
Description: Returns a list of daily average measurements of all stations of all gases
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| year | query | Year, format: YYYY |
Yes | integer |
| month | query | Month, format: M |
Yes | integer |
| day | query | Day, format: D |
Yes | integer |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage_combinations_allStationsAllGases_specifiedDate?year=2022&month=12&day=31
Description: Returns a list of daily average measurements of all stations of specific gas
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| gasName | query | Gas name, e.g.: CO2, CH4 |
Yes | string |
| year | query | Year, format: YYYY |
Yes | integer |
| month | query | Month, format: M |
Yes | integer |
| day | query | Day, format: D |
Yes | integer |
Request URL: https://portal-api.hyphen.earth/api/station_gas_allheights_dailyaverage_combinations_allStationsOneGas_specifiedDate?gasName=CH4&year=2022&month=11&day=11