geocode_address
Resolve a freeform address string to candidate G-NAF identifiers.
Use this before calling any /v1/properties/{gnaf_id}/... route —
those endpoints require a GNAF in the path. Returns up to 10
candidates, ranked by Meilisearch score.
Price: 1¢ per call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | Freeform address string. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | The endpoint's payload, or `null` when Microburbs has no value. | |
| reason | No | Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success. | |
| message | No | Human-readable explanation. Omitted on success. | |
| available | No | `false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator. |