Skip to main content

Settlement API Overview

Base route: /consumption/v1

Authentication:

  • Header X-API-KEY is required on all endpoints.

Endpoints​

  • GET /consumption/v1/{mpid}: retrieve settlement consumption runs.
  • GET /consumption/v1/{mpid}/defaulted: retrieve defaulted settlement runs (IF-013 style output).
  • GET /consumption/v1/{mpid}/load-shapes/period: retrieve latest LSS period data for a settlement date.
  • GET /consumption/v1/{mpid}/load-shapes/totals: retrieve latest LSS totals data for a settlement date.
  • GET /consumption/v1/{mpid}/load-shapes/received-on-or-after: retrieve LSS updates received on or after a timestamp.

Docs in this section​