API Reference

Pricing Aggregation endpoint

get
https://customer-api.prod.paren.app/metadata/v1/pricing/

Returns pricing aggregate data. This data includes the cost per kWh or per hour,
and the pricing model (for example Fixed or Time-Of-Use (TOU)).

Path Params
string
enum
required

Aggregation type

Allowed:
Query Params
number

Defaults to current year (weekly/monthly only)

number

Required for weekly aggregations: Week number between 1 and 53

number

Required for monthly aggregations: Month number between 1 and 12

string

Required for daily aggregations: Start date in YYYY-MM-DD format

string

Required for daily aggregations: End date in YYYY-MM-DD format (max 31 days from start_date)

integer
1 to 5000
Defaults to 5000

Limits the number of objects that are returned.

integer
≥ 0

Indicates the number of items to skip.

include
array of strings

Extra data that can be requested

include
Allowed:
countries
array of strings
Defaults to all

Filter on countries

countries
Allowed:
states
array of strings
Defaults to all

Filter on states or provinces of the location

states
location_ids
array of integers

Filter on IDs of the locations

location_ids
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?