API DocumentationAPI Documentation
The Rewiring America API

Schemas

APICalculatorResponse

  • is_under_80_amiboolean · required
  • is_under_150_amiboolean · required
  • is_over_150_amiboolean · required
  • authoritiesobject · required
  • coverageobject · required
  • locationobject · required
  • incentivesobject[] · required
  • data_partnersobject

APIIncentive

  • payment_methodsstring[] · minItems: 1 · required
    Enum values:
    rebate
    pos_rebate
    tax_credit
    account_credit
    assistance_program
    performance_rebate
    unknown
  • authority_typestring · enum · required
    Enum values:
    federal
    city
    county
    state
    utility
    gas_utility
    other
  • programstring · required
  • program_urlstring · required
  • itemsstring[] · required
    Enum values:
    air_sealing
    air_to_water_heat_pump
    attic_or_roof_insulation
    basement_insulation
    battery_storage_installation
    central_air_conditioner
    cool_roof
    crawlspace_insulation
  • amountobject · required
  • owner_statusstring[] · minItems: 1 · required
    Enum values:
    homeowner
    renter
  • authoritystring
  • more_info_urlstring
  • start_datestring
  • end_datestring
  • short_descriptionstring
  • pausedboolean

APILoanProgramsResponse

  • idnumber · required
  • loan_program_keystring · required
  • namestring · required
  • descriptionstring · required
  • website_urlstring · uri · required
  • statusstring · enum · required
    Enum values:
    DRAFT
    IN_REVIEW
    APPROVED
    PUBLISHED
    ARCHIVED
  • financial_authority_idnumber · required
  • financial_authorityobject · required
  • eligible_project_typesobject[] · required
  • is_nationalboolean · required
  • created_atstring · date-time · required
  • updated_atstring · date-time · required
  • description_langsobject | null
  • statestring | null · enum
    Enum values:
    AK
    AL
    AR
    AZ
    CA
    CO
    CT
    DE
  • loan_program_termsobject

BuildingProfile400Error

  • detailobject · required

BuildingProfile400ErrorDetail

  • typestring · enum · required
    Enum values:
    address_not_parsable
    building_not_supported
    country_not_supported
    state_not_supported
  • msgstring · required

BuildingProfile500Error

  • detailobject · required

BuildingProfile500ErrorDetail

  • typestring · const · required
    Const value: unexpected_error
  • msgstring · required

BuildingProfile502Error

  • detailobject · required

BuildingProfile502ErrorDetail

  • typestring · const · required
    Const value: third_party_error
  • msgstring · required

EligibleProjectType.schema.json

  • typestring · enum · required
    Enum values:
    WEATHERIZATION
    HEATING_COOLING
    WATER_HEATER
    ELECTRICAL_PANEL_WIRING
    EV_AND_CHARGER
    EV_CHARGER
    SOLAR
    ENERGY_AUDIT

Error

  • statusCodeinteger · required
  • errorstring · required
  • messagestring · required
  • fieldstring

EstimateType

string · enum
Enum values:
address_level
puma_level

FinancialAuthority.schema.json

  • idnumber · required
  • authority_typestring · enum · required
    Enum values:
    city
    county
    utility
    federal
    state
    bank
    credit_union
    other
  • namestring · required
  • statestring · required
  • citystring | null · required
  • image_idnumber · required
  • Imageobject · required
  • descriptionstring | null
  • created_atstring | null · date-time
  • updated_atstring | null · date-time

FuelRate

  • unitstring · required
  • valuenumber
    Default: 0
  • rate_typestring
    Default: volumetric

FuelSavings

  • baselineobject · required
  • upgradeobject
  • deltaobject

GroupBy

string · enum
Enum values:
house_size_square_feet_binned
housing_type
cooling_type
baseline_appliance_fuel
upgrade_option

HealthImpactsArgs

  • metricsstring[] · required
    Enum values:
    fine_particulate_matter
    ammonia
    nitrogen_oxides
    volatile_organic_compounds
    sulfur_dioxide
    avoided_premature_mortality_incidence
    avoided_premature_mortality_valuation
  • upgradestring[] · required
    Enum values:
    hvac__heat_pump_seer18_hspf10
    combination__hvac_seer18_hspf10__weatherization
    water_heater__heat_pump_uef3.35
    dryer__heat_pump_cef5.2
  • state_fipsstring[]
    Default: []
  • county_fipsstring[]
    Default: []
  • group_bystring[]
    Enum values:
    house_size_square_feet_binned
    housing_type
    cooling_type
    baseline_appliance_fuel
    upgrade_option
    Default: []

HealthImpactsResponse

  • dataobject[] · required

HealthMetrics

string · enum
Enum values:
fine_particulate_matter
ammonia
nitrogen_oxides
volatile_organic_compounds
sulfur_dioxide
avoided_premature_mortality_incidence
avoided_premature_mortality_valuation

HeatingFuel

string · enum
Enum values:
electricity
fuel_oil
natural_gas
propane

HTTPValidationError

  • detailobject[]

ImpactMetric

  • energyobject · required
  • emissionsobject · required
  • costobject · required

LoanProgramTerms.schema.json

  • idnumber · required
  • created_atstring | null · date-time · required
  • updated_atstring | null · date-time · required
  • min_credit_scorenumber | null
  • max_debt_to_incomenumber | null
  • min_loan_amountnumber | null
  • max_loan_amountnumber | null
  • min_interest_ratenumber | null
  • max_interest_ratenumber | null
  • max_repayment_monthsnumber | null

MetricStatistics

  • meanobject · required
  • medianobject · required
  • percentile_20object · required
  • percentile_80object · required

PrivateUpgrade

string · enum
Enum values:
hvac__internal_only_heat_pump_ductless_daikin_smulti
hvac__internal_only_heat_pump_ductless_carrier_performance
hvac__internal_only_heat_pump_ducted_daikin_7

Quantity

  • unitstring · required
  • valuenumber
    Default: 0

ResultFuelType

string · enum
Enum values:
electricity
fuel_oil
natural_gas
propane
total

SamplingDetails

  • num_samplesinteger · required
    Example: 380
  • num_excluded_samplesinteger · required
    Example: 20

Savings

  • fuel_resultsobject · required
  • ratesobject · required
  • emissions_factorsobject · required
  • sampling_detailsobject · required
  • estimate_typestring · enum · required
    Enum values:
    address_level
    puma_level

Savings400Error

  • detailobject · required

Savings400ErrorDetail

  • typestring · enum · required
    Enum values:
    missing_water_heater_fuel
    multifamily_not_supported
    building_type_not_supported
    address_not_parsable
    building_not_supported
    country_not_supported
    state_not_supported
  • msgstring · required

Savings500Error

  • detailobject · required

Savings500ErrorDetail

  • typestring · enum · required
    Enum values:
    unexpected_error
    upgrade_not_supported
  • msgstring · required

Savings502Error

  • detailobject · required

Savings502ErrorDetail

  • typestring · const · required
    Const value: third_party_error
  • msgstring · required

SupportedUpgrade

string · enum
Enum values:
baseline
weatherization__insulation_air_duct_sealing
hvac__heat_pump_seer15_hspf9
hvac__heat_pump_seer24_hspf13
water_heater__heat_pump_uef3.35
combination__all_electric__hvac_seer24_hspf13__weatherization
hvac__heat_pump_seer18_hspf10
combination__hvac_seer18_hspf10__weatherization

UpgradeOption

string · enum
Enum values:
hvac__heat_pump_seer18_hspf10
combination__hvac_seer18_hspf10__weatherization
water_heater__heat_pump_uef3.35
dryer__heat_pump_cef5.2

ValidationError

  • locarray · required
  • msgstring · required
  • typestring · required

WaterHeaterFuel

string | null · enum
Enum values:
electricity
fuel_oil
natural_gas
propane