Solar Evaluation API (v1)

Download OpenAPI specification:Download

Solar Evaluation Tool provides an instant evaluation including payback period, energy bill cost savings, carbon impact metrics and a recommended solar system. The tool uses Accurassi’s patent AI technology to identify the optimal roof space on customer’s property and augment solar panels on the property image.

/analysis

Analyse a property for solar evaluation. For most accurate results a base64 encoded PDF should be passed in the body of the endpoint. This allows the user's consumption and payments to be used in the solar evaluation. Instead of a bill an address can be passed. This will use distributor benchmark data for household yearly consumption and spend.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

ebillBase64	string Base64 Encoded native PDF Australian Domestic Electricity Bill
address	string Australian residential property address
minPanelGroup	number Default: 4 Minimum size allowed for a group of panels
maxPanelGroup	number Default: "Infinity" Mamimum size allowed for a group of panels
	object Solar panel properties
continueIfPropertyDetailsFail	boolean Default: false The solar tool uses a number of data layers to provide an accurate evaluation. One of those data layers provides details on the property. If this layer fails it is possible to continue however the roof analysis may not be as accurate.
	object Removes roof panels from consideration if they are facing a cardinal direction

Responses

Request samples

Payload

Content type

application/json

{"ebillBase64": "string",
"address": "string",
"minPanelGroup": 4,
"maxPanelGroup": 24,
"panel": {"width": 1,
"height": 1.7,
"tilt": 31,
"gap": 0.15,
"minPercentageOnRoof": 0.9
},
"continueIfPropertyDetailsFail": false,
"ignoreRoofsFacing": {"north": false,
"south": true,
"east": false,
"west": false
}
}

Response samples

Content type

application/json

{"correlationId": "string",
"roofs": [{"bounds": [[[123,
456
]
]
],
"orientation": -30.256437163529263,
"area": 100,
"panels": 4,
"annualProductionOfSinglePanel": 426
}
],
"propertyDetails": {"buildings": [{"area": 100,
"averageEaveHeight": 3.2,
"estimatedLevels": 1,
"maximumRoofHeight": 3.89,
"overhangingTrees": false,
"roofMaterial": "Tile",
"solarPanels": true
}
],
"swimmingPool": true,
"address": "23 Some Street, Some Suburb, NSW 2076",
"postCode": "2000"
},
"propertyDetailsFailed": true
}

/quote

Creates quotes for configurable solar installation sizes based on the available roof space.

header Parameters

clientCode required	string This value will be provided by Accurassi during on-boarding.
clientID required	string This value will be provided by Accurassi during on-boarding. The clientID is paired with clientCode and used for authentication. This value should never be published on a public facing site.

Request Body schema: application/json

correlationId required	string correlationId returned from valid/analysis
panelOutput	number Default: 0.35 Output of the panel in kWh
installationCost	number Default: 3000 Installation cost independent of panels.
stcPrice	number Default: 36 STC price
feedInTariff	number Default: 0.1 Feed in tariff, in dollars, to apply to solar generation that is not consumed by the user
solarPanelCost	number Default: 250 The cost, in dollars, of each solar panel
consumption	number [ 0 .. 1 ] Default: 0.42 Percentage of generated power that the user will consume.
installStaticSize	number Size, in kWh, of a static sized system to try and install on the roof.
installPercentageOfConsumption	number [ 0 .. 1 ] Max fit the installation of a percentage of the user's consumption.
	Array of objects If the analysis stage failed, it is still possible to generate a quote using a passed in system configuration
	object For address entry some high level consumption and cost data can be passed to the quote. This data will be ignored if a bill was uploaded.

Responses

Request samples

Payload

Content type

application/json

{"correlationId": "e3c989bc-fac5-47ac-b9a7-71111111111",
"panelOutput": 0.35,
"installationCost": 3000,
"stcPrice": 36,
"feedInTariff": 0.1,
"solarPanelCost": 250,
"consumption": 0.42,
"installStaticSize": 6.6,
"installPercentageOfConsumption": 0.8,
"fallbackSystem": [{"count": 22,
"orientation": 0
}
],
"billData": {"estimatedAnnualConsumption": 12589,
"estimatedAnnualCost": 4589.36
}
}

Response samples

Content type

application/json

{"correlationId": "string",
"quoteId": "string",
"systemProduction": {"annualTotal": 1906,
"monthlyAverages": [27.228685015290523,
23.451315345699836,
18.906989247311817,
13.477428571428572,
9.10499231950845,
7.828079365079367,
8.569093701996932,
11.76125960061445,
15.88904761904764,
20.64552995391706,
23.19853968253966,
25.260752688172026
]
},
"system": [{"id": "string",
"count": 12,
"orientation": 0,
"efficiency": 0
}
],
"consumption": {"annualConsumption": 0,
"selfConsumption": 0
},
"cost": {"subtotal": 2452.44,
"gst": 254.24,
"stc": 547.56,
"annualBillSavings": 1200
},
"panelCount": 4,
"payback": 4.1,
"installationSize": 1.56,
"coalAvoided": 2.5,
"stcCount": 14.1
}

/image

Returns image of the analysed roof

path Parameters

correlationId required	string CorrelationId returned in analysis
quoteId required	string QuoteId returned in quote

Responses

Response samples

Content type

application/json

{"errorCode": 1000,
"errorMessage": "string"
}