API reference
Compare
Compare the whole cost. Open the product
GET/v1/back-bookOpen ↗
What a borrower is paying, against what their own lender and the rest of the imported data publish today for a loan of the same shape at the same loan to value ratio.
| Query | |
|---|---|
rate | the rate being paid now, as a percentage ("6.89") or a fraction ("0.0689") |
lender | the brand the loan is with, as the imported data names it |
amount | the amount still owing, dollars |
value | what the property is worth, dollars — this is what sets the ratio |
term | years left on the loan |
age | how old the loan is, years — optional, and used only to show what the ACCC measured |
purpose | owner (default) or investor |
repayment | principal_and_interest (default) or interest_only |
GET/v1/compareOpen ↗
Rank the products in the dataset for one loan.
| Query | |
|---|---|
amount | dollars borrowed, default 500000 |
value | what the property is worth, default 625000 — the two together are the loan to value ratio, which is what decides the rate |
years | the term, default 30 |
purpose | OWNER_OCCUPIED or INVESTMENT |
repayment | PRINCIPAL_AND_INTEREST or INTEREST_ONLY |
io | years of interest-only repayments, used only with repayment=INTEREST_ONLY |
GET/v1/datasetOpen ↗
What was read, from whom, and when.