HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get Lookup

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve lookup table values for a LOOKUP property key.

Use this endpoint for property keys whose values are stored in lookup tables, such as hourly market prices or date-ranged fuel cost adjustment rates. If you do not pass a date range, the request defaults to the last 72 hours.

Resource URI

GET /rest/public/properties/{keyName}/lookups

Path parameters

ParameterTypeDescription
keyNameStringProperty key name for the lookup-backed property. Required.

Query parameters

ParameterTypeDescription
subKeyNameStringSub-property key name, such as a market node or zone. Optional.
fromDateTimeDateStart date for lookup values. Optional.
toDateTimeDateEnd date for lookup values. Optional.

For lookup data model details and response examples, see Lookups.

Example

GET /rest/public/properties/hourlyPricingDayAheadERCOT/lookups?subKeyName=CPS

A successful response returns a standard response payload with type set to PropertyLookup and results containing matching lookup values.

Path Params
string
required
Query Params
string

Subproperty key name

date

Date range - from value

date

Date range - to value

Responses

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