# Pulppo — 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 and filter real estate listings across Mexico by location, property type, price, bedrooms, and whether you're looking to buy or rent. Get detailed information about specific properties to compare options and find your ideal home on the Pulppo marketplace.

**Category:** Real Estate | **Website:** [pulppo.com/venta](https://pulppo.com/venta) | **Docs:** [parse.bot/marketplace/752bdf85-abe9-47be-9d00-150671f154f6/pulppo-com-api](https://parse.bot/marketplace/752bdf85-abe9-47be-9d00-150671f154f6/pulppo-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/pulppo/`
**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 property

Get detailed property information by ID. Returns full property details including all images, price history, amenities, description, special features, virtual tour, videos, construction details, and condition. The property_id comes from search_properties results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Pulppo property ID (alphanumeric, e.g. '655286e0cfa2fc3649feb122'). Obtained from search_properties results. |

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

### Search properties

Search properties for sale or rent in Mexico with optional filters. Returns paginated results with property details including name, location, price, size, bedrooms, bathrooms, amenities, images, and description. Use offset and limit for pagination. Each result includes a property id that can be used with get_property for full details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bedrooms_min` | string | No | Minimum number of bedrooms filter. |
| `currency` | string | No | Currency for price display and filtering (e.g. 'MXN', 'USD'). |
| `limit` | integer | No | Number of results per page (max 20). |
| `location` | string | No | State/location slug to filter by (e.g. 'ciudad-de-mexico', 'estado-de-mexico', 'yucatan-mexico', 'jalisco', 'queretaro-mexico'). Omitting returns all locations. |
| `offset` | integer | No | Offset for pagination. Use with limit to page through results. |
| `operation` | string | No | Type of listing operation. |
| `price_max` | string | No | Maximum price filter. |
| `price_min` | string | No | Minimum price filter. |
| `property_type` | string | No | Property type filter (e.g. 'Departamento', 'Casa', 'Terreno residencial', 'Oficina'). Omitting returns all types. |
| `sort` | string | No | Sort order. Format is 'field,direction' where direction is -1 (descending) or 1 (ascending). Examples: 'score,-1' (relevance), 'listing.price.price,1' (cheapest first), 'listing.price.price,-1' (most expensive first). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/pulppo/search-properties \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bedrooms_min":"<string>","currency":"<string>","limit":"<integer>","location":"<string>","offset":"<integer>","operation":"<string>","price_max":"<string>","price_min":"<string>","property_type":"<string>","sort":"<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.