Skip to main content

Residential Electrification Model API

Project description

rewiringamerica-rem

An API for REM, the Residential Electrification Model.

Rewiring America's other APIs can be found at our main API site.

Example code demonstrating how to use the APIs can be found in the api_demos Github repo.

This Python package is automatically generated by the OpenAPI Generator 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/

Requirements.

Python 3.8+

Installation & Usage

pip install

You can install using:

pip install rewiringamerica_rem

Then import the package:

import rewiringamerica_rem

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rewiringamerica_rem

Tests

Execute pytest to run the tests.

Getting Started

Sign up for an API key and follow the installation procedure. Then, run the following:

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 GET /api/v1/building-profile/address Get home profile by address
BuildingProfilerApi get_home_profile_by_address_components POST /api/v1/building-profile/address-components Get home profile by address components
ResidentialElectrificationModelApi get_by_address GET /api/v1/rem/address Get by address
ResidentialElectrificationModelApi get_by_profile POST /api/v1/rem/profile Get by profile
ResidentialElectrificationModelApi get_impl_version GET /api/v1/rem/server_version Get implementation version

Documentation For Models

Documentation For Authorization

Sign up for an API key here.

Authentication schemes defined for the API:

auth

  • Type: Bearer authentication

Author

datascience@rewiringamerica.org

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rewiringamerica_rem-1.3.2.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

rewiringamerica_rem-1.3.2-py3-none-any.whl (56.0 kB view details)

Uploaded Python 3

File details

Details for the file rewiringamerica_rem-1.3.2.tar.gz.

File metadata

  • Download URL: rewiringamerica_rem-1.3.2.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for rewiringamerica_rem-1.3.2.tar.gz
Algorithm Hash digest
SHA256 17331dd76e21a522280f77f9b8c4f43010d6438625b20d22e95b857626f13e85
MD5 5e2994779335e6356e432ceca9c01886
BLAKE2b-256 1f298051a4fbcf614a1bc59dd82b618baa33dc53dcace7e6b8eec8e751b48f43

See more details on using hashes here.

File details

Details for the file rewiringamerica_rem-1.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for rewiringamerica_rem-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7d19dc49e214e49c423ca0c68065b263d8c171999b93ee8552962fd5c55bb289
MD5 21550be020b3f7b5385736d9ec3f69d6
BLAKE2b-256 e6b986f0a893560fae5ca0fda4d3aea6a2c0403ff9e09c3bd9f87f4b18e08dbe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page