get
There are 3 valid combinations of query parameters for this endpoint:
- address: Pass the whole address as one string.
- street-name, city, state: Break the address up into at least the components.
- You can optionally include zip-code and street-number.
- lat, lon: Pass the location of the place as latitude/longitude coordinates.
Resource URL
https://apis.solarialabs.com/shine/v1 /total-home-scores/reports
Code Examples
Query Parameters
Name | Values | Description |
---|---|---|
address |
The entire address as one string (e.g. '1 Main Street, Boston MA, USA') |
|
street-number |
Street number of the address (e.g. '1') |
|
street-name |
Street name of the address (e.g. 'Main Street') |
|
city |
City name (e.g. 'Boston') |
|
state |
State name (as standard USPS 2-letter abbreviation, e.g. 'MA') |
|
zip-code |
ZIP code (e.g. '02129') |
|
lat |
Latitude of address |
|
lon |
Longitude of address |
|
apikey
(required) |
Your unique consumer key for the application in which you wish to use the data |
Request Body
Definitions
Name | Type | Description |
---|
Responses
Schema:
Errors
HTTP code | Description |
---|---|
400 |
Unable to handle request as received. Please validate request and try again. |
401 |
Unauthorized. |
404 |
Request not found. Please validate request and try again. |
500 |
Internal server error. |
Resource Summary
Attributes | |
---|---|
Security |
Expand the Query Parameters section and enter your consumer key ("apikey") and the values you'd like to try. Then, hit "Send Request".
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Working...