# Yelp (Australia) — 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 compare businesses across Yelp Australia by location. Retrieve detailed business information including ratings, categories, and contact details, and access paginated customer reviews with author profiles and rating distributions.

**Category:** Reviews & Ratings | **Website:** [yelp.com.au/](https://yelp.com.au/) | **Docs:** [parse.bot/marketplace/684a8395-8881-4aac-beba-35504a34054e/yelp-com-au-api](https://parse.bot/marketplace/684a8395-8881-4aac-beba-35504a34054e/yelp-com-au-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/yelp-australia/`
**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

Retrieve detailed information for a single business including rating distribution, full address, and categories. Accepts either `biz_id` (the encid from search results) or `alias` (the URL slug). When only `alias` is provided, an additional request resolves it to an encid. Returns null `rating_distribution` when the site omits that data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `alias` | string | No | Business alias/slug from search results (e.g., 'gentleman-and-a-van-sydney') |
| `biz_id` | string | No | Business encid from search results (e.g., 'eL3VvaB9F0g9LtP5xcLE5A') |

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

### Get business reviews

Retrieve paginated reviews for a business by its encid. Returns review text, rating, date, and author profile for each review. Pagination is cursor-based: pass `next_cursor` from the previous response as `after` to fetch the next page. Reviews are sorted by relevance. Each page returns up to `limit` reviews (default 10).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `after` | string | No | Cursor for pagination (next_cursor from previous response) |
| `biz_id` | string | Yes | Business encid (e.g., 'eL3VvaB9F0g9LtP5xcLE5A') |
| `limit` | integer | No | Number of reviews per page (default 10) |

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

### Search businesses

Full-text search for businesses in a specific Australian location. Returns up to 10 results per page with business names, ratings, categories, and addresses. Pagination is offset-based via `start` (increments of 10). Results include both organic listings and ads (flagged via `is_ad`). An empty `query` returns popular businesses in the location.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | Yes | Location to search in format 'City STATE' (e.g., 'Sydney NSW', 'Melbourne VIC', 'Brisbane QLD') |
| `query` | string | No | Search query (e.g., 'movers', 'removalists', 'restaurants') |
| `start` | integer | No | Offset for pagination, increments of 10 |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/yelp-australia/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://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.