Electricity Maps

DEFINE ROUTE ElectricityMapsApi WITH TYPE REST_API
    ADD REST_API_CONFIG
        WITH BASE_ADDRESS "https://api.electricitymaps.com"
        WITH ENABLE_CLIENT "true"
        WITH USE_SSL "true"
        WITH REQUEST_TIMEOUT '30'
        WITH DEFAULT_CONTENT_TYPE "application/json"
        # Smoke: GetZone (lat/lon Porto, token "") -> ListZones (with token) -> GetCarbonIntensityLatest (zone=PT) -> GetElectricityMixLatest -> GetCarbonIntensityForecast.
    ADD EVENT ListZones
        WITH SOURCE_TOPIC "energy/electricitymaps/zone/list"
        WITH DESTINATION_TOPIC "energy/electricitymaps/zone/list/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/v4/zones"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "auth-token" "{value.json.token}"
            ADD "User-Agent" "Coreflux-Broker REST_API route (https://www.coreflux.org)"
    ADD EVENT GetZone
        WITH SOURCE_TOPIC "energy/electricitymaps/zone/get"
        WITH DESTINATION_TOPIC "energy/electricitymaps/zone/get/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/v4/zone?{value.json.query}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "auth-token" "{value.json.token}"
            ADD "User-Agent" "Coreflux-Broker REST_API route (https://www.coreflux.org)"
    # ... 33 more events in the package file (ElectricityMapsRestApi.lot)

# Example actions for the ElectricityMapsApi route (docs page). Not part of the route template.
# Secret: ELECTRICITY_MAPS_TOKEN = the API key from the Electricity Maps portal (sent as the auth-token header).
# Zone PT = Portugal (mainland grid, Tier A). Replace it with your own zone key (ListZones / GetZone).
# Inline JSON object literals are not supported when publishing to a topic, so the request payload is a COLLAPSED
#   model sent with PUBLISH MODEL.
# Budget: about 4 + 1 + 1 + 0.04 = 6 calls per hour. Hourly data changes once an hour; 15-minute polling only
#   helps with temporalGranularity=15_minutes or 5_minutes on plans that include them.

DEFINE MODEL ElectricityMapsRequest COLLAPSED
    ADD STRING "token"
    ADD STRING "query"

DEFINE ACTION GridCarbonIntensityEvery15Minutes
ON EVERY 15 MINUTES DO
    PUBLISH MODEL ElectricityMapsRequest TO "energy/electricitymaps/carbon-intensity/latest/get" WITH
        token = (GET SECRET "ELECTRICITY_MAPS_TOKEN")
        query = "zone=PT&disableCallerLookup=true"

DEFINE ACTION GridMixHourly
ON EVERY 1 HOUR DO
    PUBLISH MODEL ElectricityMapsRequest TO "energy/electricitymaps/electricity-mix/latest/get" WITH
        token = (GET SECRET "ELECTRICITY_MAPS_TOKEN")
        query = "zone=PT&disableCallerLookup=true"

DEFINE ACTION GridCarbonForecastHourly
ON EVERY 1 HOUR DO
    PUBLISH MODEL ElectricityMapsRequest TO "energy/electricitymaps/carbon-intensity/forecast/get" WITH
        token = (GET SECRET "ELECTRICITY_MAPS_TOKEN")
        query = "zone=PT&horizonHours=24&disableCallerLookup=true"

DEFINE ACTION DayAheadPriceForecastDaily
ON EVERY 1 DAY DO
    PUBLISH MODEL ElectricityMapsRequest TO "energy/electricitymaps/price-day-ahead/forecast/get" WITH
        token = (GET SECRET "ELECTRICITY_MAPS_TOKEN")
        query = "zone=PT&horizonHours=48&disableCallerLookup=true"