🦀 Rust Amber Electric API

[JP-Ellis]

I’m excited to announce that I have created and published a Rust client for the Amber API! This should make it much easier for Rustaceans to interact with Amber’s data and build cool projects.

• GitHub
• crates.io

What’s Included?

• Easy API access: Fetch all of the API endpoints exposed by Amber.
• Typed models: Strong Rust types for Amber’s endpoints.

Example Usage

use amber_api::Amber;

// Create a client with your API key
let client = Amber::builder()
    .api_key("your-api-key-here") // Prefer setting AMBER_API_KEY in an environment variable
    .build()?;

// Get all your electricity sites
let sites = client.sites()?;
println!("Found {} sites", sites.len());

// Get renewable energy data for Victoria
let renewables = client.renewables().state("vic").call()?;
println!("Current renewable: {}%", renewables.percentage);

You’ll find several ready-to-run examples in the examples/ directory.

Feedback & Contributions

I’d love to hear your thoughts, suggestions, or bug reports. PRs and issues are very welcome!

There are a few features on the roadmap tracked in the issues.

Question for the Amber Team

Is there any chance of getting a developer-only API key for testing, ideally with access to dummy/fake data and a more generous rate limit? At the moment, I’m using my personal API key, but CI runs in bursts and often hits the request limit within the 5 minutes period. This would really help with development and automated testing.

Thanks for reading, and happy hacking!

[tomnieuwland]

G'day @JP-Ellis ! Awesome to see new clients popping up for the public API. We don't currently have an "endorsed" clients list (most people roll their own with our OpenAPI spec), but I'll see if @madpilot would be up for including this in the README.

As for a "rate-limit free" API key, as much as we would love to give you one, our public API rate limiting is currently handled by API Gateway, which means we are a bit hamstrung on what we can offer on a per key level (its more of a global rate limit than something customizable). Sorry about that. I'll chuck something on our nice to haves roadmap, but it may not get picked up for some time.

Once again, thanks for building something cool with Amber 💚