Compounds with units a visitor can afford
Query Parameters
Cash the visitor has available for a down payment
What the visitor can pay per month
Ceiling on the total unit price
Only plans with exactly this term, in years
Unit type IDs (csv)
Location IDs (csv)
Value in
- "ready"
- "off_plan"
Handover year — matches units delivering in that calendar year
1value <= 10012Header Parameters
The site key identifying which website this request belongs to. May be omitted only when the request comes from a domain already verified for the site (the Origin/Host then resolves it), or when the deprecated X-Subdomain header is used.
Publishable (pk_…) or secret (sk_…) key for this site. Required on writes; accepted on reads. NOTE: currently rolling out in monitor mode — a write without a valid key is logged rather than refused, so this is documented as optional. It becomes required on writes when enforcement is switched on; send it now.
Response Body
curl -X GET "https://example.com/api/public/budget-calculator?downPayment=0&monthlyPayment=0" \ -H "X-Site: string"