Your home
plan_homeA home's past year on every tariff in list_tariffs and at Ofgem's price cap – and what switching tariff, an electric car, a heat pump, solar panels or a battery would save, each added to everything before it (tariff, car, heating, solar, battery). Each of car, heating, solar and battery is something the home has (it explains the bill) or is considering. Totals are electricity, gas at the price cap and petrol or diesel – only what changes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| car | No | What the home drives now: `petrol` (default) or `diesel` (counted only with consider_ev=1), `ev` (the bill includes an electric car), or `none`. | petrol |
| gas | No | With heating=gas and consider_heat_pump=1: gas a year on the bill, kWh (1000-60000, default 9500). | |
| kwp | No | Panels, kWp (0.2-50; default 4 on a roof, 0.8 for a plug-in kit, at most 2) – the first roof face's, with more faces. | |
| mpg | No | With consider_ev=1: its real-world mpg (10-120; default the average car on the road, 36 petrol, 42 diesel). | |
| mpk | No | Electric car, miles per kWh at the battery (1.5-6, default 3.3). | |
| ppl | No | With consider_ev=1: what you pay, p/litre (50-400; default the UK weekly average over the past year). | |
| kwp2 | No | Roof panels on a second face, kWp (0.2-50), with `aspect2` and `tilt2` – and `kwp3`, `aspect3`, `tilt3` for a third. One inverter for them all. | |
| kwp3 | No | Roof panels on a third face, kWp (0.2-50). | |
| scop | No | With consider_heat_pump=1: the installer's seasonal efficiency for heating (1.5-6; default a typical installation). | |
| tilt | No | Or their exact angle from flat, degrees (0-90). Replaces `pitch` (or `mount`). | |
| unit | No | With tariff=custom: its unit rate, p/kWh (5-100). | |
| boost | No | With heating=storage: the share of their heat from evening boost at the day rate, % (0, 10 or 25; default 10). | 10 |
| miles | No | Car miles a year (500-40000, default 7100). | |
| mount | No | With panels=plug_in: its angle from flat – 90 (upright on a balcony or wall, default), 60 (leaning), 30 (on a stand), 10 (flat). | 90 |
| pitch | No | The roof: 35 (pitched, default), 20 (shallow), 50 (steep), 10 (flat). | 35 |
| shift | No | Share of everyday use run at the day's cheapest times, % (0, 15 or 30; default 0) – for fine-tuning. | 0 |
| solar | No | `no` (default), `have`, or `consider`. | no |
| tilt2 | No | The second face's angle from flat, degrees (0-90, default 35). | |
| tilt3 | No | The third face's angle from flat, degrees (0-90, default 35). | |
| usage | No | Electricity a year as on the bill, kWh – what's bought now (500-30000, default 2500). | |
| aspect | No | The way the panels face: S (default), SE, SW, E, W, NE, NW, N. | S |
| boiler | No | With consider_heat_pump=1: `condensing` (default) or `older` (pre-2005). | condensing |
| export | No | How export is paid: `paired` (default: each tariff's own export tariff), `fixed` (at `export_rate`), `fit` (the Feed-in Tariff's deemed export), `none`, or an export tariff's key from list_tariffs?direction=export – used with every tariff that can have it, and each tariff's own with the rest. | paired |
| hp_kwh | No | With heating=heat_pump: its own use, kWh a year, if known (0-20000; default estimated). | |
| panels | No | With solar=have or consider: `roof` (default) or `plug_in` (a plug-in kit: its inverter capped at 800 W, export unpaid, panels up to 2 kWp). | roof |
| region | Yes | Agile region: a letter A-P or the slug from list_regions (eg `C` or `london`); list_regions lists well-known places in each. | |
| switch | No | 1 (default) to find the best tariff at each step, staying put included; 0 to keep `tariff` throughout. | 1 |
| tariff | No | The tariff the home is on: `price-cap` (default), a key from list_tariffs, `tracker` (Octopus Tracker, off sale but priced for the homes on it), or `custom` with `unit` and `standing`. | price-cap |
| aspect2 | No | The second face's direction: S (default), SE, SW, E, W, NE, NW, N. | |
| aspect3 | No | The third face's direction. | |
| battery | No | `no` (default), `have`, or `consider`. | no |
| bearing | No | Or the exact compass bearing the panels face, degrees (0-359; south 180). Replaces `aspect`. | |
| charger | No | Home charger, kW (2-22, default 7). | |
| daytime | No | Whether anyone's home in the day: `usual` (default), `out` (rarely – out at work), or `home` (most days). Decides how much of the panels' output the home uses. | usual |
| heating | No | What heats the home now: `gas` (default), `oil` or `lpg` (a boiler), `solid` (wood or coal: `solid_fuel` says which) – counted only with consider_heat_pump=1 – `heat_pump` (the bill includes one), `storage` (storage heaters), `electric` (panel or other direct electric heaters), or `other`. | gas |
| hp_cost | No | With consider_heat_pump=1: the quote after grants, £ (0-100000; default typical, outside Scotland). | |
| plug_in | No | Hour the car is plugged in, 0-23 local (default 18). | |
| preheat | No | With heating=electric: `1` to heat from 1pm rather than 4pm–7pm when that's cheaper (default `0`). | 0 |
| heat_ppl | No | With heating=oil or lpg and consider_heat_pump=1: what's paid a litre, pence (20-300). Oil defaults to a recent national average; LPG has no default and needs it. | |
| keep_gas | No | With consider_heat_pump=1: 1 to keep gas for cooking (default 0). | 0 |
| plug_out | No | Hour it's unplugged, 0-23 local (default 7; the same as `plug_in`: always plugged in). | |
| standing | No | With tariff=custom: its standing charge, p/day (0-200). | |
| appliance | No | With heating=solid: `stove` (a stove or boiler, default) or `fire` (an open fire). | stove |
| night_gmt | No | `1`: the meter keeps GMT, so its night hours are an hour later in summer (default `0`). | 0 |
| replacing | No | With consider_heat_pump=1: 1 if the boiler is due for replacing anyway (default 0). | 0 |
| standby_w | No | Battery standby draw, W (0-200, default 20). | |
| battery_kw | No | Battery power, kW (0.5-15, default 3). | |
| charge_eff | No | Car charging efficiency, % (70-100, default 90). | |
| heat_spend | No | With heating=solid and consider_heat_pump=1: what the home spends on it a year, £ (10-20000). Needed, with heat_amount. | |
| heater_kwh | No | With heating=storage or electric: the heaters' own use, kWh a year, if known (0-30000; default estimated). Hot water is taken as an immersion heater. | |
| round_trip | No | Battery round-trip efficiency, % (60-100, default 90). | |
| solar_cost | No | With solar=consider: the quote or kit price, £ (0-100000; default typical). | |
| solid_fuel | No | With heating=solid: `logs` (default), `pellets` or `coal` (coal or smokeless fuel). | logs |
| storage_kw | No | With heating=storage: all the heaters' input power together, kW (1-30, default 6). | |
| battery_kwh | No | Battery, usable kWh (0.5-40, default 5). | |
| consider_ev | No | With a petrol or diesel car: 1 to see what an electric car replacing it would save (default 0). | 0 |
| export_rate | No | Your fixed export rate, p/kWh (0-100, default 12), with `export=fixed`. | |
| heat_amount | No | With heating=solid and consider_heat_pump=1: how much the home buys a year – logs in loose cubic metres, pellets and coal in kg (0.1-50000). Needed, with heat_spend. | |
| heat_litres | No | With heating=oil or lpg and consider_heat_pump=1: litres a year (100-10000; default as much heat as 9500 kWh of gas). | |
| inverter_kw | No | Solar inverter rating, kW (0.5-50; default no limit). | |
| night_start | No | The meter's seven night hours, for Economy 7 tariffs and meter-switched heaters: the half hour they start, 0-47 local (44 is 22:00 ... 3 is 01:30; default 1, 00:30-07:30). | 1 |
| battery_cost | No | With battery=consider: the quote, £ (0-100000; no default – no payback without one). | |
| export_limit | No | Export limit set by the network operator, kW (0.5-50; default none). | |
| storage_meter | No | With heating=storage: `1` (default) the meter switches them on in its night hours (and Snug Octopus can schedule them), `0` their own timer, in the cheapest night half hours. | 1 |
| battery_export | No | What the battery may export: `never`, even where the export tariff peaks; `solar`, only what it stored from the panels, even on Octopus's; `terms` (default), what the terms pay for – on Octopus's anything it holds, on other export tariffs only what it stored from the panels; `all`, anything it holds, on any export tariff (check the supplier pays for grid-charged export). | terms |
| battery_charge_kw | No | Battery charging power, kW (0.5-15, default `battery_kw`). | |
| consider_heat_pump | No | With a boiler (heating=gas, oil or lpg), wood or coal (heating=solid), or storage or electric heaters (heating=storage or electric): 1 to see what a heat pump replacing them would save (default 0). | 0 |
| battery_discharge_kw | No | Battery discharging power, kW (0.5-15, default `battery_kw`). |