Calculate Custom Economy Schema

NameData TypeDescription
as1-5totFloatFor Battery: Placeholders for up to 6 Ancillary Services total revenue amounts. The Names of the Ancillary Services are in the AS_columns collection
AS_ColumnsCollectionEach ISO has different Ancillary Services; This collection contains the names of those Services
retailMonthlyCostsCollectionCollection of monthly retail costs; Contains a floating point price
wholesaleMonthlyDemandCostsCollectionCollection of monthly wholesale demand costs; Contains a floating point price
totalFeedInkWhFloatTotal feed-in rate in kWh
building_filenameStringSelected building when using NREL building usage
monthlyDemandComponentsCollectionCollection of monthly demand components
averageNextDayTrailing12MonthPriceFloatAverage next day trailing 12 month price
usageCollectionCollection of usage data; “EPOCH”: VALUE
wholesaleAnnualCostsCombinedFloatAnnual combined wholesale costs
monthlyEnergyComponentsCollectionCollection of monthly energy components
wholesaleMonthlyCostsCollectionCollection of monthly wholesale costs; Contains a floating point price
wholesaleMonthlyDistributionCostsCollectionCollection of monthly wholesale distribution costs; Contains a floating point price
passThruComponentsCollectionCollection of pass thru components
batteryMonthlyCostsCollectionCollection of monthly battery costs; Contains a floating point price
building_urlString
warningString
monthlyfixedCustomerChargeCollectionCollection of monthly fixed customer charges; Contains a floating point price
calculationValuesPerHourCollectionCollection of hourly calculation values
retailAnualCostsCombinedFloatTotal combined annual retail costs
wholesaleAnualCostsFloatAnnual wholesale costs
monthlyfixed4CPChargeCollection…; Contains a floating point price
retailMonthlyDemandCostsCollectionCollection of monthly retail demand costs; Contains a floating point price
demandChargeBasisCollectionSee https://www.claritygrid.net/api-basis/
availableBatteriesCollectionCollection of available batteries
averageNextDayDayaheadPriceFloatAverage next-day dayahead price
distributionChargeBasisCollectionSee https://www.claritygrid.net/api-basis/
wholesaleMonthlyCapacityCostCollectionCollection of monthly wholesale capacity costs; Contains a floating point price
energyChargeBasisCollectionSee https://www.claritygrid.net/api-basis/
wholesalePricesCollectionCollection of wholesale prices; Contains prices organized by EPOCH values
batteryNetSavingsCollectionCollection of battery net savings; Contains a floating point price
customerChargeBasisCollectionSee https://www.claritygrid.net/api-basis/
batteryChargingHoursCollectionCollection of battery charging hours
monthlyDistributionComponentsCollectionCollection of monthly distribution components
ppacostIntegerRFU
retailAnualCostsFloatTotal annual retail costs
monthlyPPACollectionRFU
usage_by_monthCollectionCollection of usage by month
retailMonthlyDistributionCostsCollectionCollection of monthly retail distribution costs
traceTextCollectionCollection of trace text; shows results of calculations
batteryDispatchHoursCollection

Charge Components

NameData TypeDescription
component_typeStringType of component
componentsCollectionCollection of components
monthIntegerRFU

Components

NameData TypeDescription
monthIntegerRFU
priceFloatPrice of the component; Not used in calculations
labelStringLabel of the component

Hourly Calculation Values

NameData TypeDescription
as_1FloatFor Battery: hourly ancillary service totals
as_2Float
as_3Float
as_4Float
as_5Float
as_6Float
demandChargeFloatCalculated demand charge
timeOfUsageStringHour calculations are for
usageFloatTotal usage for the hour
nodePriceFloatWholesale price at node
energyChargeFloatCalculated energy charge
distributionChargeFloatCalculated distribution charge
nonSeePeeFloatRFU
capacityRateFloatCapacity rate
capacityChargeFloatCapacity amount

Available Batteries

NameData TypeDescription
durationIntegerCharge / discharge duration in hours
charging_kwhIntegerBatteries in this collection
costFloat
nameString
disch_kwhInteger
idIntegerInternal battery id

Trace Text

NameData TypeDescription
MonthStringMonth of calculation data
TracesCollectionCollection of trace information; shows results of calculations
{
	"as1tot": 0,                                                  For Battery: Placeholders for up to 6 
	"as2tot": 0,                                                  Ancillary Services total revenue 
	"as3tot": 0,                                                  amounts. The Names of the ancillary
	"as4tot": 0,                                                  services are in the AS_columns collection.
	"as5tot": 0,                                                  
	"as6tot": 0,                                                  Each ISO has different ancillary services
        "AS_columns": [                                               
		"",
		"",
		"",
		"",
		"",
		""
	],

	"retailMonthlyCosts": [                                       Collection of monthly retail costs
		2050.9999985444489
	],
	"wholesaleMonthlyDemandCosts": [                              Collection of monthly wholesale demand costs
		549.3451317547849
	],
	"totalFeedInkWh": 0,                                          Total feed-in rate in kWh
	"building_filename": "",                                      Selected building when using NREL building usage
	"monthlyDemandComponents": [                                  Collection of monthly demand components
		{
			"component_type": "Demand1",                  Type of component
			"components": [],                             Collection of component objects
			"month": 0                                    RFU
		},
		...
	],
	"averageNextDayTrailing12MonthPrice": 0,                      Average next day trailing 12 month price
	"usage": {                                                    Collection of usage data
		"1671145200000": 4.638801935483853,                   "EPOCH": Value
		...
	},
	"wholesaleAnualCostsCombined": 875.5206316335008,             Annual combined wholesale costs
	"monthlyEnergyComponents": [                                  Collection of monthly energy components
		{
			"component_type": "Energy",                   List of sub components 
			"components": [                               Collection of component objects
				{
					"month": 0,                   RFU
					"price": 0.1216,              Price of the component; Not used in calculations
					"label": ""                   Label of the component
				},
				...
			],
			"month": 0                                    RFU
		}
	],
	"wholesaleMonthlyCosts": [                                    Collection of monthly wholesale costs
		0
	],
	"wholesaleMonthlyDistributionCosts": [                        Collection of monthly wholesale distribution costs
		326.1754998787159
	],
	"passThruComponents": [                                       Collection of pass thru components
		{
			"component_type": "Iso Pass-Thru",            Type of component
			"components": [],                             Collection of component objects
			"month": 0                                    RFU
		}
	],
	"batteryMonthlyCosts": [                                      Collection of monthly battery costs
		0
	],
	"building_url": "",                                           ...
	"warning": "",                                                ...
	"monthlyfixedCustomerCharge": [                               Collection of monthly fixed customer charges
		155.2755
	],
	"calculationValuesPerHour": [                                 Collection of hourly calculation values
		{
			"as_1": 0,                                    For Battery: hourly ancillary services
			"as_2": 0,                                    totals
			"as_3": 0,                                    
			"as_4": 0,                                    
			"as_5": 0,                                    
			"as_6": 0,                                    
			"demandCharge": 0.7383671125736356,           Calculated demand charge
			"timeOfUsage": "2022-12-01 00:00:00",         Hour calculations are for
			"usage": 5.453170322580624,                   Total usage for the hour
			"nodePrice": 0,                               Wholesale price at node
			"energyCharge": 2.756720428151141,            Calculated energy charge
			"distributionCharge": 0.2297043009122526,     Calculated distribution charge
			"nonSeePee": 0,                               RFU
			"capacityRate": 0,                            Capacity rate
			"capacityCharge": 0                           Capacity Amount
		},
		...
	],
	"retailAnualCostsCombined": 2926.5206301779496,               Total combined annual retail costs
	"wholesaleAnualCosts": 0,                                     Annual wholesale costs
	"monthlyfixed4CPCharge": [                                    ...
		0
	],
	"retailMonthlyDemandCosts": [                                 Collection of monthly retail demand costs
		549.3451317547849
	],
	"demandChargeBasis": [                                        See https://www.claritygrid.net/api-basis/
		"peak_kw"
	],
	"availableBatteries": [                                       Collection of available batteries. 
		{
			"duration": 2,                                Charge / discharge duration in hours
			"charging_kwh": 25,                           batteries in this collection
			"cost": 0,                                    ...
			"name": "25Kw. 2 Hour",                       ...
			"disch_kwh": 25,                              ...
			"id": 41                                      Internal battery id
		},
		...
	],
	"averageNextDayDayaheadPrice": 0,                             Average next-day dayahead price
	"distributionChargeBasis": [                                  See https://www.claritygrid.net/api-basis/
		"kwh"
	],
	"wholesaleMonthlyCapacityCost": [                             Collection of monthly wholesale capacity costs
		0
	],
	"energyChargeBasis": [                                        See https://www.claritygrid.net/api-basis/
		"kwh"
	],
	"wholesalePrices": {                                          Collection of wholesale prices
		"1671145200000": 0,                                   "EPOCH": value
		...
	},
	"batteryNetSavings": [                                        Collection of battery net savings
		0
	],
	"customerChargeBasis": [                                      See https://www.claritygrid.net/api-basis/
		"fixed"
	],
	"batteryChargingHours": [],                                   Collection  of battery charging hours
	"monthlyDistributionComponents": [                            Collection of monthly distribution components
		{
			"component_type": "Distribution",             ...
			"components": [                               Collection of component objects
				{
					"month": 0,                   RFU
					"price": 0.01085,             Price of the component; Not used in calculations
					"label": ""                   Label of the component
				},
				...
			],
			"month": 0                                    RFU
		}
	],
	"ppacost": 0,                                                 RFU
	"retailAnualCosts": 2050.9999985444489,                       Total annual retail costs
	"monthlyPPA": [                                               RFU
		0
	],
	"usage_by_month": [],                                         Collection of usage by month
	"retailMonthlyDistributionCosts": [                           Collection of monthly retail distribution costs
		326.1754998787159
	],
	"traceText": [                                                Collection of trace text objects
		{
			"Month": "2022-12",                           Month of calculation data
			"Traces": [                                   Collection of trace information
				"Effective Date 2022-04-01~~~~~~",
				"~~~~Charge Description~Charge Type~Rate",
				"~~1~$155.27550~Network access charge($)|,~c.t~155.2755",
				"~~9999.999993~~DUOS Distribution Charge($/kWh)|(0-+),,~d.1~0.01085",
				"~~9999.999993~~DPPC Distribution Charge($/kWh)|(0-+),,~d.1~0.00224",
				"~~9999.999993~~JS Distribution Charge($/kWh)|(0-+),,~d.1~0.004",
				"~~9999.999993~$170.90000~NUOS Total Distribution Charge($/kWh)|(0-+),,~d.t~0.01709",
				"~~9999.999993~~Energy Wholesale($/kWh)|(0-+),,~e.1~0.1216",
				"~~9999.999993~~Enviromental Cost($/kWh)|(0-+),,~e.1~0.0188",
				"~~9999.999993~~Retail Allowance($/kWh)|(0-+),,~e.1~0.0529",
				"~~9999.999993~~Retail Cost($/kWh)|(0-+),,~e.1~0.0118",
				"~~9999.999993~$2051.00000~Total Energy($/kWh)|(0-+),,~e.t~0.2051",
				"2022-12-16 06:00~33.199917419354705~33.199917~$394.67331~DUOS Actual Demand ($/kW)|(0-+),,~dc.t~11.88778",
				"2022-12-16 06:00~33.199917419354705~33.199917~$105.35429~DPPC Actual Demand ($/kW)|(0-+),,~dc.t~3.17333",
				"2022-12-18 16:00~18.582337419354765~18.582337~$49.31752~Excess Demand ($/kW)|(0-+),,,(,(16:00-20:00),(SN-S)~dc.t~2.654"
			]
		}
	],
	"batteryDispatchHours": []                                    ...
}

rev 1.0 2023-02-13