GridPulse

{
  "properties": {
    "age_years": {
      "description": "Appliance age in years (affects upgrade ROI calculation)",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "appliance": {
      "description": "Appliance type (hvac, water-heater, refrigerator, washer, dryer, dishwasher, lighting)",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "2-letter US state code for local electricity rates",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "usage_hours": {
      "description": "Daily usage hours (default varies by appliance)",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "appliance"
  ],
  "type": "object"
}

{
  "properties": {
    "has_solar": {
      "description": "Whether the property already has solar",
      "required": false,
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "lang": {
      "description": "Response language (default en)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "location": {
      "description": "City, State or place name",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "monthly_kwh": {
      "description": "Average monthly consumption in kWh",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "US ZIP code (refines the location)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "location"
  ],
  "type": "object"
}

{
  "properties": {
    "household_size": {
      "description": "Number of people in household",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "monthly_kwh": {
      "description": "Average monthly electricity consumption in kWh",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "2-letter US state code",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "hours": {
      "default": 24,
      "description": "Forward window in hours, 1-48",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "region": {
      "default": "UK",
      "description": "UK | a GB DNO region (london, north-scotland, …) | DE FR NL BE AT ES IT NO",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "credit_preference": {
      "description": "Preference for bill credit vs. direct payment programs",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "monthly_bill": {
      "description": "Average monthly electricity bill in USD",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "2-letter US state code",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "US ZIP code (optional, refines local results)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "state"
  ],
  "type": "object"
}

{
  "properties": {
    "goal": {
      "default": "carbon",
      "description": "What to optimise. cost and blend require a region with a published day-ahead price series (DE, FR, BE and other bidding zones).",
      "enum": [
        "carbon",
        "cost",
        "blend"
      ],
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "hours": {
      "default": 4,
      "description": "Job duration in hours",
      "maximum": 24,
      "minimum": 0.25,
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "max_gco2": {
      "description": "Optional carbon budget in gCO2/kWh. Returns the earliest window meeting it, or satisfiable:false.",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "mw": {
      "default": 1,
      "description": "Load in MW — scales the absolute CO2 and EUR savings",
      "maximum": 10000,
      "minimum": 0,
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "region": {
      "default": "UK",
      "description": "UK (GB national) | a GB DNO region: london, north-scotland, south-scotland, north-west-england, north-east-england, yorkshire, north-wales, south-wales, west-midlands, east-midlands, east-england, south-west-england, south-england, south-east-england | an EU country: DE, FR, NL, BE, AT, ES, IT, NO",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "miles": {
      "default": 12000,
      "description": "Annual miles (1,000-100,000)",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "2-letter US state code (default: TX)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "state": {
      "description": "2-letter US state code",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "state"
  ],
  "type": "object"
}

{
  "properties": {
    "region": {
      "default": "ercot",
      "description": "US ISO/RTO region",
      "enum": [
        "ercot",
        "caiso",
        "pjm",
        "miso",
        "isone",
        "nyiso",
        "spp"
      ],
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "state": {
      "description": "2-letter US state code (TX, CA, NY, etc.; default: US)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "state": {
      "description": "2-letter US state code (default: CA)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "state": {
      "description": "2-letter state code (if no zip)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    },
    "system_kw": {
      "default": 6,
      "description": "System size in kW (2-20)",
      "required": false,
      "type": "number",
      "x-parameter-location": "query"
    },
    "zip": {
      "description": "US ZIP code (preferred)",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [],
  "type": "object"
}

{
  "properties": {
    "has_ev": {
      "description": "true if household has an EV (major TOU savings driver)",
      "required": false,
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "has_solar": {
      "description": "true if household has solar (affects TOU export credit optimization)",
      "required": false,
      "type": "boolean",
      "x-parameter-location": "query"
    },
    "monthly_bill": {
      "description": "Average monthly electricity bill in USD",
      "required": false,
      "type": "integer",
      "x-parameter-location": "query"
    },
    "state": {
      "description": "2-letter US state code",
      "required": true,
      "type": "string",
      "x-parameter-location": "query"
    },
    "utility": {
      "description": "Utility name (e.g., PGE, SCE, ConEd) for utility-specific TOU plans",
      "required": false,
      "type": "string",
      "x-parameter-location": "query"
    }
  },
  "required": [
    "state"
  ],
  "type": "object"
}