RateSonar

Find current products by lender and words in the product name, e.g. institution "CBA" and query "standard variable". Returns institution_id and product_id for each match, with category, rate and observed_date. A product is the pair (institution_id, product_id): pass both to rate_history or rate_details. Use compare_rates instead to rank lenders for a category.

{
  "type": "object",
  "properties": {
    "institution": {
      "type": "string",
      "description": "A lender id or name, e.g. \"cba\", \"Westpac\", \"Bendigo Bank\"."
    },
    "query": {
      "type": "string",
      "description": "Words in the product name, e.g. \"standard variable\" or \"bonus saver\"."
    },
    "category": {
      "type": "string",
      "enum": [
        "home_loan",
        "savings",
        "term_deposit",
        "credit_card",
        "personal_loan",
        "car_loan",
        "business_loan"
      ],
      "description": "Optional product category."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 25,
      "description": "Products to return. Default 10."
    }
  }
}

Current comparison across institutions for a product category (home_loan | savings | term_deposit | credit_card | personal_loan | car_loan | business_loan): each product at its own most recent observation (observedDate tells you how fresh). Home loans can be filtered by loanPurpose/repaymentType/rateType — the headline home-loan rate is the owner-occupied P&I rate whose LVR band covers 80%. Term deposits take termMonths (the published rate for that term, e.g. 6 or 12) and deposits take customerSegment. Standard products only unless audience says otherwise. Returns the best `limit` rows (default 25, at most 40); `truncated` says more exist. It has no lender filter: for one lender's products use find_products. Fees are summarised (name, type, amount or rate, frequency); rate_details has every fee field.

{
  "type": "object",
  "properties": {
    "category": {
      "type": "string",
      "enum": [
        "home_loan",
        "savings",
        "term_deposit",
        "credit_card",
        "personal_loan",
        "car_loan",
        "business_loan"
      ],
      "description": "Product category to compare."
    },
    "asOf": {
      "type": "string",
      "description": "Historical snapshot date YYYY-MM-DD. Defaults to each product's latest observation."
    },
    "loanPurpose": {
      "type": "string",
      "enum": [
        "owner_occupied",
        "investment"
      ],
      "description": "Loans only: filter by purpose."
    },
    "repaymentType": {
      "type": "string",
      "enum": [
        "pi",
        "io"
      ],
      "description": "Loans only: principal-and-interest vs interest-only."
    },
    "rateType": {
      "type": "string",
      "enum": [
        "variable",
        "fixed"
      ],
      "description": "Loans only: rate structure."
    },
    "termMonths": {
      "type": "integer",
      "minimum": 1,
      "maximum": 120,
      "description": "term_deposit only: rank each product's published rate for this term in months (6, 12, 24 …)."
    },
    "customerSegment": {
      "type": "string",
      "enum": [
        "consumer",
        "business"
      ],
      "description": "savings and term_deposit only: personal or business products."
    },
    "audience": {
      "type": "string",
      "enum": [
        "standard",
        "green",
        "veteran",
        "first_responder",
        "smsf",
        "bridging",
        "construction",
        "first_home",
        "reverse_mortgage",
        "line_of_credit",
        "other_niche",
        "any"
      ],
      "description": "Who the product is for. Default standard (untagged rows count as standard); \"any\" includes green, veteran, SMSF, construction and other special-purpose products."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 40,
      "description": "Rows to return, best first. Default 25, at most 40."
    }
  },
  "required": [
    "category"
  ]
}

Advertised rate history for one product (institutionId and productId). Returns each recorded rate, comparison rate and fees between two dates, with the date each was recorded. RateSonar's record starts 2026-06-12. Pass grid:true to also get `grid`, one point per day: status 'observed' on a recorded day; 'carried-forward' with sourceDate and fill {from, through, ageDays, reason:'no-record'} on a day RateSonar has no record for, carrying the last recorded rate (never the next one) until the next record. After the last record it carries only while RateSonar's gap ledger shows the product still expected but unrecorded (not withdrawn), for at most 14 days. A carried-forward value is not an observation. History is limited to the caller's plan window (free and anonymous 31 days, Enthusiast 366, Pro full); an older `from` is raised to it and the answer says windowClamped:true.

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "Product id from find_products or compare_rates, e.g. \"f1d6fcc359804f3c9365d576c56356fc\" with institutionId \"cba\" (CBA Standard Variable Rate Home Loan, owner occupied)."
    },
    "institutionId": {
      "type": "string",
      "description": "Institution id, e.g. \"cba\". Pass it with every productId: a product is the pair (institutionId, productId)."
    },
    "from": {
      "type": "string",
      "description": "Start date YYYY-MM-DD (inclusive). Optional."
    },
    "to": {
      "type": "string",
      "description": "End date YYYY-MM-DD (inclusive). Optional."
    },
    "grid": {
      "type": "boolean",
      "description": "Also return `grid`: one labelled point per day (observed or carried-forward), at most 367 days. A wider window returns `gridError` (pass from/to) and keeps `observations`. Default false."
    }
  },
  "required": [
    "productId"
  ]
}

Exact CDR product-reference detail for one institution and product: every published lending or deposit rate entry and tier, with fees, features, eligibility, constraints, source quality flags, the date the version was recorded and the lender's own links. asOf returns the version current on that date. Detail exists for CDR products from 2026-06-12; it holds the conditions a headline rate leaves out.

{
  "type": "object",
  "properties": {
    "institutionId": {
      "type": "string",
      "description": "Institution id, e.g. \"nab\"."
    },
    "productId": {
      "type": "string",
      "description": "CDR product id."
    },
    "asOf": {
      "type": "string",
      "description": "Latest snapshot on or before YYYY-MM-DD. Optional."
    }
  },
  "required": [
    "institutionId",
    "productId"
  ]
}

Recent change-events, newest first: a rate moved, a product was added, or a product was withdrawn. Each event has the lender, the product's name and category, and field-level deltas (e.g. rate [6.09, 5.89], bps -20). Filter by institutionId, category, kind and direction. Returns `limit` events (default 50, at most 200); `truncated` says more match. This is a diff of RateSonar's consecutive captured observations.

{
  "type": "object",
  "properties": {
    "institutionId": {
      "type": "string",
      "description": "Optional, e.g. \"cba\". Omit for all lenders."
    },
    "category": {
      "type": "string",
      "enum": [
        "home_loan",
        "savings",
        "term_deposit",
        "credit_card",
        "personal_loan",
        "car_loan",
        "business_loan"
      ],
      "description": "Optional product category, e.g. term_deposit."
    },
    "kind": {
      "type": "string",
      "enum": [
        "rate_change",
        "product_added",
        "product_removed"
      ],
      "description": "Optional event kind."
    },
    "direction": {
      "type": "string",
      "enum": [
        "up",
        "down"
      ],
      "description": "Optional: only rate rises (up) or cuts (down)."
    },
    "sinceDays": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3650,
      "description": "Look-back window in days. Default 14."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "Events to return. Default 50."
    }
  }
}

Every standard series slug the series tool accepts, with its label, kind (level or spread) and unit (% or bps). Call this before series when you do not know the slug.

{
  "type": "object",
  "properties": {}
}

Standardized rate series: named LEVEL series (hl.var.oo.pi = headline variable home loan; sav.max; td.12m; biz.loan.var; cash = RBA cash rate…) and SPREAD series in bps (spread.hl.var-cash = lending pass-through; spread.hl.var-sav.max = the margin; spread.hl.var-hl.fix.36m = variable vs 3yr fixed…), per institution per day. Last-known values are explicitly status:'carried-forward' with sourceDate and fill {from, through, ageDays, reason:'no-record'} (through = the next recorded date; null = the gap is open, or no record within 60 days after the window end). Between two records the last rate is carried until the next one. After an institution's last record it is carried only while RateSonar's gap ledger shows the product that holds that rate still expected but unrecorded (not withdrawn), for at most 14 days, then the series stops; medians and spreads use the same points, so a stale value never feeds them past 14 days. The RBA cash series publishes on business days only, so its carried points have no fill; it is carried at most 14 days after its last row. Spreads and medians are status:'derived' with sourceDates; they are not observations. Pass median:true for a market-median line. Unauthenticated access and free access are clamped to the last 31 days, Enthusiast to 366 (windowClamped:true in the response). Pro tiers query deeper history in windows of at most 367 inclusive dates; large multi-series median requests may require smaller windows.

{
  "type": "object",
  "properties": {
    "slugs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Series slugs from list_series, e.g. [\"hl.var.oo.pi\", \"spread.hl.var-cash\"]."
    },
    "institutions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Institution ids, e.g. [\"cba\",\"anz\"]."
    },
    "median": {
      "type": "boolean",
      "description": "Add a _median market line per slug."
    },
    "from": {
      "type": "string",
      "description": "Start date YYYY-MM-DD."
    },
    "to": {
      "type": "string",
      "description": "End date YYYY-MM-DD."
    }
  },
  "required": [
    "slugs"
  ]
}

Selected bank deposit and loan contracts against matching peer brands, own recorded history, RBA cash and dated funding disclosures. Pass an institutionId and product cohort. No claims about private ALM, intent or margins.

{
  "type": "object",
  "properties": {
    "institutionId": {
      "type": "string",
      "description": "Institution id from find_products or the bank desk."
    },
    "depositKind": {
      "type": "string",
      "enum": [
        "savings",
        "3",
        "6",
        "12",
        "24"
      ],
      "default": "savings"
    },
    "loanKind": {
      "type": "string",
      "enum": [
        "home",
        "home-fixed",
        "card",
        "personal",
        "car",
        "business"
      ],
      "default": "home"
    },
    "amount": {
      "type": "number",
      "enum": [
        50000,
        250000,
        1000000
      ],
      "default": 50000
    },
    "payment": {
      "type": "string",
      "enum": [
        "maturity",
        "monthly",
        "yearly"
      ],
      "default": "maturity"
    },
    "depositKey": {
      "type": "string",
      "maxLength": 512,
      "description": "Optional exact contract key from the cohort."
    },
    "loanKey": {
      "type": "string",
      "maxLength": 512
    },
    "question": {
      "type": "string",
      "maxLength": 300
    }
  },
  "required": [
    "institutionId"
  ],
  "additionalProperties": false
}

An evidence-checked AI reading of bank_position. Supports savings or term deposits against variable/fixed home loans, card purchase rates, personal, car or business loans. Returns cited claims, inference labels and dated records; partial readings name withheld sections; unavailable or rejected AI leaves the records intact. No supplied rates accepted.

{
  "type": "object",
  "properties": {
    "institutionId": {
      "type": "string",
      "description": "Institution id from find_products or the bank desk."
    },
    "depositKind": {
      "type": "string",
      "enum": [
        "savings",
        "3",
        "6",
        "12",
        "24"
      ],
      "default": "savings"
    },
    "loanKind": {
      "type": "string",
      "enum": [
        "home",
        "home-fixed",
        "card",
        "personal",
        "car",
        "business"
      ],
      "default": "home"
    },
    "amount": {
      "type": "number",
      "enum": [
        50000,
        250000,
        1000000
      ],
      "default": 50000
    },
    "payment": {
      "type": "string",
      "enum": [
        "maturity",
        "monthly",
        "yearly"
      ],
      "default": "maturity"
    },
    "depositKey": {
      "type": "string",
      "maxLength": 512,
      "description": "Optional exact contract key from the cohort."
    },
    "loanKey": {
      "type": "string",
      "maxLength": 512
    },
    "question": {
      "type": "string",
      "maxLength": 300
    }
  },
  "required": [
    "institutionId"
  ],
  "additionalProperties": false
}

RBA curve nodes for an exact date or the latest publication: cash and bond yields as published, and the RBA's fitted zero, forward and discount curves (each point says whether it is observed or derived), with optional exact comparison date, instrument details, source digest and convention. Eight distinct cash/government families; no intraday OIS, BBSW, swap or futures feed. Zero/forward fitted data publish monthly.

{
  "type": "object",
  "properties": {
    "family": {
      "type": "string",
      "enum": [
        "government-zero",
        "government-bond",
        "government-security",
        "government-indexed",
        "government-forward",
        "government-discount",
        "cash-rate",
        "cash-target"
      ],
      "default": "government-zero"
    },
    "date": {
      "type": "string",
      "description": "Exact observation date YYYY-MM-DD; omit for latest. No silent carry-forward."
    },
    "compareDate": {
      "type": "string",
      "description": "Optional exact second observation date."
    }
  },
  "additionalProperties": false
}

Validation, freshness, missing families, source hashes and last-good fallback status of the automated curve pipeline. An unhealthy response is evidence of a pipeline problem, not bank risk.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}