# Hipages — 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 for local service businesses on hipages.com.au, view detailed business profiles and customer reviews, and explore available service categories all in one place. Find the right tradesperson or service provider by browsing ratings, contact information, and customer feedback.

**Category:** Business Directories | **Website:** [hipages.com.au/](https://hipages.com.au/) | **Docs:** [parse.bot/marketplace/500e5945-ae7a-4e61-b6a8-17de9cde5085/hipages-com-au-api](https://parse.bot/marketplace/500e5945-ae7a-4e61-b6a8-17de9cde5085/hipages-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/hipages/`
**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 profile

Get full profile details of a business by its slug. Returns structured JSON-LD data including ABN, aggregate ratings, services offered, and sample reviews. The slug is the 'key' field from search_businesses results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Business slug from search_businesses results (the 'key' field, e.g. 'emcoelectricalservices'). |

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

### Get business reviews

Get reviews and recommendations for a business. Returns review objects with author name, rating, and review body text extracted from the business profile page's JSON-LD. The slug is the 'key' field from search_businesses results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Business slug from search_businesses results (the 'key' field, e.g. 'emcoelectricalservices'). |

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

### List categories

List all available trade categories and their URL slugs from hipages.com.au. Returns the complete set of trade categories. Use the returned slugs as the 'category' input to search_businesses.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/hipages/list-categories \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search businesses

Search for businesses by trade category and location on hipages.com.au. Returns a paginated list of business listings including ratings, contact info, service area, and a sample recommendation. Paginated by integer page number. Each business carries a 'key' slug usable with get_business_profile and get_business_reviews.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Trade category slug (e.g. 'electricians', 'plumbers', 'air_conditioning'). Use list_categories to discover available slugs. |
| `city` | string | No | City name (e.g. 'sydney', 'melbourne', 'brisbane'). |
| `page` | integer | No | Page number for pagination, starting at 1. |
| `state` | string | No | Australian state or territory code. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/hipages/search-businesses \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","city":"<string>","page":"<integer>","state":"<string>"}'
```

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