{"name":"Arthr agent tools","description":"Arthr's home-loan calculators as URLs. Each tool is the same function as the MCP tool of the same name at https://www.arthr.com.au/api/mcp, with the same arguments and the same output. Open a URL, read the result.","sideEffects":"Opening these URLs only calculates. Nothing is stored, and no lead, application or message is created.","doNot":["Don't present a result as advice, a credit assessment or an offer of credit. Every result is an indicative estimate.","Don't describe a loan, lender or product as the best one. The tools sort facts by a stated rule; they don't recommend.","Don't quote a figure without its resultUrl, so the person can check it.","Don't put names, contact details, addresses or account numbers in a URL. No tool takes them, and an unknown parameter is rejected.","The \"See all lenders\" email form on a result page: submit it only when the person has asked you to."],"disclosure":"General information only — this is an indicative estimate, not credit advice, a credit assessment or an offer of credit. It doesn't consider anyone's objectives, financial situation or needs. Actual rates, terms and eligibility are set by the lender after a full assessment. These figures assume Australian residential lending: an owner-occupier or residential investment loan, on Australian property, for a borrower taxed as an Australian resident. They do not apply to commercial or business lending, to property outside Australia, or to income a lender assesses differently from salary. Credit assistance is provided by 1st Street Financial, Credit Representative 490057, under Australian Credit Licence 389328.","howToCall":{"method":"GET","html":"https://www.arthr.com.au/agent-tools/{tool}?{arguments}","json":"https://www.arthr.com.au/agent-tools/{tool}?{arguments}&format=json","arguments":"Query parameters named exactly as the MCP tool's arguments. Plain numbers (600000, 6.25). A blank value counts as missing. An argument given twice, an unknown argument, or an out-of-range value is rejected with a message, never guessed. A list argument takes repeated keys or commas.","result":"The tool's output fields, plus resultUrl: a link with every argument the call resolved to, defaults included, that reproduces the result."},"mcp":"https://www.arthr.com.au/api/mcp","tools":[{"name":"estimate_repayments","title":"Estimate home loan repayments","description":"Estimate the monthly repayment, total repaid and total interest on an Australian principal-and-interest home loan. Use this when someone asks what a loan would cost them each month, or how much interest they'd pay over the life of a loan. Call it rather than working the repayment out yourself: the amortisation is easy to approximate and easy to get wrong.","url":"https://www.arthr.com.au/agent-tools/estimate_repayments","urlTemplate":"https://www.arthr.com.au/agent-tools/estimate_repayments?loanAmount={loanAmount}&interestRate={interestRate}&termYears={termYears}","example":"https://www.arthr.com.au/agent-tools/estimate_repayments?loanAmount=600000&interestRate=6&termYears=30","humanPage":"https://www.arthr.com.au/calculators","inputSchema":{"type":"object","properties":{"loanAmount":{"type":"number","description":"Loan amount in AUD.","minimum":1000,"maximum":50000000},"interestRate":{"type":"number","description":"Annual interest rate as a percentage, e.g. 6.2 for 6.2% p.a.","minimum":0,"maximum":25},"termYears":{"type":"number","description":"Loan term in years. Defaults to 30.","minimum":1,"maximum":40,"default":30}},"required":["loanAmount","interestRate"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"monthlyRepayment":{"type":"number","description":"Monthly P&I repayment, AUD."},"totalRepaid":{"type":"number","description":"Total repaid over the full term, AUD."},"totalInterest":{"type":"number","description":"Total interest paid over the term, AUD."},"loanAmount":{"type":"number"},"interestRate":{"type":"number"},"termYears":{"type":"number"},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"paymentFrequency":{"type":"string","const":"monthly","description":"Repayment and saving figures are per month."},"repaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"description":"How the loan is repaid in this calculation."},"rateUnit":{"type":"string","const":"percent_per_annum","description":"Rates are annual percentages: 6 means 6% p.a., not 0.06."},"feesIncluded":{"type":"boolean","description":"Whether loan fees and charges are in the figures. False: repayments are principal and interest only."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["monthlyRepayment","totalRepaid","totalInterest"]}},{"name":"estimate_borrowing_power","title":"Estimate borrowing power","description":"Estimate how much someone could borrow for an Australian home loan, based on household income, living expenses, credit card limits and existing debt repayments. Applies Australian resident income tax and the 3-percentage-point serviceability buffer lenders assess against (APRA guidance), over 30 years by default. Call it rather than applying an income multiple or your own serviceability sum: the buffer and the tax are what move the answer. Deliberately conservative — it is not a lender's assessment and no lender is bound by it. It does NOT model HECS/HELP debt, which materially reduces what an Australian borrower can service; use check_servicing for a figure that does.","url":"https://www.arthr.com.au/agent-tools/estimate_borrowing_power","urlTemplate":"https://www.arthr.com.au/agent-tools/estimate_borrowing_power?grossAnnualIncome={grossAnnualIncome}&monthlyExpenses={monthlyExpenses}&monthlyDebtRepayments={monthlyDebtRepayments}&creditCardLimits={creditCardLimits}&termYears={termYears}&interestRate={interestRate}","example":"https://www.arthr.com.au/agent-tools/estimate_borrowing_power?grossAnnualIncome=150000&monthlyExpenses=3500&interestRate=6","humanPage":"https://www.arthr.com.au/calculators/borrowing-power","inputSchema":{"type":"object","properties":{"grossAnnualIncome":{"type":"number","description":"COMBINED household income before tax, in AUD per year — both incomes added together for a couple. Note this differs from check_servicing, which wants one applicant's income with a partner supplied separately; carrying a figure between the two without adjusting it will either double a second income or lose it.","minimum":0,"maximum":10000000},"monthlyExpenses":{"type":"number","description":"Living costs in AUD per month — food, transport, utilities, insurance, childcare, subscriptions. Convert carefully: a weekly figure is x52/12, a fortnightly one is x26/12. EXCLUDE rent or mortgage payments they would stop making on buying, and exclude anything passed in the other arguments. Include rent only when they will still be paying it after settlement. IMPORTANT: unlike a lender, this estimate applies NO minimum expense benchmark — it takes the figure as given. An unrealistically low number therefore inflates the answer here while changing nothing at a real lender, which is the main way this tool comes out far above check_servicing. If someone's stated costs look low for their household, that gap is the reason.","minimum":0,"maximum":200000},"monthlyDebtRepayments":{"type":"number","description":"Repayments on car and personal loans, AUD per month. Pass credit cards as creditCardLimits instead, not as a repayment. Defaults to 0.","minimum":0,"maximum":200000,"default":0},"creditCardLimits":{"type":"number","description":"Total credit limit across all cards, AUD — the limit, not the balance and not the monthly payment. Lenders assess the limit whether or not the card is cleared each month, so a card paid off in full still reduces borrowing power, and a forgotten card at zero balance reduces it just as much. Defaults to 0.","minimum":0,"maximum":1000000,"default":0},"termYears":{"type":"number","description":"Term to assess over. Defaults to 30. Pass the remaining term for someone refinancing who is keeping their original end date — assessing them over a fresh 30 years overstates what they can service.","minimum":1,"maximum":40,"default":30},"interestRate":{"type":"number","description":"The annual rate the loan would sit at, as a percentage, e.g. 6.2. The serviceability buffer is added to this automatically.","minimum":0,"maximum":25}},"required":["grossAnnualIncome","monthlyExpenses","interestRate"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"borrowingPower":{"type":"number","description":"Estimated maximum loan, assessed at the buffered rate, AUD."},"borrowingPowerAtRate":{"type":"number","description":"What the same surplus would fund at the actual rate, with no buffer, AUD."},"monthlyRepayment":{"type":"number","description":"Monthly repayment on the assessed loan at the actual rate, AUD."},"assessmentRate":{"type":"number","description":"Rate used to test serviceability (actual rate + buffer), % p.a."},"monthlySurplus":{"type":"number","description":"Income left after tax, living costs and existing repayments, AUD per month."},"cardCommitment":{"type":"number","description":"What the credit card limits cost per month in assessed commitment, AUD."},"surplusFactor":{"type":"number","description":"Share of the surplus actually lent against. Stated rather than folded in silently, so the annuity reconciles without being reverse-engineered."},"assessmentBuffer":{"type":"number"},"termYears":{"type":"number"},"modelsHecs":{"type":"boolean","description":"Always false. HECS/HELP is not in this model — use check_servicing."},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"paymentFrequency":{"type":"string","const":"monthly","description":"Repayment and saving figures are per month."},"repaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"description":"How the loan is repaid in this calculation."},"rateUnit":{"type":"string","const":"percent_per_annum","description":"Rates are annual percentages: 6 means 6% p.a., not 0.06."},"incomeBasis":{"type":"string","const":"gross_annual_household","description":"Income is before tax, per year, both applicants combined."},"taxYear":{"type":"string","description":"The Australian resident income tax year applied, e.g. 2026-27. No offsets."},"expenseBenchmarkApplied":{"type":"boolean","description":"Always false: living costs are taken as given, with no minimum benchmark (HEM) as a lender would apply."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["borrowingPower","monthlyRepayment","assessmentRate","monthlySurplus"]}},{"name":"estimate_refinance_savings","title":"Estimate refinance savings","description":"Compare an existing home loan rate against a lower one and estimate the monthly and whole-of-term saving. Use this when someone asks whether refinancing is worth it, or what dropping their rate would save them. Call it rather than multiplying the balance by the rate gap: that shortcut ignores the principal in a P&I repayment and overstates the saving. Both rates are arguments — this tool does not quote or assume a market rate.","url":"https://www.arthr.com.au/agent-tools/estimate_refinance_savings","urlTemplate":"https://www.arthr.com.au/agent-tools/estimate_refinance_savings?loanAmount={loanAmount}&currentRate={currentRate}&newRate={newRate}&termYears={termYears}","example":"https://www.arthr.com.au/agent-tools/estimate_refinance_savings?loanAmount=600000&currentRate=6.6&newRate=5.9","humanPage":"https://www.arthr.com.au/calculators/savings","inputSchema":{"type":"object","properties":{"loanAmount":{"type":"number","description":"Outstanding loan balance in AUD.","minimum":1000,"maximum":50000000},"currentRate":{"type":"number","description":"The rate they're on now, as a percentage, e.g. 6.8.","minimum":0,"maximum":25},"newRate":{"type":"number","description":"The rate being compared against, as a percentage, e.g. 6.2.","minimum":0,"maximum":25},"termYears":{"type":"number","description":"Years remaining on the loan. Defaults to 30.","minimum":1,"maximum":40,"default":30}},"required":["loanAmount","currentRate","newRate"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"currentRepayment":{"type":"number","description":"Monthly repayment at the current rate, AUD."},"newRepayment":{"type":"number","description":"Monthly repayment at the new rate, AUD."},"monthlySaving":{"type":"number","description":"Monthly difference, AUD. Zero if the new rate is higher."},"totalSaving":{"type":"number","description":"Saving over the full remaining term, AUD."},"loanAmount":{"type":"number"},"currentRate":{"type":"number"},"newRate":{"type":"number"},"termYears":{"type":"number"},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"paymentFrequency":{"type":"string","const":"monthly","description":"Repayment and saving figures are per month."},"repaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"description":"How the loan is repaid in this calculation."},"rateUnit":{"type":"string","const":"percent_per_annum","description":"Rates are annual percentages: 6 means 6% p.a., not 0.06."},"switchingCostsIncluded":{"type":"boolean","description":"Whether the saving is net of the one-off cost of switching lenders."},"rateHeldForTerm":{"type":"boolean","description":"Whole-of-term figures assume the rates stay where they are for the full term. Always true here, and no variable rate does."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["currentRepayment","newRepayment","monthlySaving","totalSaving"]}},{"name":"estimate_refinance_break_even","title":"Estimate refinance break-even","description":"Work out how many months it takes for a refinance to pay for itself once switching costs are counted, and what the net saving is after them. Call this rather than estimate_refinance_savings when someone is deciding whether a switch is worth doing, not just how much a lower rate saves. Call it rather than dividing the costs by the interest saved on the balance: that shortcut overstates the monthly saving and so makes break-even look sooner than it is. Switching costs are an argument — this tool does not assume a figure, because they vary by lender and by state and most lenders don't publish theirs. Use lookup_discharge_process for the lender-stated discharge fee where there is one. This models a variable loan: if they are on a fixed rate, the break cost belongs in switchingCosts and usually decides the answer on its own.","url":"https://www.arthr.com.au/agent-tools/estimate_refinance_break_even","urlTemplate":"https://www.arthr.com.au/agent-tools/estimate_refinance_break_even?loanAmount={loanAmount}&currentRate={currentRate}&newRate={newRate}&switchingCosts={switchingCosts}&termYears={termYears}","example":"https://www.arthr.com.au/agent-tools/estimate_refinance_break_even?loanAmount=600000&currentRate=6.6&newRate=5.9&switchingCosts=800","humanPage":"https://www.arthr.com.au/calculators/savings","inputSchema":{"type":"object","properties":{"loanAmount":{"type":"number","description":"Outstanding loan balance in AUD.","minimum":1000,"maximum":50000000},"currentRate":{"type":"number","description":"The rate they're on now, as a percentage, e.g. 6.8.","minimum":0,"maximum":25},"newRate":{"type":"number","description":"The rate being switched to, as a percentage, e.g. 6.2.","minimum":0,"maximum":25},"switchingCosts":{"type":"number","description":"Total one-off cost of switching in AUD. ASK WHETHER THEY ARE ON A FIXED RATE FIRST. Breaking a fixed term costs thousands to tens of thousands and dwarfs everything else here — a $14,000 break fee turns a nine-month break-even into seven years and reverses the recommendation. It is the figure that decides the answer and the one nobody volunteers, because people think of their loan by its rate, not its term. Then add the current lender's discharge fee, the new lender's application and settlement fees, and state mortgage registration and deregistration. Required: there is no sensible default and a guessed one changes the answer.","minimum":0,"maximum":200000},"termYears":{"type":"number","description":"Years remaining on the loan. Defaults to 30.","minimum":1,"maximum":40,"default":30}},"required":["loanAmount","currentRate","newRate","switchingCosts"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"monthlySaving":{"type":"number","description":"Monthly difference, AUD. Zero if the new rate is higher."},"switchingCosts":{"type":"number","description":"The one-off cost supplied, AUD."},"breakEvenMonths":{"type":["number","null"],"description":"Months until the accumulated saving covers the switching cost. Null when the new rate is no better, in which case it never breaks even."},"breaksEvenWithinTerm":{"type":"boolean"},"netSavingFirstYear":{"type":"number","description":"Saving over 12 months less switching costs, AUD. Negative early on."},"netSavingOverTerm":{"type":"number","description":"Saving over the remaining term less switching costs, AUD."},"currentRepayment":{"type":"number"},"newRepayment":{"type":"number"},"totalSaving":{"type":"number"},"loanAmount":{"type":"number"},"currentRate":{"type":"number"},"newRate":{"type":"number"},"termYears":{"type":"number"},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"paymentFrequency":{"type":"string","const":"monthly","description":"Repayment and saving figures are per month."},"repaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"description":"How the loan is repaid in this calculation."},"rateUnit":{"type":"string","const":"percent_per_annum","description":"Rates are annual percentages: 6 means 6% p.a., not 0.06."},"switchingCostsIncluded":{"type":"boolean","description":"Whether the saving is net of the one-off cost of switching lenders."},"rateHeldForTerm":{"type":"boolean","description":"Whole-of-term figures assume the rates stay where they are for the full term. Always true here, and no variable rate does."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["monthlySaving","switchingCosts","breakEvenMonths","netSavingOverTerm"]}},{"name":"estimate_equity_and_lvr","title":"Estimate equity and LVR","description":"Work out loan-to-value ratio, equity, and — the part that matters — how much of that equity is actually usable. Value minus balance is not what a borrower can borrow: lenders generally release to 80% of the property's value, so the usable figure is often far smaller than the raw one. Set situation=\"purchase\" when the person does not own the property yet and loanBalance is the loan they would take out; the answer is then about their deposit and whether mortgage insurance applies, and \"usable equity\" is not reported, because for a buyer it is a number that does not exist.","url":"https://www.arthr.com.au/agent-tools/estimate_equity_and_lvr","urlTemplate":"https://www.arthr.com.au/agent-tools/estimate_equity_and_lvr?propertyValue={propertyValue}&loanBalance={loanBalance}&situation={situation}","example":"https://www.arthr.com.au/agent-tools/estimate_equity_and_lvr?propertyValue=900000&loanBalance=600000","humanPage":null,"inputSchema":{"type":"object","properties":{"propertyValue":{"type":"number","description":"What the property is worth in AUD — or the purchase price, for a purchase.","minimum":1000,"maximum":100000000},"loanBalance":{"type":"number","description":"What is still owing in AUD — or, for a purchase, the loan they would take out.","minimum":0,"maximum":100000000},"situation":{"type":"string","description":"'owner' (default) — they own the property and this is the balance on it. 'purchase' — they are buying, and loanBalance is the proposed loan. Get this right: treating a buyer as an owner reports usable equity computed from a deposit they were never asked about, and the answer looks reasonable while being nonsense.","enum":["owner","purchase"],"default":"owner"}},"required":["propertyValue","loanBalance"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"equity":{"type":["number","null"],"description":"Property value less the loan balance, AUD. Not what can be borrowed. Null for a purchase, where the person owns nothing yet — a strict client must accept the null rather than treat it as a failure."},"lvr":{"type":"number","description":"Loan as a PERCENTAGE of value: 85 means 85%, not 0.85. Note that check_servicing reports the same ratio as a fraction, so do not carry one into the other without converting."},"usableEquity":{"type":["number","null"],"description":"What could generally be released without mortgage insurance, AUD — 80% of value less the balance. Zero when already at or above 80%."},"shortfallToThreshold":{"type":"number","description":"How far above the 80% threshold the loan sits, AUD. Zero when below."},"lmiLikely":{"type":"boolean","description":"Whether mortgage insurance is likely in play."},"lmiThresholdLvr":{"type":"number"},"propertyValue":{"type":"number"},"loanBalance":{"type":"number"},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"lvrUnit":{"type":"string","const":"percent","description":"LVR figures are percentages: 80 means 80%."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["equity","lvr","usableEquity","lmiLikely"]}},{"name":"estimate_stamp_duty","title":"Estimate stamp duty","description":"Estimate stamp (transfer) duty on an Australian residential property purchase, for any state or territory, including first-home and owner-occupier concessions. Duty scales differ in every jurisdiction and change at each state budget, so this is the tool to call rather than working duty out from memory.","url":"https://www.arthr.com.au/agent-tools/estimate_stamp_duty","urlTemplate":"https://www.arthr.com.au/agent-tools/estimate_stamp_duty?price={price}&state={state}&buyerType={buyerType}","example":"https://www.arthr.com.au/agent-tools/estimate_stamp_duty?price=800000&state=NSW&buyerType=first-home","humanPage":"https://www.arthr.com.au/calculators/stamp-duty","inputSchema":{"type":"object","properties":{"price":{"type":"number","description":"Purchase price in AUD.","minimum":0,"maximum":100000000},"state":{"type":"string","description":"State or territory the property is in.","enum":["NSW","VIC","QLD","WA","SA","TAS","ACT","NT"]},"buyerType":{"type":"string","description":"Buyer situation. 'first-home' applies first-home exemptions and concessions where the state offers them; 'owner-occupier' applies standing owner-occupier rates; 'investor' applies the general scale. Defaults to owner-occupier.","enum":["first-home","owner-occupier","investor"],"default":"owner-occupier"}},"required":["price","state"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"duty":{"type":"number","description":"Duty payable for this buyer type, AUD."},"standardDuty":{"type":"number","description":"Full duty before any concession, AUD."},"concession":{"type":"number","description":"Amount saved by the concession, AUD."},"concessionLabel":{"type":["string","null"],"description":"Name of the concession applied, or null if none."},"effectiveRate":{"type":"number","description":"Duty as a percentage of the price."},"price":{"type":"number"},"state":{"type":"string"},"buyerType":{"type":"string"},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"dutyScaleYear":{"type":"string","description":"The state duty scales applied, by financial year."},"concessionEligibilityTested":{"type":"boolean","description":"Always false: concession conditions (residency, prior ownership, new or established) are not tested."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["duty","standardDuty","concession","effectiveRate"]}},{"name":"lookup_discharge_process","title":"Look up a lender's mortgage discharge process","description":"Look up how to discharge a mortgage with a specific Australian lender — the name of the form, a link to it on the lender's own site, where the completed form is submitted, the lender-stated processing time, the discharge fee where the lender publishes one, and the phone number. This is the first step in refinancing away from a lender or selling. Every field is taken from the lender's own published material and dated; where a lender publishes no timeframe or fee, that is reported rather than guessed. Call this instead of describing a discharge process from memory.","url":"https://www.arthr.com.au/agent-tools/lookup_discharge_process","urlTemplate":"https://www.arthr.com.au/agent-tools/lookup_discharge_process?lender={lender}","example":"https://www.arthr.com.au/agent-tools/lookup_discharge_process?lender=Westpac","humanPage":"https://www.arthr.com.au/discharge","inputSchema":{"type":"object","properties":{"lender":{"type":"string","description":"The lender. Accepts the slug, the full or legal name, or the shorthand — \"nab\", \"NAB\" and \"National Australia Bank\" all resolve to the same row. Covered: Commonwealth Bank, ANZ, Westpac, NAB, St.George Bank, Bank of Melbourne, Bankwest, ING, Ubank, Bank of Queensland, Macquarie Bank, BankSA, Suncorp Bank, ME Bank, Bendigo Bank, AMP Bank.","examples":["cba","anz","westpac","nab","stgeorge","bank-of-melbourne","bankwest","ing","ubank","boq","macquarie","banksa","suncorp","me-bank","bendigo","amp"]}},"required":["lender"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"lender":{"type":"string"},"slug":{"type":"string"},"formName":{"type":"string","description":"The lender's own name for the form."},"formKind":{"type":"string","enum":["pdf","online","page","phone"],"description":"How the form is obtained. 'phone' means the lender publishes no form at all and you have to ring and ask for it."},"formUrl":{"type":"string","description":"Link to the form on the lender's own domain."},"submitTo":{"type":"string","description":"Where the completed form goes."},"businessDays":{"type":["number","null"],"description":"Lender-stated minimum processing time, or null if they publish none."},"feeAud":{"type":["number","null"],"description":"Discharge fee in AUD, only where the lender publishes it. Null for almost every lender — the fee sits in the loan contract."},"phone":{"type":"string"},"note":{"type":"string","description":"Anything specific about this lender's process."},"source":{"type":"string","description":"The lender's own page about discharging."},"verified":{"type":"string","description":"ISO date this row was last checked against the source."},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["lender","formName","formKind","formUrl","submitTo","phone","verified"]}},{"name":"compare_rates","title":"Compare lenders' rates for a loan","description":"Lenders' advertised rates on arthr's panel for a loan of this size, at this loan-to-value band, purpose and repayment type, lowest first. Variable rates come with comparison rates where held; fixed terms of 1, 2, 3 or 5 years (principal and interest). Instant, from the panel's own tables, no account. Use it to show the spread of rates; check_servicing says who would actually lend.","url":"https://www.arthr.com.au/agent-tools/compare_rates","urlTemplate":"https://www.arthr.com.au/agent-tools/compare_rates?loanAmount={loanAmount}&propertyValue={propertyValue}&propertyPurpose={propertyPurpose}&repaymentType={repaymentType}&rateType={rateType}&limit={limit}","example":"https://www.arthr.com.au/agent-tools/compare_rates?loanAmount=600000&propertyValue=800000","humanPage":"https://www.arthr.com.au/rates","inputSchema":{"type":"object","properties":{"loanAmount":{"type":"number","description":"What they'll borrow (or owe after refinancing), AUD.","minimum":10000,"maximum":50000000},"propertyValue":{"type":"number","description":"What the property is worth, AUD.","minimum":10000,"maximum":100000000},"propertyPurpose":{"type":"string","enum":["owner_occupied","investment"],"default":"owner_occupied","description":"Live in it or rent it out. Defaults to owner_occupied."},"repaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"default":"principal_and_interest","description":"Defaults to principal_and_interest."},"rateType":{"type":"string","enum":["variable","fixed_1","fixed_2","fixed_3","fixed_5"],"default":"variable","description":"Defaults to variable."},"limit":{"type":"number","description":"How many lenders to return, lowest first. Default 10.","minimum":1,"maximum":25,"default":10}},"required":["loanAmount","propertyValue"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"band":{"type":"string"},"lvrBand":{"type":"number"},"priced":{"type":"boolean","description":"False when the tables hold no rates for this band; say so rather than borrowing another band's."},"pricedAt":{"type":"string"},"rateType":{"type":"string"},"lenderCount":{"type":"number"},"sortedBy":{"type":"string"},"lenders":{"type":"array","items":{"type":"object","properties":{"lender":{"type":"string"},"rate":{"type":"number"},"comparisonRate":{"type":["number","null"]}}}},"notAdvice":{"type":"string","description":"Always present: these are facts in a stated order, not a recommendation."},"repaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"description":"How the loan is repaid in this calculation."},"rateUnit":{"type":"string","const":"percent_per_annum","description":"Rates are annual percentages: 6 means 6% p.a., not 0.06."},"lvrUnit":{"type":"string","const":"percent","description":"LVR figures are percentages: 80 means 80%."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["priced","lenders","notAdvice"]}},{"name":"find_products","title":"Find home loan products with given features","description":"Home loan products from lenders on arthr's panel that have every feature asked for (offset, redraw, extra repayments, portable, no annual fee), priced at this loan's loan-to-value band, sorted by comparison rate. Each comes with its fees in dollars. Facts in a stated order, not a recommendation. Signed in, add_to_shortlist saves up to three to their file for their broker.","url":"https://www.arthr.com.au/agent-tools/find_products","urlTemplate":"https://www.arthr.com.au/agent-tools/find_products?loanAmount={loanAmount}&propertyValue={propertyValue}&propertyPurpose={propertyPurpose}&features={features}&rateType={rateType}&limit={limit}","example":"https://www.arthr.com.au/agent-tools/find_products?loanAmount=600000&propertyValue=800000&features=offset","humanPage":null,"inputSchema":{"type":"object","properties":{"loanAmount":{"type":"number","description":"What they'll borrow (or owe after refinancing), AUD.","minimum":10000,"maximum":50000000},"propertyValue":{"type":"number","description":"What the property is worth, AUD.","minimum":10000,"maximum":100000000},"propertyPurpose":{"type":"string","enum":["owner_occupied","investment"],"default":"owner_occupied","description":"Live in it or rent it out. Defaults to owner_occupied."},"features":{"type":"array","items":{"type":"string","enum":["offset","redraw","extra_repay","portable","no_annual_fee"]},"description":"Features every product returned must have. Empty or left out: any."},"rateType":{"type":"string","enum":["variable","fixed","any"],"default":"any","description":"Defaults to any."},"limit":{"type":"number","description":"How many products to return. Default 10.","minimum":1,"maximum":25,"default":10}},"required":["loanAmount","propertyValue"],"additionalProperties":false},"outputSchema":{"type":"object","properties":{"lvr":{"type":"number"},"lvrBand":{"type":["number","null"],"description":"Null above 90%: no products are priced there."},"pricedAt":{"type":"string"},"matched":{"type":"number"},"sortedBy":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"lender":{"type":"string"},"lenderKey":{"type":"string","description":"Pass to add_to_shortlist with the product name."},"product":{"type":"string"},"rateLabel":{"type":"string"},"rate":{"type":"number"},"comparisonRate":{"type":"number"},"annualFee":{"type":"number"},"upfrontFee":{"type":["number","null"]},"maxLvr":{"type":["number","null"]},"features":{"type":"array","items":{"type":"string"}},"fees":{"type":"array","items":{"type":"string"}}}}},"notAdvice":{"type":"string","description":"Always present: these are facts in a stated order, not a recommendation."},"currency":{"type":"string","const":"AUD","description":"Every money figure in this result is in Australian dollars."},"rateUnit":{"type":"string","const":"percent_per_annum","description":"Rates are annual percentages: 6 means 6% p.a., not 0.06."},"lvrUnit":{"type":"string","const":"percent","description":"LVR figures are percentages: 80 means 80%."},"resultUrl":{"type":"string","description":"A link that reproduces this exact result at arthr.com.au/agent-tools, built from the arguments it ran with (defaults included). Give it to the person so they can check the figures or share them. Opened by a person, the page leads with the result in plain words."},"imageUrl":{"type":"string","description":"A PNG card of this result (headline figure, inputs, disclaimer), for showing inline. The resultUrl previews as the same card when pasted into a message."},"suggestedFollowUps":{"type":"array","description":"Other questions these tools can answer for the user, worded to them, for you to offer. Each has the tool, a link with what is already known filled in, and `needs`: what to ask the user before the link gives a result. Offer them; don't run one the user hasn't asked for.","items":{"type":"object","properties":{"ask":{"type":"string"},"tool":{"type":"string"},"url":{"type":"string"},"needs":{"type":"array","items":{"type":"string"}}},"required":["ask","tool","url","needs"]}}},"required":["products","notAdvice"]}}]}