# Yellowpages (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 Australian businesses by category to find contact details, addresses, and emails, then retrieve comprehensive business information for any listing. Perfect for building lead lists, verifying business information, or discovering local service providers across Australia.

**Category:** Business Directories | **Website:** [yellowpages.com.au/](https://yellowpages.com.au/) | **Docs:** [parse.bot/marketplace/e5b0dc98-1dbb-45dd-97c1-623cd2d70767/yellowpages-com-au-api](https://parse.bot/marketplace/e5b0dc98-1dbb-45dd-97c1-623cd2d70767/yellowpages-com-au-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/yellowpages-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

Get detailed information for a specific business listing from its Yellow Pages URL. Returns name, full address components, phone, email, website, opening hours, and category. Use the details_url from search_listings results. A single round-trip fetch per listing.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | The Yellow Pages listing URL for the business to retrieve (details_url from search_listings results, e.g. 'https://www.yellowpages.com.au/sydney-nsw/bpp/<business-slug-id>'). |

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

### Search listings

Search for business listings on Yellow Pages Australia by category and location. Returns up to 30 listings per page with name, address, phone, website, category, and a details URL for fetching full business information. Paginates via an integer page counter; each page returns up to 30 results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `clue` | string | Yes | Business category or name to search for (e.g. 'Restaurants', 'Dentists', 'Plumbers'). Used as a URL slug so multi-word terms are hyphenated internally. |
| `location` | string | No | Location to search within, formatted as 'City STATE' (e.g. 'Sydney NSW', 'Melbourne VIC', 'Brisbane QLD'). Omitting searches all of Australia. |
| `max_pages` | integer | No | Number of pages to fetch per request. Each page returns up to 30 listings. |
| `page` | integer | No | Page number (1-based). |

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