API Reference
API Reference

Create a new solar estimate request

post
https://api.portal.scanifly.com/api/v1/solar-estimate
Body Params

Data for creating the solar estimate

string
length ≤ 255

Optional caller-supplied external reference string

string
required
length ≤ 500

Full address for the estimate location

geocoordinates
object

Geographic coordinates (optional)

monthlyConsumption
array of numbers
length between 12 and 12

Monthly energy consumption in kWh (12 numbers, Jan=index 0)

monthlyConsumption
defaultConfig
object

Default estimate configuration (optional)

installerConfigs
array of objects

Installer-specific configurations (optional)

installerConfigs
boolean
Defaults to false

Build this estimate from Nearmap imagery instead of Google. Nearmap is not available everywhere: when it cannot be used the run falls back to Google rather than failing, and the estimate is billed for the imagery that was actually delivered, not the imagery that was requested. Requesting Nearmap reserves credits at the Nearmap rate, so a request can be refused with 402 even when the run would have fallen back to the cheaper source.

Responses

400

Bad Request - Invalid input data.

402

Payment Required - each estimate consumes credits from the company balance, and the request is refused before any processing starts when that balance cannot cover it. Add credits and retry; nothing is charged for a refused request.

Updated 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?