eb_nordpool

Rust library for extracting elspot prices from nordpool.

Documentation

Test script that uses the cargo-watch command.

./run.sh

Run this command to print out additional debug info.

EB_NORDPOOL_DEBUG=1 ./run.sh

lib.rs:

eb_nordpool provides an easy way to extract elspot prices from Nordpool.

Load data from NordPool

use eb_nordpool::{
    elspot::{self, dataportal_dayaheadprices},
    error::ElspotError,
    units,
};

// Select date in "YYYY-MM-DD" format.
let date = "2024-10-24";
// Select currency.
let currency = "NOK";
// Select regions.
let regions = vec!["NO1", "SE3", "FI"]; // Must have at least one.
// or select all regions..
let mut regions: Vec<&str> = vec![];
for region in dataportal_dayaheadprices::regions::SUPPORTED_REGIONS.iter() {
    regions.push(region);
}
// NOTE: you can easily print out all supported currencies and regions..
dataportal_dayaheadprices::currencies::list_supported();
dataportal_dayaheadprices::regions::list_supported();

// Finally, download data.
let data = elspot::from_nordpool(currency, date, regions).unwrap();

Load data from file, json-string or url

use eb_nordpool::{
    elspot,
    error::ElspotError,
    units,
};

// Load data from local file.
let data = elspot::from_file("path/to/data.json").unwrap();

// Load data from json string.
let data = elspot::from_json("{..}").unwrap();

// Load data from url.
let data = elspot::from_url("http..").unwrap();

Extract data (and more stuff..)

// Once you have loaded the data with one of the two workflows above, we can do stuff.

// Get all prices for specific region (always in time ascending order starting at 00:00).
let prices = data.extract_prices_for_region("Oslo");
// ..returns a Vec<elspot::Price>

// Get price as &str.
let p = &prices[8];
let v = &p.value;
// Get price as numeric data types.
let p = &prices[8];
let f = p.as_f32();
let i = p.as_i32();

// Pretty print price (label like). Looks like this: "NOK 167,68 Kr./MWh".
let p = &prices[8];
println!("{}", p.price_label());

// Get time window (from and to) for specific price in chrono's datetime type.
let p = &prices[0];
// Access values directly (Datetime in Utc).
let from = p.from;
let to = p.to;
// Get "from" and "to" adjusted for same timezone as the region for the prices.
let (from, to) = p.from_to();
// Get "from" and "to" adjusted for Utc.
let (from_utc_time, to_utc_time) = p.from_to_as_utc();
// Get "from" and "to" adjusted for region, for example Finland using region code "FI".
let (from_region_time, to_region_time) = p.from_to_with_region("FI");
// Get "from" and "to" adjusted for any timezone, for example Los Angeles using chrono_tz's tz type.
use chrono_tz::America::Los_Angeles;
let (from_la_time, to_la_time) = p.from_to_with_tz(Los_Angeles);

// Convert to other units (includes changing price value to accommodate for new units).
let mut prices = data.extract_prices_for_region("Oslo");
for mut p in prices.iter_mut() {
    // To fractional currency unit (from for example 'Kr.' to 'Øre').
    units::convert_to_currency_fraction(&mut p);
    // To smaller power unit (from "MWh" to "kWh").
    units::convert_to_kwh(&mut p);

    // And back again (uncomment lines below..).
    // units::convert_to_currency_full(&mut p);
    // units::convert_to_mwh(&mut p);
}
for p in prices.iter() {
    assert!(p.currency_unit.is_fraction());
    assert!(p.power_unit.is_kwh());
    println!("{}", p.price_label());
}

// Just get all prices for all regions in a 2D Array.
let regions = data.extract_prices_all_regions();
for prices in regions.iter() {
    for price in prices.iter() {
        println!("Time: {} - {} ({})", price.hour(), price.price_label(), price.region)
    }
}

// Get date for prices, formatted as "YYYY-MM-DD" (chrono's NaiveDate type).
data.date()

// Print out all available regions.
data.print_regions();

// Get all available regions in a Vec<&str>.
let regions = data.regions();

// Check if region exists in dataset.
if data.has_region("Oslo") {
    // ..do something
}

// Save data to file.
data.to_file("save/to/data.json");

// Serialize data to json string.
let s = data.to_json_string();