# Moneyfactscompare — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://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.

> Find and compare mortgage products from Moneyfacts with detailed specifications including rates, terms, and eligibility requirements. Browse by category, search for specific mortgages, and access comprehensive product details to help you find the best mortgage option.

**Category:** Finance & Markets | **Website:** [moneyfactscompare.co.uk/](https://moneyfactscompare.co.uk/) | **Docs:** [parse.bot/marketplace/4b77ff59-7e3e-459d-a141-96676edb348d/moneyfactscompare-co-uk-api](https://parse.bot/marketplace/4b77ff59-7e3e-459d-a141-96676edb348d/moneyfactscompare-co-uk-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-moneyfactscompare-co-uk-api-4b77ff59/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_mortgage_categories

Returns the list of supported mortgage category slugs. These slugs are valid inputs for the category parameter on other endpoints. Currently: remortgage, moving-home, first-time-buyer, buy-to-let.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-moneyfactscompare-co-uk-api-4b77ff59/get_mortgage_categories \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_mortgage_product_details

Fetch details for a single mortgage product by its composite ID within a category. Returns basic product data including rate, fees, term, and description. The product_id is obtained from get_mortgage_products or search_mortgages results. The enrichment attempt may add extra fields like overpayment info and incentives when available.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Category the product belongs to. |
| `product_id` | string | Yes | The internal composite product ID obtained from get_mortgage_products or search_mortgages results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-moneyfactscompare-co-uk-api-4b77ff59/get_mortgage_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","product_id":"<string>"}'
```

### get_mortgage_products

Retrieve all mortgage products for a given category. Returns the full listing page worth of products (typically 2000+) with rate, fee, LTV, and term details for each. Categories map to distinct product sets: remortgage, moving-home, first-time-buyer, buy-to-let. Each product carries an id usable with get_mortgage_product_details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | The mortgage category to fetch products for. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-moneyfactscompare-co-uk-api-4b77ff59/get_mortgage_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>"}'
```

### search_mortgages

Search for mortgages by loan amount, property value, term, and buyer type. Maps the buyer type to the appropriate category page and passes search parameters as query filters. Returns matching products from the relevant category. The search_params object in the response echoes the criteria used.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `amount` | string | No | Amount to borrow in GBP, as a numeric string. |
| `buyer_type` | string | No | Buyer type determining which category of products to search. |
| `term` | string | No | Mortgage term in years, as a numeric string. |
| `value` | string | No | Property value in GBP, as a numeric string. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-moneyfactscompare-co-uk-api-4b77ff59/search_mortgages \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":"<string>","buyer_type":"<string>","term":"<string>","value":"<string>"}'
```