Guides
Customizing the widget
You configure the widget through query params on the embed URL. The web component and framework adapters map each param to a prop or attribute of the same name.
URL parameters
| Param | Values | Tier | What it does |
|---|---|---|---|
key | sk_live_... | All | Required. Your API key. |
lat | decimal degrees | All | Optional. Pins a default location; the visitor’s address overrides it. Falls back to the country centroid if omitted. |
lon | decimal degrees | All | Optional. See lat. |
kwp | number | All | System size in kWp. Defaults to a roof-sized estimate. |
country | ISO code (GB, DE, US) | All | Sets currency and tariffs. |
tilt | 0–90 | All | Panel tilt in degrees. |
variant | installer | retail | realestate | finance | All | Business preset that picks the copy and call to action. |
accent | hex colour | Pro | Primary colour of the widget. |
brand | text | Pro | Your brand name in place of ours. |
layout | card | compact | panel | Pro | Overall structure. |
radius | rounded | sharp | pill | Pro | Corner style. |
theme | light | dark | Pro | Colour scheme. |
size | auto | fixed | All | auto grows the iframe via postMessage and widget.js. fixed keeps your iframe height and scrolls inside. |
Free keys ignore the Pro-only params. A Free widget stays light, card, and rounded, and keeps the badge. Upgrade on the pricing page to unlock accent, brand, layout, radius, and theme.
A white-labelled example (Pro)
This embed sets the installer variant, a peach accent, your brand name, the panel layout, pill corners, and a dark theme.
index.html
<iframe
src="https://solarapi-api.157.90.161.30.sslip.io/embed?key=&lat=51.5&lon=-0.12&country=GB&variant=installer&accent=%23ff9f7c&brand=Acme%20Solar&layout=panel&radius=pill&theme=dark"
style="width:100%;max-width:480px;height:560px;border:0"
loading="lazy"
allow="geolocation"
></iframe>