WzState
Build your own websiteAPI referenceBudget calculator

Compounds with units a visitor can afford

GET
/api/public/budget-calculator

Query Parameters

downPayment*number

Cash the visitor has available for a down payment

monthlyPayment*number

What the visitor can pay per month

totalBudget?number

Ceiling on the total unit price

installmentYears?number

Only plans with exactly this term, in years

unitTypeIds?string

Unit type IDs (csv)

locationIds?string

Location IDs (csv)

deliveryStatus?string

Value in

  • "ready"
  • "off_plan"
deliveryYear?number

Handover year — matches units delivering in that calendar year

page?number
Default1
perPage?number
Rangevalue <= 100
Default12

Header Parameters

X-Site*string

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.

X-Api-Key?string

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"
Empty