Skip to main content

Module models

Module models

Expand description

§Amber Electric API Models

This module contains all the data structures and types used to interact with the Amber Electric Public API.

§Core Configuration

State - Australian states for renewable energy data (NSW, VIC, QLD, SA)
Resolution - Interval resolution options (5-minute, 30-minute)

§Sites and Channels

Site - Information about electricity sites linked to your account
Channel - Power meter channels (General, Controlled Load, Feed In)
ChannelType - Types of meter channels
SiteStatus - Status of sites (Pending, Active, Closed)

§Pricing Data

Interval - Electricity pricing intervals (Actual, Forecast, Current)
BaseInterval - Common fields for all interval types
ActualInterval - Confirmed historical pricing data
ForecastInterval - Predicted future pricing data
CurrentInterval - Real-time pricing data
PriceDescriptor - Price categories (extremely low, low, neutral, high, spike)
SpikeStatus - Spike warning indicators
Range - Price ranges when volatile
AdvancedPrice - Advanced price prediction with confidence bands

§Usage Data

Usage - Historical electricity consumption and generation data
UsageQuality - Data quality indicators (Estimated, Billable)

§Renewable Energy

Renewable - Renewable energy data (Actual, Forecast, Current)
BaseRenewable - Common fields for renewable data
ActualRenewable - Confirmed historical renewable values
ForecastRenewable - Predicted future renewable values
CurrentRenewable - Real-time renewable values
RenewableDescriptor - Renewable energy levels (best, great, ok, not great, worst)

§Tariff Information

TariffInformation - Time-of-use and demand tariff details
TariffPeriod - Time periods (off peak, shoulder, solar sponge, peak)
TariffSeason - Seasonal variations (Summer, Winter, etc.)

§Date and Time Handling

All datetime fields use the jiff crate for robust datetime handling:

jiff::civil::Date for date-only fields (ISO 8601 dates)
jiff::Timestamp for datetime fields (ISO 8601 timestamps)

Structs§

ActualInterval: Actual interval with confirmed pricing.
ActualRenewable: Actual renewable data.
AdvancedPrice: Advanced price prediction.
BaseInterval: Base interval structure containing common fields.
BaseRenewable: Base renewable data structure.
Channel: Describes a power meter channel.
CurrentInterval: Current interval with real-time pricing.
CurrentRenewable: Current renewable data.
ForecastInterval: Forecast interval with predicted pricing.
ForecastRenewable: Forecast renewable data.
Range: When prices are particularly volatile, the API may return a range of NEM spot prices (c/kWh) that are possible.
Site: Site information.
TariffInformation: Information about how your tariff affects an interval.
Usage: Usage data for a specific interval.

Enums§

ChannelType: Meter channel type.
Interval: Interval enum that can be any of the interval types.
PriceDescriptor: Describes the current price.
Renewable: Renewable enum that can be any of the renewable types.
RenewableDescriptor: Describes the state of renewables.
Resolution: Valid interval resolution options.
SiteStatus: Site status.
SpikeStatus: Spike status.
State: Valid Australian states for renewable energy data.
TariffPeriod: Time of Use period.
TariffSeason: Time of Use season.
UsageQuality: Usage data quality.