Skip to content

Quick Start

Get up and running with the Tessellate Renewables API in 5 minutes.

Prerequisites

  • Basic knowledge of REST APIs
  • A tool to make HTTP requests (cURL, Postman, or any programming language)

Step 1: Test the API

First, verify the API is accessible:

curl https://api.tessellaterenewables.com/solar/health

Expected response:

{
  "status": "healthy",
  "model_loaded": true,
  "model_type": "XGBoost"
}

Step 2: Get Solar Resource Data

Fetch solar irradiance data for any location:

curl -X POST https://api.tessellaterenewables.com/solar/resource \
  -H "Content-Type: application/json" \
  -d '{
    "latitude": 35.0,
    "longitude": -110.0
  }'

Response:

{
  "latitude": 35.0,
  "longitude": 110.0,
  "annual_ghi": 2150.5,
  "annual_dni": 2450.3,
  "annual_dhi": 650.2,
  "avg_temp": 18.5,
  "monthly_ghi": [145.2, 165.3, ...],
  "data_source": "NASA_POWER"
}

Step 3: Run Quick Optimization

Optimize solar panel parameters:

curl -X POST https://api.tessellaterenewables.com/solar/optimization/quick \
  -H "Content-Type: application/json" \
  -d '{
    "site": {
      "latitude": 35.0,
      "longitude": -110.0,
      "capacity_kw": 1000
    },
    "objective": "energy"
  }'

Response:

{
  "optimal_parameters": {
    "tilt": 32.5,
    "azimuth": 180.0,
    "dc_ac_ratio": 1.25,
    "gcr": 0.35
  },
  "energy_metrics": {
    "annual_energy_mwh": 1850.5,
    "capacity_factor": 0.211,
    "specific_yield": 1850.5
  },
  "financial_metrics": {
    "lcoe_cents_per_kwh": 3.45,
    "npv_dollars": 1250000,
    "irr_percent": 14.5,
    "payback_years": 6.2
  }
}

Step 4: Understand the Parameters

Optimization Objectives

Objective Description
energy Maximize annual energy production (kWh)
lcoe Minimize Levelized Cost of Energy ($/kWh)
npv Maximize Net Present Value ($)
irr Maximize Internal Rate of Return (%)

Output Parameters

Parameter Description Typical Range
tilt Panel tilt angle from horizontal 0-45°
azimuth Panel orientation (180° = south) 90-270°
dc_ac_ratio DC to AC capacity ratio 1.1-1.5
gcr Ground coverage ratio 0.25-0.55

Step 5: Try Full Optimization

For more control, use the full optimization endpoint with custom bounds:

curl -X POST https://api.tessellaterenewables.com/solar/optimization/run \
  -H "Content-Type: application/json" \
  -d '{
    "site": {
      "latitude": 35.0,
      "longitude": -110.0,
      "capacity_kw": 1000
    },
    "objective": "npv",
    "max_iterations": 50,
    "bounds": {
      "tilt_min": 15,
      "tilt_max": 45,
      "azimuth_min": 160,
      "azimuth_max": 200
    }
  }'

This returns a job_id that you can poll for results.

Next Steps