# Homes — 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.

> Search for real estate agents and properties available for sale or rent, while accessing detailed agent profiles with their 1-year transaction history, active listings, and performance statistics. Get comprehensive property details and agent information all in one place to help you find the right agent or property that matches your needs.

**Category:** Real Estate | **Website:** [homes.com/](https://homes.com/) | **Docs:** [parse.bot/marketplace/e536d79b-99e2-43ed-8e7e-a05fa306b019/homes-com-api](https://parse.bot/marketplace/e536d79b-99e2-43ed-8e7e-a05fa306b019/homes-com-api)

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

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/homes/`
**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 agent profile

Get detailed profile of a real estate agent including specialties, neighborhoods served, awards, and contact info. Use agent_id and name_slug from search_agents results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `agent_id` | string | Yes | Agent ID from search_agents results (e.g. 'ycqgq7s') |
| `name_slug` | string | Yes | Agent name slug from the profile URL path (e.g. 'bret-butler') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/homes/get-agent-profile \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"<string>","name_slug":"<string>"}'
```

### Get property details

Get full details for a specific property listing including price, address, description, and key facts. Works with property URLs from search_properties_for_sale or search_properties_for_rent results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full property URL from homes.com (e.g. 'https://www.homes.com/property/7621-menler-dr-austin-tx/89g2bpy6g0nf4/') |

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

### Get total agent count

Get the total number of real estate agents listed on the platform.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/homes/get-total-agent-count \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search agents

Search for real estate agents by location (city and state). Returns a paginated list of agents with their contact info, brokerage, and profile URLs. Each page returns up to 48 agents. The total_count field reflects the total number of agents serving the area.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City and state to search (e.g. 'Seattle, WA', 'Austin, TX') |
| `page` | integer | No | Page number for pagination (1-based) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/homes/search-agents \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","page":"<integer>"}'
```

### Search properties for rent

Search for rental properties by location. Returns a paginated list of rental listings with price, beds, baths, square footage, and agent info. Each page returns up to 40 listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City and state to search (e.g. 'Austin, TX') |
| `page` | integer | No | Page number for pagination (1-based) |
| `property_type` | string | No | Property type filter. Accepted values: houses, townhouses, condos, land, mobile |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/homes/search-properties-for-rent \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","page":"<integer>","property_type":"<string>"}'
```

### Search properties for sale

Search for properties listed for sale by location. Returns a paginated list of properties with price, beds, baths, square footage, and agent info. Each page returns up to 40 listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City and state to search (e.g. 'Austin, TX') |
| `page` | integer | No | Page number for pagination (1-based) |
| `property_type` | string | No | Property type filter. Accepted values: houses, townhouses, condos, land, mobile |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/homes/search-properties-for-sale \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","page":"<integer>","property_type":"<string>"}'
```

## Next steps

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