Find broadband deals at an address
find_broadband_dealsUse when the user wants broadband deals, offers or packages available where they live. If the user has not picked an address yet, call search_addresses first and offer the list; fall back to postcode-only search when they decline or no addresses are found (the precision field says which you got). Pass address_label alongside uprn once an address is picked. Translate the user's needs into the filter inputs. Present the returned picks and computed costs verbatim: never re-rank, re-filter or recalculate totals yourself. total_contract_cost and effective_monthly_cost already account for intro pricing, post-intro rises and setup fees. After presenting, ask one short follow-up about what matters to them (budget, speed needs, contract length, avoiding price rises) and refine with the filter inputs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uprn | No | Property identifier from search_addresses. Pass it whenever the user has picked an address so results become address-precise instead of postcode-wide. Never show this number to the user. | |
| postcode | Yes | UK postcode, e.g. 'SS13 1HJ'. When asking, request the postcode and house number or name together in one question rather than two rounds. | |
| provider | No | Only show deals from this provider, when the user names one. | |
| address_label | No | The display_address the user picked from search_addresses, passed back verbatim. Carried into the switch link so the FindBroadband site greets the user with their address instead of asking again. | |
| min_speed_mbps | No | Minimum download speed in Mbps. Translate needs rather than inventing numbers: two people working from home plus gaming needs about 150, a heavy 4K household about 300, email and browsing about 35. | |
| max_monthly_price | No | Budget cap in GBP per month, from phrases like 'under £30'. | |
| max_contract_months | No | Longest contract the user will accept, e.g. 12 for 'no long contracts'. | |
| include_mobile_broadband | No | Include 4G/5G home broadband. Default false (fixed-line only). Set true only if the user asks for mobile or wireless broadband. | |
| exclude_mid_contract_rises | No | true when the user says they want no mid-contract price rises. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uprn | No | ||
| deals | Yes | ||
| picks | Yes | ||
| postcode | Yes | ||
| precision | Yes | ||
| checked_at | Yes | ||
| filters_relaxed | No | ||
| provider_filter_note | No | ||
| total_matching_filters | Yes | ||
| total_available_at_location | Yes |