Lookup

Overview

Certain properties have corresponding values that change over time. These properties are often used in rates where the rate amounts change frequently.

Data Definitions

Lookup

Lookup has the following data structure.

Name Type Fields Description
keyName String M The unique name for this property.
subKeyName String M subproperty name for this property.
fromDateTime DateTime M Date Range - from date time
toDateTime DateTime M Date Range - from date time
value Decimal M kWh/kW price for the property key
lastUpdatedDate DateTime M Last updated date for the lookup

Operations

Get Property Lookups

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

Resource URI

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

Request Parameters

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

Example

GET /rest/public/properties/hourlyPricingRealTimeERCOT/lookups
{
    "status": "success",
    "count": 2112,
    "type": "PropertyLookup",
    "results": [
    {
        "lookupId": 7858232,
        "propertyKey": "hourlyPricingRealTimeERCOT",
        "subPropertyKey": "AEN",
        "fromDateTime": "2015-03-08T00:00:00",
        "toDateTime": "2015-03-08T00:15:00",
        "bestValue": 0.01475,
        "bestAccuracy": 0,
        "actualValue": 0.01475,
        "lseForecastValue": null,
        "lseForecastAccuracy": null,
        "forecastValue": null,
        "forecastAccuracy": null
    },
    {
        "lookupId": 7858233,
        "propertyKey": "hourlyPricingRealTimeERCOT",
        "subPropertyKey": "AEN",
        "fromDateTime": "2015-03-08T00:15:00",
        "toDateTime": "2015-03-08T00:30:00",
        "bestValue": 0.0154,
        "bestAccuracy": 0,
        "actualValue": 0.0154,
        "lseForecastValue": null,
        "lseForecastAccuracy": null,
        "forecastValue": null,
        "forecastAccuracy": null
    },

    /* edited for space*/
}

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
keyName String Property key name (Optional).
subKeyName String Subproperty key name (Optional)
fromDateTime DateTime Date range - from value (Optional).
toDateTime DateTime Date range - to value (Optional)

Example

GET /rest/public/properties/lookups
{
     lookupId: 88340,
     propertyKey: "2007SantaFeCountyUndergroundProjectsRiderSC1a1b",
     subPropertyKey: "",
     fromDateTime: "2013-02-25T00:00:00",
     toDateTime: null,
     bestValue: 0.53,
     bestAccuracy: 0,
     actualValue: 0.53,
     lseForecastValue: null,
     lseForecastAccuracy: null,
     forecastValue: null,
     forecastAccuracy: null
},
{
     lookupId: 88341,
     propertyKey: "2007SantaFeCountyUndergroundProjectsRiderSC2a2b",
     subPropertyKey: "",
     fromDateTime: "2013-02-25T00:00:00",
     toDateTime: null,
     bestValue: 1.7,
     bestAccuracy: 0,
     actualValue: 1.7,
     lseForecastValue: null,
     lseForecastAccuracy: null,
     forecastValue: null,
     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/{keyName}/stats

Request Parameters

Name Type Description
keyName String Property key name.

Example

GET /rest/public/properties/hourlyPricingRealTimeERCOT/stats
{
    "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