Certain properties have corresponding values that change over time. These properties are often used in rates where the rate amounts change frequently. The rate changes are often monthly but in some cases can be daily or even hourly.  We capture the rates in what we call lookup tables and we typically refer to them as lookup or variable rates. An example of a lookup rate is a monthly fuel cost adjustment, or daily market-based pricing.

Data Definitions

Lookup

Lookup has the following data structure.

Name Type Fields Description
lookupId Integer M The unique ID for this lookup for the date range
propertyKey String M The unique name for this property.
subPropertyKey String M subproperty name for this property.
fromDateTime DateTime M Date Range - from date time
toDateTime DateTime M Date Range - from date time
bestValue Decimal M Best kWh/kW price for the property key for the date range
bestAccuracy Decimal M Reserved for future use
actualValue Decimal M Actual kWh/kW price for the property key for the date range
lseForecastValue Decimal M kWh/kW price forecasted by the utility for the property key for the date range
lseForecastAccuracy Decimal M Reserved for future use
forecastValue Decimal M kWh/kW price forecasted by Genability for the property key for the date range based on previous Values
forecastAccuracy Decimal M Reserved for future use

Get Property Lookups

To get lookups for a property key use the following call. If a date range is not specified, it is defaulted to last 72 hours.

Resource URI

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

Request Parameters

Name Type Description
propertyKey String Property key name.
subPropertyKey String Subproperty Key Name
fromDateTime DateTime Date range - from value (Optional).
toDateTime DateTime Date range - to value (Optional)

Example 1 - Get All Lookup Choices for a PropertyKey

GET /rest/public/properties/hourlyPricingRealTimeERCOT/lookups
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
    "status": "success",
    "count": 384,
    "type": "PropertyLookup",
    "results": [
        {
            "lookupId": 19890442,
            "propertyKey": "hourlyPricingDayAheadERCOT",
            "subPropertyKey": "AEN",
            "fromDateTime": "2017-11-04T00:00:00",
            "toDateTime": "2017-11-04T01:00:00",
            "bestValue": 0.01783,
            "bestAccuracy": 0,
            "actualValue": 0.01783,
            "lseForecastValue": null,
            "lseForecastAccuracy": null,
            "forecastValue": null,
            "forecastAccuracy": null
        },
        {
            "lookupId": 19932102,
            "propertyKey": "hourlyPricingDayAheadERCOT",
            "subPropertyKey": "CPS",
            "fromDateTime": "2017-11-06T18:00:00",
            "toDateTime": "2017-11-06T19:00:00",
            "bestValue": 0.04826,
            "bestAccuracy": 0,
            "actualValue": 0.04826,
            "lseForecastValue": null,
            "lseForecastAccuracy": null,
            "forecastValue": null,
            "forecastAccuracy": null
        },
        {
            "lookupId": 19932109,
            "propertyKey": "hourlyPricingDayAheadERCOT",
            "subPropertyKey": "HOUSTON",
            "fromDateTime": "2017-11-06T01:00:00",
            "toDateTime": "2017-11-06T02:00:00",
            "bestValue": 0.01946,
            "bestAccuracy": 0,
            "actualValue": 0.01946,
            "lseForecastValue": null,
            "lseForecastAccuracy": null,
            "forecastValue": null,
            "forecastAccuracy": null
        },
        /* edited for space*/
    ],
    "pageCount": 25,
    "pageStart": 0
}

Example 2 - Get a Specific Choice for a PropertyKey

GET /rest/public/properties/hourlyPricingDayAheadERCOT/lookups?subKeyName=CPS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
    "status": "success",
    "count": 48,
    "type": "PropertyLookup",
    "results": [
        {
            "lookupId": 19932084,
            "propertyKey": "hourlyPricingDayAheadERCOT",
            "subPropertyKey": "CPS",
            "fromDateTime": "2017-11-06T00:00:00",
            "toDateTime": "2017-11-06T01:00:00",
            "bestValue": 0.01799,
            "bestAccuracy": 0,
            "actualValue": 0.01799,
            "lseForecastValue": null,
            "lseForecastAccuracy": null,
            "forecastValue": null,
            "forecastAccuracy": null
        },
        {
            "lookupId": 19932085,
            "propertyKey": "hourlyPricingDayAheadERCOT",
            "subPropertyKey": "CPS",
            "fromDateTime": "2017-11-06T01:00:00",
            "toDateTime": "2017-11-06T02:00:00",
            "bestValue": 0.01777,
            "bestAccuracy": 0,
            "actualValue": 0.01777,
            "lseForecastValue": null,
            "lseForecastAccuracy": null,
            "forecastValue": null,
            "forecastAccuracy": null
        },
        {
            "lookupId": 19932086,
            "propertyKey": "hourlyPricingDayAheadERCOT",
            "subPropertyKey": "CPS",
            "fromDateTime": "2017-11-06T02:00:00",
            "toDateTime": "2017-11-06T03:00:00",
            "bestValue": 0.0176,
            "bestAccuracy": 0,
            "actualValue": 0.0176,
            "lseForecastValue": null,
            "lseForecastAccuracy": null,
            "forecastValue": null,
            "forecastAccuracy": null
        },
        /* edited for space*/
    ],
    "pageCount": 25,
    "pageStart": 0
}

Get Lookups

The new Get Lookups endpoint doesn’t require that you specify a keyName to get back lookup values. If no fromDateTime and toDateTime is provided, the result set will be limited to property lookups effective in the last 72 hours.

Resource URI

GET /rest/public/properties/lookups

Request Parameters

Name Type Description
propertyKey String Property key name (Optional).
subPropertyKey String Subproperty key name (Optional)
fromDateTime DateTime Date range - from value (Optional).
toDateTime DateTime Date range - to value (Optional)

Example 3 - Get All Lookups

GET /rest/public/properties/lookups
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "lookupId": 7808815,
    "propertyKey": "2007SantaFeCountyUndergroundProjectsRiderSC3a3b",
    "fromDateTime": "2017-02-25T00:00:00",
    "toDateTime": "2018-02-25T00:00:00",
    "bestValue": 0,
    "bestAccuracy": null,
    "actualValue": null,
    "lseForecastValue": null,
    "lseForecastAccuracy": null,
    "forecastValue": 0,
    "forecastAccuracy": null
},
{
    "lookupId": 7808816,
    "propertyKey": "2007SantaFeCountyUndergroundProjectsRiderSC4B",
    "fromDateTime": "2017-02-25T00:00:00",
    "toDateTime": "2018-02-25T00:00:00",
    "bestValue": 0,
    "bestAccuracy": null,
    "actualValue": null,
    "lseForecastValue": null,
    "lseForecastAccuracy": null,
    "forecastValue": 0,
    "forecastAccuracy": null
},

Get Property Lookup Stats

This endpoint gives summary stats for a given property key (only "LOOKUP" type property keys are relevant here). It returns statistics like minFromDateTime, maxToDateTime, lookupCount, meanValue, totalDuration, lastUpdatedDate

Resource URI

GET /rest/public/properties/{propertyKey}/stats

Request Parameters

Name Type Description
propertyKey String Property key name.

Example 4 - Get Lookup Stats

GET /rest/public/properties/hourlyPricingRealTimeERCOT/stats
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
	"status": "success",
	"count": 1,
	"type": "PropertyKey",
	"results": [
	{
		"keyName": "hourlyPricingRealTimeERCOT",
		"minFromDateTime": 1293840000000,
		"maxToDateTime": 1425945600000,
		"lookupCount": 1172992,
		"meanValue": 0.03465241,
		"totalDuration": 17596800,
		"meanDuration": 15,
		"missingDuration": -15395040,
		"lastUpdatedDate": 1426032000000
	}]
}

History

  • Formatting updates - 3/10/2015
  • Initial Release - 9/8/2011 - Properties
  • Updated - 5/30/2012 - Renamed to Property Key (was Tariff Property)
  • Updated - 12/14/2012 - Added in Field view definitions
  • Updated - 6/2/2014 - Updated to include lookups
  • Updated - 8/19/2014 - Updated to include subProperty Keys and the new lookup endpoint
  • Updated = 1/7/2019 - Updated to include value descriptions