# Yelp (Australia) — 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 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. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-yelp-com-au-api-684a8395/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## 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.paywithlocus.com/api/wrapped/parse-yelp-com-au-api-684a8395/get_business_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-yelp-com-au-api-684a8395/get_business_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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.paywithlocus.com/api/wrapped/parse-yelp-com-au-api-684a8395/search_businesses \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","query":"<string>","start":"<integer>"}'
```