# Yelp (yelp.com) — 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 businesses on Yelp and access their detailed information including reviews, photos, and ratings all from one interface. Get comprehensive business data like hours, contact details, and customer feedback without visiting Yelp directly.

**Category:** Reviews & Ratings | **Website:** [yelp.com/](https://yelp.com/) | **Docs:** [parse.bot/marketplace/e063c3d6-5552-46a2-be7c-0f3824624ed5/yelp-com-api](https://parse.bot/marketplace/e063c3d6-5552-46a2-be7c-0f3824624ed5/yelp-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/yelp/`
**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 business details

Get full details for a specific business by its alias (URL slug). Returns comprehensive business information including rating, phone, website, address, hours, editorial summary, and a sample of photos. The alias is the URL-safe slug visible in Yelp business page URLs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `biz_id` | string | Yes | Business alias/slug from the business URL (e.g. 'gary-danko-san-francisco'). Obtainable from search_businesses results[*].alias. |

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

### Get business photos

Get user-contributed photos for a business. Returns all photos available on the business page including captions and encoded IDs. Photos are deduplicated by encid but may appear in multiple size variants.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `biz_id` | string | Yes | Business alias/slug from the business URL (e.g. 'gary-danko-san-francisco'). Obtainable from search_businesses results[*].alias. |

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

### Search businesses

Search for businesses by keyword and location. Returns up to ~15 businesses per page. Offset-based pagination via the start parameter; each page returns a businesses array. The total field reports the count of items in the current page, not total results available.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | City, state, or ZIP code (e.g. 'New York, NY', 'San Francisco', '10001') |
| `query` | string | Yes | Search keyword (e.g. 'pizza', 'plumber', 'coffee') |
| `sort_by` | string | No | Sort order for results |
| `start` | integer | No | Result offset for pagination. Each page returns ~15 results; use start=0, 10, 20, etc. to paginate. |

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

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