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

number

Required for weekly aggregations: Week number between 1 and 53

number

Required for monthly aggregations: Month number between 1 and 12

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
countries
array of strings
Defaults to all

Filter on countries

countries
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 28 days ago

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 28 days ago