# Yelp (m.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 and read detailed reviews on Yelp, then get autocomplete suggestions to find exactly what you're looking for. Access comprehensive business information including ratings, hours, and customer feedback all in one place.

**Category:** Food & Dining | **Website:** [m.yelp.com/](https://m.yelp.com/) | **Docs:** [parse.bot/marketplace/f90b7910-bfba-4d1e-bdde-f7d2df37ee49/m-yelp-com-api](https://parse.bot/marketplace/f90b7910-bfba-4d1e-bdde-f7d2df37ee49/m-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-mobile/`
**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

### Autocomplete

Get autocomplete suggestions for search keywords. Returns suggested search terms and categories based on the text prefix and optional location context. Useful for building type-ahead search UIs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location context for suggestions (e.g. 'New York, NY'). |
| `text` | string | Yes | Search text prefix to autocomplete (e.g. 'sushi', 'thai', 'pizza'). |

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

### Get business details

Get rich details for a specific business by its alias (slug). Returns structured business data including name, rating, review count, categories, location, hours, photos, and price range via Yelp's GraphQL API. Requires resolving the alias to an internal encrypted ID first (automatic).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `alias` | string | Yes | Business alias/slug (e.g. 'joes-pizza-new-york-148'). Obtainable from search_businesses results. |

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

### Get business reviews

Get reviews for a specific business. Returns a flat list of reviews with text, rating, author info, and pagination cursor. Sorted by relevance by default. Each review includes full text, star rating, author display name, and creation date.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `after` | string | No | Pagination cursor for next page of reviews. Obtained from previous response's end_cursor field. |
| `alias` | string | Yes | Business alias/slug (e.g. 'joes-pizza-new-york-148'). Obtainable from search_businesses results. |
| `limit` | integer | No | Number of reviews to return per page. |

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

### Search businesses

Search for businesses by keyword and location. Returns a paginated list of matching businesses with name, alias (slug), and URL. Results are offset-paginated via the start parameter (increments of ~10). The total field reflects the count of results returned in the current page, not a site-wide total.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location to search in (e.g. 'New York, NY', 'San Francisco, CA'). |
| `query` | string | No | Search keyword or category (e.g. 'pizza', 'cafes', 'italian restaurants'). |
| `start` | integer | No | Pagination offset for results. Increments in steps of 10. |

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