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

> Explore floor plans, community details, and project information for Welkin Homes developments across Southern California. Browse available communities and view their corresponding floor plan listings to find your ideal home.

**Category:** Real Estate | **Website:** [www.homesbywelkin.com/welkin-223/](https://www.homesbywelkin.com/welkin-223/) | **Docs:** [parse.bot/marketplace/8f4cea0b-8993-4117-9af3-19d583062b47/homesbywelkin-com-api](https://parse.bot/marketplace/8f4cea0b-8993-4117-9af3-19d583062b47/homesbywelkin-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/homesbywelkin/`
**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 community plans

Retrieve floor plan listings for a specific Welkin Homes community page. Returns builder name, community name, plan name, square footage, bedrooms, bathrooms, QMI price, starting price, and listing URL for each plan. Data is extracted from the community's WordPress page content.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `community_slug` | string | No | URL slug of the community page. Known values: welkin-223 (active community), coming-soon-v2 (upcoming projects), projects (completed projects). |

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

### List communities

List all Welkin Homes communities across all statuses: active (now selling), coming soon, and completed projects. Returns name, location, status, bedroom count, square footage, and pricing where available.

**Estimated cost:** Metered

_No parameters required._

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

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