rewiringamerica-rem 1.3.2
Residential Electrification Model API
License: Apache 2.0
Requires Python: <4.0,>=3.8
Keywords: OpenAPI, OpenAPI-Generator, Residential Electrification Model API

# rewiringamerica-rem
An API for REM, the Residential Electrification Model.

Rewiring America's other APIs can be found [at our main API site](https://api.rewiringamerica.org/).

Example code demonstrating how to use the APIs can be found in the [api_demos](https://github.com/rewiringamerica/api_demos) Github repo.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.3.2
- Package version: 1.3.2
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit [https://www.rewiringamerica.org/](https://www.rewiringamerica.org/)

## Requirements.

Python 3.8+

## Installation & Usage
### pip install

You can install using:

```sh
pip install rewiringamerica_rem
```

Then import the package:
```python
import rewiringamerica_rem
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import rewiringamerica_rem
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

[Sign up for an API key](https://homes.rewiringamerica.org/api/developer-login) and follow the [installation procedure](#installation--usage).
Then, run the following:

```python

import rewiringamerica_rem
from rewiringamerica_rem.rest import ApiException
from pprint import pprint
import os


# 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 full address for a location including street number and name, city, state, and zip code.

    try:
        # Get home profile by address
        api_response = api_instance.get_home_profile_by_address(address)
        print("The response of get_home_profile_by_address:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling get_home_profile_by_address: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BuildingProfilerApi* | [**get_home_profile_by_address**](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/BuildingProfilerApi.md#get_home_profile_by_address) | **GET** /api/v1/building-profile/address | Get home profile by address
*BuildingProfilerApi* | [**get_home_profile_by_address_components**](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/BuildingProfilerApi.md#get_home_profile_by_address_components) | **POST** /api/v1/building-profile/address-components | Get home profile by address components
*ResidentialElectrificationModelApi* | [**get_by_address**](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ResidentialElectrificationModelApi.md#get_by_address) | **GET** /api/v1/rem/address | Get by address
*ResidentialElectrificationModelApi* | [**get_by_profile**](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ResidentialElectrificationModelApi.md#get_by_profile) | **POST** /api/v1/rem/profile | Get by profile
*ResidentialElectrificationModelApi* | [**get_impl_version**](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ResidentialElectrificationModelApi.md#get_impl_version) | **GET** /api/v1/rem/server_version | Get implementation version


## Documentation For Models

 - [AddressComponentRequest](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/AddressComponentRequest.md)
 - [BuildingFeatures](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/BuildingFeatures.md)
 - [BuildingProfile](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/BuildingProfile.md)
 - [FuelRate](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/FuelRate.md)
 - [FuelSavings](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/FuelSavings.md)
 - [HTTPValidationError](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/HTTPValidationError.md)
 - [HeatingFuel](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/HeatingFuel.md)
 - [ImpactMetric](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ImpactMetric.md)
 - [MetricStatistics](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/MetricStatistics.md)
 - [Quantity](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/Quantity.md)
 - [RemProfileRequest](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/RemProfileRequest.md)
 - [ResultFuelType](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ResultFuelType.md)
 - [SamplingDetails](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/SamplingDetails.md)
 - [Savings](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/Savings.md)
 - [SupportedUpgrade](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/SupportedUpgrade.md)
 - [ValidationError](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ValidationError.md)
 - [ValidationErrorLocInner](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/ValidationErrorLocInner.md)
 - [WaterHeaterFuel](https://github.com/rewiringamerica/ra-api-rem-py/blob/main/docs/WaterHeaterFuel.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Sign up for an API key [here](https://homes.rewiringamerica.org/api/developer-login).

Authentication schemes defined for the API:
<a id="auth"></a>
### auth

- **Type**: Bearer authentication


## Author

datascience@rewiringamerica.org