Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 2.7 KB

BuildingProfilerApi.md

File metadata and controls

78 lines (50 loc) · 2.7 KB

rewiringamerica_rem.BuildingProfilerApi

All URIs are relative to https://api.rewiringamerica.org

Method HTTP request Description
get_home_profile GET /api/v1/building_profiler/home Get Home Profile

get_home_profile

BuildingProfile get_home_profile(address)

Get Home Profile

Geocode an address and match against ATTOM data to find building features for a given residence. This implementation takes in an address as a required query parameter and returns geographic characteristics and building features about the home if the input address is valid. Parameters ---------- address: (str) The full address string for a location including street number and name, city, state, and zip code. Returns ------- BuildingProfile: JSON containing geographic information like county or state and building features like square footage or vintage for the residence located at the given address.

Example

  • Bearer Authentication (auth):
import rewiringamerica_rem
from rewiringamerica_rem.models.building_profile import BuildingProfile
from rewiringamerica_rem.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: auth
configuration = rewiringamerica_rem.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with rewiringamerica_rem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rewiringamerica_rem.BuildingProfilerApi(api_client)
    address = 'address_example' # str | The location of a home.

    try:
        # Get Home Profile
        api_response = api_instance.get_home_profile(address)
        print("The response of BuildingProfilerApi->get_home_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BuildingProfilerApi->get_home_profile: %s\n" % e)

Parameters

Name Type Description Notes
address str The location of a home.

Return type

BuildingProfile

Authorization

auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]