# Bookyogaretreats — 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 and explore yoga retreat listings from BookYogaRetreats.com, including pricing, location, duration, ratings, and guest reviews. Browse paginated listings, retrieve full retreat details, and export results to CSV.

**Category:** Travel | **Website:** [bookyogaretreats.com/](https://bookyogaretreats.com/) | **Docs:** [parse.bot/marketplace/10b1a66a-32f2-4dc6-9280-c31ed6379157/bookyogaretreats-com-api](https://parse.bot/marketplace/10b1a66a-32f2-4dc6-9280-c31ed6379157/bookyogaretreats-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/bookyogaretreats/`
**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 retreat detail

Fetch full details of a specific retreat by its URL. Returns comprehensive information including organizer name, instructors, pricing, rating, and amenity flags. The URL must be a full bookyogaretreats.com retreat page URL (obtainable from get_retreat_listings or search_retreats results).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the retreat detail page on bookyogaretreats.com (e.g. from get_retreat_listings or search_retreats results' website field). |

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

### Get retreat listings

Fetch paginated retreat listings from the BookYogaRetreats homepage. Returns an array of retreat summaries including pricing, ratings, and availability. Results are ordered by the site's recommended sorting. Each page contains approximately 12 results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number to fetch for pagination. |

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

### Scrape all retreats paginated

Crawl retreat listings and fetch full details for each retreat. Iterates through listing pages up to the specified maximum, visiting each retreat's detail page. Returns structured retreat data with an optional CSV export.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max_pages` | integer | No | Maximum number of listing pages to crawl. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/bookyogaretreats/scrape-all-retreats-paginated \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"max_pages":"<integer>"}'
```

### Search retreats

Search for retreats by destination or keyword. Returns paginated retreat listings matching the search query. Searches by destination name (e.g. 'bali', 'spain', 'india') or category (e.g. 'meditation', 'vinyasa yoga'). Each page contains approximately 12 results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number to fetch for pagination. |
| `query` | string | Yes | Search keyword — a destination name (e.g. 'bali', 'spain', 'india') or retreat category (e.g. 'meditation', 'vinyasa yoga'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/bookyogaretreats/search-retreats \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","query":"<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.