# MoneySuperMarket — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Browse and compare live mortgage rates across multiple lenders on MoneySuperMarket. Search for mortgage products by property value, deposit, term, region, and product type to find competitive rates and detailed cost breakdowns.

**Category:** Finance & Markets | **Website:** [moneysupermarket.com/](https://moneysupermarket.com/) | **Docs:** [parse.bot/marketplace/e5471f09-f4a1-40b9-91a3-a545c53e35c2/moneysupermarket-com-api](https://parse.bot/marketplace/e5471f09-f4a1-40b9-91a3-a545c53e35c2/moneysupermarket-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/moneysupermarket/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get lowest rates

Get current lowest mortgage rates across product types for a given mortgage category. Returns rate data as a map keyed by product type (TwoYearFixed, ThreeYearFixed, FiveYearFixed, Variable) and loan-to-value bands (SixtyLoanToValue, SeventyFiveLoanToValue, etc.). Each entry contains the best product's initial rate, monthly payment, lender info, and a pre-built enquiry object for drilling into that segment. Not paginated — returns the full rate overview in one call.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Mortgage category. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/moneysupermarket/get-lowest-rates \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>"}'
```

### Search mortgages

Search for mortgage products based on property value, deposit, term, region, and optional filters. Returns paginated results (20 per page) with detailed product information including interest rates, fees, costs, lender details, and affordability. Each product includes initial and follow-on rate periods, monthly payments, APRC, total cost, and early repayment terms.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `deposit_amount` | integer | No | Deposit amount in GBP. |
| `fixed_term` | string | No | Optional term length filter. |
| `journey_type` | string | No | Journey type. |
| `page` | integer | No | Page number for pagination. 20 results per page. |
| `product_type` | string | No | Optional product type filter. |
| `property_value` | integer | No | Property value in GBP. |
| `region` | string | No | UK region. |
| `repayment_method` | string | No | Repayment method. |
| `required_term_years` | integer | No | Mortgage term in years. |
| `sort_by` | string | No | Sort order for results. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/moneysupermarket/search-mortgages \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"deposit_amount":"<integer>","fixed_term":"<string>","journey_type":"<string>","page":"<integer>","product_type":"<string>","property_value":"<integer>","region":"<string>","repayment_method":"<string>","required_term_years":"<integer>","sort_by":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.