API Documentation

Usage

• Parameters:

  • version - optional, default=1.2, accepted values: 1.0, 1.1, 1.2
  • address - optional, type: string. If provided, all other params are ignored.
  • lat - required if no address provided, type: float, range: -90.0 - 90.0
  • lon - required if no address provided, type: float, range: -180.0 - 180.0
  • system_capacity - required if no address provided, type: float, range: 0.05 - 500000.0
  • tilt - required if no address provided, type: float, range 0.0 - 90.0
  • azimuth - required if no address provided, type: float, range: 0.0 - 360.0
  • array_type - required if no address provided, type: int, 0 or 2
  • om_cap - required if no address provided, type: int
  • tot_installed_cost - required if no address provided, type: int
  • gcr - required if no address provided, type: float, range: 0.01 - 0.99
  • om_fixed - optional, type: float
  • ppa_price_input - optional, default=0, type: float
  • ppa_soln_mode - optional, default=1, accepted values: 0, 1
  • pbi_sta_amount - optional, default=0, type: float
  • pbi_sta_term - optional, default=0, type: float
  • bifacial - optional, default=0, accepted values: 0, 1

• Returns:

  JSON object
  • error - boolean
  • message - string
  • version - float, 1.3
  • data - array
    • array of objects in format {"lat": lat, "lng": lng} - If address is provided
    • If address is not provided:
      • annual_energy - Annual energy (year 1)
      • capacity_factor - Capacity factor (year 1)
      • kwh_per_kw - Energy yield (year 1)
      • ppa - PPA price (year 1)
      • lppa_nom - Levelized PPA price (nominal)
      • lppa_real - Levelized PPA price (real)
      • lcoe_nom - Levelized COE (nominal)
      • lcoe_real - Levelized COE (real)
      • project_return_aftertax_npv - Net present value
      • flip_actual_irr - Internal rate of return (IRR)
      • flip_actual_year - Year IRR is achieved
      • project_return_aftertax_irr - IRR at end of project
      • cost_installed - Net capital cost
      • size_of_equity - Equity
      • size_of_debt - Size of debt
      • cf_energy_value - Value of electricity savings (year 1)
      • break_even_year - Year Project after-tax cumulative NPV becomes positive.
      • cf_om_capacity - Project O&M costs ($/yr, year 1)
      • cf_aftertax_returns - Project after tax returns, array years 0-25