# Wine Companion — 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.

> Browse and explore Australian wineries from Wine Companion's comprehensive directory, including contact details, ratings, and regional locations. Search and filter by state, region, or facilities to find wineries across Australia.

**Category:** Food & Dining | **Website:** [winecompanion.com.au/wineries](https://winecompanion.com.au/wineries) | **Docs:** [parse.bot/marketplace/8d124c6a-27b6-4e79-90e3-bc082a93ec97/winecompanion-com-au-api](https://parse.bot/marketplace/8d124c6a-27b6-4e79-90e3-bc082a93ec97/winecompanion-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-winecompanion-com-au-api-8d124c6a/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_all_wineries_with_details

Retrieve wineries with full contact details in batches. Iterates through the winery listing and fetches each profile page for detailed contact information (phone, email, address, website, winemaker). Use limit and offset for batch processing. Each winery detail page is fetched individually with a configurable delay between requests.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `delay` | number | No | Delay in seconds between detail page requests |
| `limit` | integer | No | Number of wineries to process in this batch |
| `offset` | integer | No | Starting position in the full list (0-indexed) |
| `region` | string | No | Filter by wine region in lowercase (e.g. 'barossa valley') |
| `state` | string | No | Filter by Australian state in lowercase (e.g. 'victoria') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-winecompanion-com-au-api-8d124c6a/get_all_wineries_with_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"delay":"<number>","limit":"<integer>","offset":"<integer>","region":"<string>","state":"<string>"}'
```

### get_regions

Get all wine regions, optionally filtered by Australian state. Returns region names, IDs, state info, and URL paths. Useful for discovering valid region filter values for list_wineries and search_wineries.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `state` | string | No | Filter by Australian state in lowercase (e.g. 'victoria', 'south australia'). Omitting returns all regions across Australia. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-winecompanion-com-au-api-8d124c6a/get_regions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"state":"<string>"}'
```

### get_winery_details

Get detailed contact information for a specific winery by its profile URL path. Returns phone, email, address, website, winemaker, established year, opening hours, and vineyard area. The url_path is obtained from the winery_url_path field in list_wineries or search_wineries results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url_path` | string | Yes | Winery profile URL path from list_wineries results (e.g. '/wineries/victoria/grampians/seppelt') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-winecompanion-com-au-api-8d124c6a/get_winery_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url_path":"<string>"}'
```

### list_wineries

List wineries from the Wine Companion directory with pagination. Returns basic winery info including name, region, state, rating, and facilities. Server-side filtering by state, region, or facilities. Ordered by rating descending. Max page size is 50.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `facilities` | string | No | Filter by facilities: 'accommodation', 'cellardoor', 'food' |
| `page_number` | integer | No | Page number (1-indexed) |
| `page_size` | integer | No | Results per page (max 50) |
| `region` | string | No | Filter by wine region in lowercase (e.g. 'barossa valley', 'margaret river', 'yarra valley') |
| `state` | string | No | Filter by Australian state in lowercase (e.g. 'victoria', 'south australia', 'western australia', 'new south wales', 'queensland', 'tasmania') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-winecompanion-com-au-api-8d124c6a/list_wineries \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"facilities":"<string>","page_number":"<integer>","page_size":"<integer>","region":"<string>","state":"<string>"}'
```

### search_wineries

Search and filter wineries by state, region, or facilities. Returns paginated basic winery info. Uses the same underlying data as list_wineries but oriented toward filtered search. At least one filter (state, region, or facilities) is recommended for meaningful results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `facilities` | string | No | Filter by facilities: 'accommodation', 'cellardoor', 'food' |
| `page_number` | integer | No | Page number (1-indexed) |
| `page_size` | integer | No | Results per page (max 50) |
| `region` | string | No | Filter by wine region in lowercase (e.g. 'barossa valley', 'margaret river') |
| `state` | string | No | Filter by Australian state in lowercase (e.g. 'victoria', 'south australia') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-winecompanion-com-au-api-8d124c6a/search_wineries \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"facilities":"<string>","page_number":"<integer>","page_size":"<integer>","region":"<string>","state":"<string>"}'
```