Back to All

New Dispatch API v2 & ELRP Support via API

about 1 year ago by Shaun Tamblin

Why Migrate to Dispatch API version 2

  • More easily prioritize multiple same-day or overlapping dispatches if you are unable to respond to all event timeslots
  • More easily track unique events with the new event UUID
  • Increase revenue by using new fields designed to help optimize dispatch strategies and performance
  • Enable ELRP (CAISO) via API for automated dispatching

📘

All other endpoints remain at v1.1

No other API endpoints (e.g. meters, bids) are being updated at this time. These will remain at v1.1.


What’s Changing

🚧

UPDATE - 4/21/23: The "2. Changes to event notifications" section below has been updated with the new dispatch_event_types field to replace the current test_event and market_type fields.

UPDATE - 5/22/23: event_id has been replaced with meter_event_id & market_group_event_id to provide better distinction between meter and group events. Additionally, a behavior change in how cancelled events are handled when polling the Dispatch API was added to section "2. Changes to event notifications".

  1. Simplified URL path structure - for example:

  2. Changes to event notifications:

    • meter_event_id & market_group_event_id added to differentiate unique events
      • This replaces the previous unique event definition of meter/group ID + event start_time and allows for the possibility of multiple unique events starting at the same time (e.g. DRAM/CCA award + ELRP event both starting at 5pm)
    • Timeslots array - new fields to help maximize revenue:
      • priority - To prioritize multiple same-day events if all cannot be responded to
      • is_voluntary - To differentiate events that are voluntary vs. market/program commitments that may carry non-performance penalties
      • performance_compensation_cap - To determine when over-performance and grid exports are compensated for
      • dispatch_event_types - To consolidate the 2 fields being removed below and to be used for any programs that have different compensation structures for different types of dispatch events (e.g. CAISO DRAM/CCA capacity-test & day-ahead award for the same dispatch event). All non-DRAM/CCA programs currently have a single compensation structure and will be listed with a value of standard.
    • Timeslots array - removed fields:
      • test_event is being removed and will instead be highlighted in the dispatch_event_types array noted above with a value of capacity-test whenever a capacity test event has been scheduled
      • market_type is being removed and will instead be highlighted in the dispatch_event_types array noted above with possible values of day-ahead, hour-ahead, 15m, and 5m
    • Timeslots array - behavior change when polling Dispatch API endpoint
      • In v1.1, any cancelled events would be removed from the dispatch API responses so you would never see a cancelled field set to true. However, to provide better visibility into cancelled events in v2, all cancelled events will remain in the response with this field set to true.

    📘

    See the new Dispatch Automation (v2) guide for more details and specifically the Dispatch Strategies section for guidance on how to use these new and fields.

  3. New search dispatches filter options

    • meter_event_ids & market_group_event_ids - to search for a defined list of events
    • exclude_voluntary_events - to search for required events only

Check out the new dispatch API v2 reference file for more details.


ELRP Dispatch API Support Added in v2

The unique meter_event_id & market_group_event_id addition noted above allows for overlapping dispatches and multiple events starting at the same time. This allows for ELRP dispatch API support to be added to v2. Those sticking with the current v1.1 dispatch integration will need to receive and process ELRP events this summer through email notifications.

📘

Null Energy kW Value

The energy value for an ELRP event will be null since it is a voluntary pay-for-performance program and there is not an expected or nominated energy value for the program. In these cases, it is expected that you curtail or export as much as you are able to up to the performance_compensation_cap limit.


Timeline

This dispatch v2 API is targeted to be ready for testing in June 2023 with a full release shortly thereafter. It is recommended that you scope these dispatch integration changes and get this added to your Q2 roadmap in order to maximize revenue potential during the lucrative Q3 summer months.

For partners that are not able to migrate at this time, we will continue to support the current version of the API through the end of 2023. Please note, however, that ELRP events will only be dispatched manually through email notifications in this case as they cannot be supported in the v1 API.


🚧

Reminder About API Keys & New FQDNs

While making these integration changes to migrate to the v2 dispatch API, it is recommended to also update your Leap integrations to leverage the new API key support and move to the new production and staging FQDNs.