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

> Search real estate listings for properties available for sale, rent, or recently sold, and access detailed information like property photos, price history, nearby schools, and local amenities. Compare similar homes, calculate mortgage estimates, and make informed decisions with comprehensive property data all in one place.

**Category:** Real Estate | **Website:** [trulia.com/](https://trulia.com/) | **Docs:** [parse.bot/marketplace/ceec87d3-d86b-4a69-a980-a7170b9b3b60/trulia-com-api](https://parse.bot/marketplace/ceec87d3-d86b-4a69-a980-a7170b9b3b60/trulia-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/trulia/`
**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 listing details

Get comprehensive property details by URL path. Returns price, location, description, features, media, price history, surroundings, taxes, and market snapshot. The URL path is obtained from search endpoint results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Property URL path from Trulia (e.g. '/home/8334-116th-st-richmond-hill-ny-11418-32005834'). Obtained from search results' url field. |

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

### Get listing photos

Retrieve photo objects for a property listing. Returns an array of photo objects with multiple resolution URLs in JPEG and WebP formats.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Property URL path from Trulia (e.g. '/home/8334-116th-st-richmond-hill-ny-11418-32005834'). Obtained from search results' url field. |

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

### Get local amenities

Get local neighborhood survey data near a property, including walkability, safety, and community information from resident surveys.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Property URL path from Trulia (e.g. '/home/8334-116th-st-richmond-hill-ny-11418-32005834'). Obtained from search results' url field. |

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

### Get mortgage calculator

Calculate estimated monthly mortgage payment based on property price, down payment, loan term, and interest rate. Uses standard amortization formula. Pure computation, no network call.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `down_payment` | number | Yes | Down payment amount in dollars (must be >= 0 and less than price) |
| `price` | number | Yes | Property price in dollars (must be positive) |
| `rate` | number | No | Annual interest rate as a percentage (e.g. 7.0 for 7%) |
| `term` | integer | No | Loan term in years |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/trulia/get-mortgage-calculator \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"down_payment":"<number>","price":"<number>","rate":"<number>","term":"<integer>"}'
```

### Get nearby schools

Get schools near a property.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Property URL or path to get nearby schools |

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

### Get property price history

Retrieve the price history for a property. Returns chronological listing events including listed, pending, sold, and price change events with dates and prices.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Property URL path from Trulia (e.g. '/home/8334-116th-st-richmond-hill-ny-11418-32005834'). Obtained from search results' url field. |

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

### Get similar homes

Get similar/comparable homes recommended by Trulia.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Property URL or path to get similar/comparable homes |

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

### Search for rent listings

Search rental properties by city and state. Returns up to 40 listings per page with price range, bedrooms, bathrooms, and amenity tags. Pagination via integer page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City and state in the format 'City, ST' (e.g. 'Chicago, IL', 'Austin, TX') |
| `page` | integer | No | Page number for pagination (1-based) |

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

### Search for sale listings

Search properties for sale by city and state. Returns up to 40 listings per page with price, bedrooms, bathrooms, floor space, and listing status. Pagination via integer page number. Results include property URLs that can be passed to detail endpoints.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City and state in the format 'City, ST' (e.g. 'New York, NY', 'Los Angeles, CA') |
| `page` | integer | No | Page number for pagination (1-based) |

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

### Search sold listings

Search recently sold homes by city and state. Returns up to 40 listings per page with sale price, property details, and sold date. Pagination via integer page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City and state in the format 'City, ST' (e.g. 'Los Angeles, CA', 'Denver, CO') |
| `page` | integer | No | Page number for pagination (1-based) |

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

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