Search regulations
search_regsSearch US mortgage regulator text. Prefer the regulator's vocabulary ("debt-to-income ratio"); common abbreviations (DTI, LTV, RSU, IRRRL, W-2, VOE, PITI, BK ...) are expanded for you. Each result gives the section title and a verbatim excerpt; match "partial" means the section lacks the words in missing_terms -- if a missing word is the point of the question, that section does not answer it. ORDER: results are sorted by rank_score, highest first, with no separate tiers: score (text match, title-weighted) x term coverage x title fit (a section or document whose title names the whole query ranks higher), with superseded, pending, incorporated or expired text x0.2 and a special program's section (special_program: Home Possible, HomeReady, 203(k), HECM...) x0.5 unless the query names the program. canonical_citation is the section's citation in the regulator's own style (null when it cannot be derived): cite it rather than a cite from memory. currency_kind filters to sections with that currency signal (e.g. "dual-version" for FHA sections Update 18 revises, "pending", "revision-pending", "expired"; "any" = any signal). If the titles don't fit the question, search again with other terms. A special program's section (HomeStyle, 203(k), IRRRL...) applies only to that program. Excerpts are not the full rule: answer by quoting the regulator's text verbatim with its section citation -- find_in_section returns just the paragraphs with your terms (fastest), get_obligation the whole section. A non-null currency is a warning (two versions / revision pending / pending / superseded / predates the statute / incorporated into the handbook / expires / source relocated): tell the user. version "update-18-optional" marks HUD's Update 18 revision of an FHA section (optional now, mandatory on mandatory_date), "in-force" the text that governs by default; other_version is the other text's obligation_id. An empty result: search once more in the regulator's own terms (guidance names any shorthand to spell out). If that is also empty, THE CORPUS DOES NOT ADDRESS THIS: say so; do not supply the answer from your own knowledge.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | ||
| family | No | ||
| currency_kind | No | Only sections carrying this currency signal, e.g. "dual-version", "pending", "revision-pending"; "any" for any signal. |