# Mapshare — 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 locate addresses, streets, suburbs, and properties across Victoria by entering street addresses, lot identifiers, postcodes, or coordinates. Get detailed location information and suggestions powered by official Victorian government mapping data to find exactly where you need to go.

**Category:** Maps & Geospatial | **Website:** [mapshare.vic.gov.au/](https://mapshare.vic.gov.au/) | **Docs:** [parse.bot/marketplace/3a00e520-f9f6-486c-bf20-1170b537e5a6/mapshare-vic-gov-au-api](https://parse.bot/marketplace/3a00e520-f9f6-486c-bf20-1170b537e5a6/mapshare-vic-gov-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-mapshare-vic-gov-au-api-3a00e520/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### find_address_candidates_crown_parcel

Lookup Crown land parcels by their identifier. Returns candidate parcel locations with coordinates and attributes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Crown parcel identifier (e.g. '2000\PP2277') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_crown_parcel \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### find_address_candidates_ezi_address

Geocode a standard Victorian street address using the EZI dataset. Returns candidate locations with coordinates, match score, and attributes. Use a magicKey from suggest_ezi_address for the most precise result.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `magic_key` | string | No | magicKey from a suggest_ezi_address suggestion for precise lookup. |
| `query` | string | Yes | Address string to geocode (e.g. '100 COLLINS STREET MELBOURNE') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_ezi_address \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"magic_key":"<string>","query":"<string>"}'
```

### find_address_candidates_locality

Geocode a Victorian suburb or locality name to get its centroid coordinates. Returns candidate locations with coordinates, match score, and attributes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Locality name to geocode (e.g. 'MELBOURNE') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_locality \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### find_address_candidates_parcel_lot_street

Geocode a lot/parcel/street address to get coordinates and full attribute details. Use a magicKey from suggest_parcel_lot_street for precise results. Without a magicKey, performs a free-text search which may return zero candidates if the query is ambiguous.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `magic_key` | string | No | magicKey from a suggest_parcel_lot_street suggestion for precise lookup. |
| `query` | string | Yes | Address string to geocode (e.g. 'Lot 1 COLLINS AVENUE ALTONA NORTH (1\LP58070 - 2)') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_parcel_lot_street \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"magic_key":"<string>","query":"<string>"}'
```

### find_address_candidates_postcode

Geocode a Victorian postcode area. Returns the centroid location for the given postcode with coordinates and attributes.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | 4-digit Victorian postcode (e.g. '3000') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_postcode \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### find_address_candidates_spi

Lookup parcels by Standard Parcel Identifier (SPI). Returns candidate parcel locations with coordinates and attributes. Partial SPI matching is supported (e.g. plan number without lot prefix).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | SPI string to search for (e.g. 'PS831714') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_spi \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### find_address_candidates_street

Geocode a Victorian street name to get its centroid coordinates. Returns candidate locations with coordinates, match score, and attributes. Note: coordinates are in the Victorian state grid projection (EPSG:3111), not WGS84.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Street name to geocode (e.g. 'COLLINS STREET MELBOURNE') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/find_address_candidates_street \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### geocode_server_info

Get metadata about a specific geocoder service including its capabilities, address fields, locator properties, and spatial reference. Capabilities indicate whether the service supports Geocode, ReverseGeocode, and/or Suggest operations.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `service_name` | string | No | Name of the geocoder service to query. Accepted values: VMParcelLotStreet, VMAddressEZIAdd, VMLocality, VMStreet, VMParcelSPI, Postcode, VMParcelCrownApproved. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/geocode_server_info \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service_name":"<string>"}'
```

### list_geocoder_services

List all available geocoder services on the MapShare Victoria ArcGIS server. Returns the server version and an array of available geocoding service objects with name and type. Useful for discovering which geocoder services are available before querying them.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/list_geocoder_services \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### reverse_geocode_parcel_lot_street

Find the nearest lot/parcel address for a given coordinate pair. Accepts longitude/latitude in WGS84/GDA94 (EPSG:4283). Returns the closest matching parcel address and its location.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `x` | number | Yes | Longitude coordinate (e.g. 144.9631) |
| `y` | number | Yes | Latitude coordinate (e.g. -37.8136) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/reverse_geocode_parcel_lot_street \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"x":"<number>","y":"<number>"}'
```

### suggest_ezi_address

Get address suggestions for standard Victorian street addresses using the EZI (Easy Addressing) dataset. Returns matching suggestions with magicKey values for use with find_address_candidates_ezi_address. Text matching is case-insensitive.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max_suggestions` | integer | No | Maximum number of suggestions to return. |
| `text` | string | Yes | Address string to search for (e.g. '123 COLLINS STREET MELBOURNE') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/suggest_ezi_address \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"max_suggestions":"<integer>","text":"<string>"}'
```

### suggest_locality

Get suggestions for Victorian suburb or locality names. Returns matching locality suggestions with magicKey values for use with find_address_candidates_locality. Partial name matching is supported.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `text` | string | Yes | Locality name search string (e.g. 'MEL') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/suggest_locality \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"<string>"}'
```

### suggest_parcel_lot_street

Get address suggestions for lot, parcel, or street queries using the VMParcelLotStreet geocoder. Returns matching suggestions with magicKey values that can be passed to find_address_candidates_parcel_lot_street for precise geocoding. Text matching is case-insensitive.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max_suggestions` | integer | No | Maximum number of suggestions to return. |
| `text` | string | Yes | Address string to search for (e.g. 'LOT 1 COLLINS STREET') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/suggest_parcel_lot_street \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"max_suggestions":"<integer>","text":"<string>"}'
```

### suggest_street

Get suggestions for Victorian street names. Returns matching street name suggestions with magicKey values for use with find_address_candidates_street. Partial name matching is supported.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `text` | string | Yes | Street name search string (e.g. 'COLLINS') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-mapshare-vic-gov-au-api-3a00e520/suggest_street \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"<string>"}'
```