Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnioche/carbonintensity-api
A simple Rust library to retrieve data from https://api.carbonintensity.org.uk/
https://github.com/jnioche/carbonintensity-api
carbon-intensity carbon-intensity-api national-grid rust-lang
Last synced: 12 days ago
JSON representation
A simple Rust library to retrieve data from https://api.carbonintensity.org.uk/
- Host: GitHub
- URL: https://github.com/jnioche/carbonintensity-api
- Owner: jnioche
- License: apache-2.0
- Created: 2023-11-10T15:37:03.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-28T17:00:43.000Z (8 months ago)
- Last Synced: 2024-05-01T20:27:58.486Z (6 months ago)
- Topics: carbon-intensity, carbon-intensity-api, national-grid, rust-lang
- Language: Rust
- Homepage:
- Size: 34.2 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - carbonintensity-api - Rust library to retrieve regional carbon intensity data from the UK National Grid. (Emissions / Carbon Intensity and Accounting)
README
# carbonintensity-api
[](https://crates.io/crates/carbonintensity-api)
[](https://crates.io/crates/carbonintensity-api)
[](https://docs.rs/carbonintensity-api)
A simple Rust library to help retrieve data from the [Carbon Intensity API](https://api.carbonintensity.org.uk/), not all functionalities of the CarbonIntensity API might be exposed.
Please read the API's [terms of use](https://github.com/carbon-intensity/terms).
## CLI
An executable is provided to try the library. With Rust and Cargo installed
```
cargo install --path .
```
then
`carbonintensity-api -h`
should display the list of available commands and options.
```
Provides a client for the UK National Grid Carbon Intensity API
Usage: carbonintensity-api [OPTIONS]
Arguments:
numerical value for a region (1-17) or first part of a UK postcode
Options:
-s, --start-date
-e, --end-date
-h, --help Print help
-V, --version Print version
```
To display the current carbon intensity for a given postcode
`carbonintensity-api bs7`
To do the same for a region
`carbonintensity-api 11`
The region id is a number between 1 and 17
1. North Scotland
2. South Scotland
3. North West England
4. North East England
5. South Yorkshire
6. North Wales, Merseyside and Cheshire
7. South Wales
8. West Midlands
9. East Midlands
10. East England
11. South West England
12. South England
13. London
14. South East England
15. England
16. Scotland
17. Wales
Specifying dates will return a list of intensities for a region or postcode. If no end date is provided, the current day and time will be used.
The dates are expected to be at the `%Y-%m-%dT%H:%MZ` format or simply `%Y-%m-%d`, for instance
`carbonintensity-api -s 2023-11-11 -e 2023-11-11T12:00Z postcode bs7`
Intensities are returned by 30 mins windows.
## Library
You can use the library in your Rust project by adding it to cargo with
`cargo add carbonintensity-api`
then declaring it in your code
```Rust
use carbonintensity::{get_intensity, Target, Region};
...
let scotland = Region::Scotland;
let result = get_intensity(&Target::Region(scotland)).await;
```
## License
This project is provided under [Apache License](http://www.apache.org/licenses/LICENSE-2.0).