get
https://api.genability.com/rest/public/calendars/dates
Return actual dates for calendar events, filtered by calendar, utility, locale, date range, event type, or date definition type.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to return the actual dates for calendar events.
When to use this endpoint
Use GET /rest/public/calendars/dates when you need to:
- Retrieve holiday dates that may affect time-of-use pricing.
- Retrieve pricing period dates for dynamic events such as critical peaks or system peaks.
- Filter dates by calendar, LSE, locale, date range, event type, or date definition type.
Common filters
| Parameter | Type | Description |
|---|---|---|
calendarId | Long | Returns dates for one calendar. Use this when you already know the calendar you want. |
lseId | Long | Returns dates for calendars that belong to a specific LSE. You do not need to send this when using calendarId. |
locale | String | Filters by ISO country code, such as US. |
fromDateTime | DateTime | Returns event dates on or after this date. |
toDateTime | DateTime | Returns event dates on or before this date. |
calendarEventTypes | String | Comma-separated event types to include. Supported values are HOLIDAY, BILLING, and PRICING_PERIOD. |
dateDefinitionTypes | String | Comma-separated date definition types to include. Supported values are FIXED_DATE, MANUAL, FLOATING_DATE, and EASTER_DATE. |
Example request
GET /rest/public/calendars/datesExample response
{
"status": "success",
"count": 37381,
"type": "CalendarDate",
"results": [
{
"eventDateId": 2,
"subKey": null,
"eventName": "New Year's Day",
"startDateTime": "2010-01-01T00:00:00+00:00",
"endDateTime": null,
"calendarEventId": 2,
"lseId": 2654
},
{
"eventDateId": 2,
"subKey": null,
"eventName": "New Year's Day",
"startDateTime": "2010-01-01T00:00:00+00:00",
"endDateTime": null,
"calendarEventId": 2,
"lseId": 734
}
]
}