{ "item": [ { "name": "Addresses", "description": "Autocomplete, retrieve and verify.", "item": [ { "id": "e455b5e5-1fce-4c25-9d17-8f7efea1fc71", "name": "Suggest addresses as the user types", "request": { "name": "Suggest addresses as the user types", "description": { "content": "Type-ahead suggestions. **Never billed**, so call it on every keystroke. Pass a `session` token and reuse it on the `retrieve` call that follows.", "type": "text/plain" }, "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e7a1049e-fab9-42b0-b050-75e034862d91", "name": "Suggestions, possibly empty. An empty list with a `notice` means the query can never match.", "originalRequest": { "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-WattleAddr-Quota-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-WattleAddr-Quota-Remaining", "value": "" } ], "body": "{\n \"session\": \"\",\n \"query\": \"\",\n \"suggestions\": [\n {\n \"id\": \"\",\n \"formatted\": \"\",\n \"score\": \"\"\n },\n {\n \"id\": \"\",\n \"formatted\": \"\",\n \"score\": \"\"\n }\n ],\n \"notice\": {\n \"code\": \"postal_address_unsupported\",\n \"message\": \"\",\n \"kind\": \"Private Bag\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9c0de2a-6237-44f1-ae5e-04fc8288dd35", "name": "`bad_request` — a parameter is missing or too short (`q` and `address` need at least 3 characters).", "originalRequest": { "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6805c7c6-3075-44a0-8985-b607c8a5e6e3", "name": "`unauthorized` — no key supplied. `invalid_key` — the key is unknown or revoked.", "originalRequest": { "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61a86fe8-43bf-4005-aac9-1ba643bd3742", "name": "`quota_exceeded` — the plan's monthly lookup quota is used up. `feature_unavailable` — the endpoint is not in this plan. `test_mode_expired` — the workspace's free test-mode window has closed.", "originalRequest": { "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8af03fde-4712-4c8c-b41a-c5b7354d1356", "name": "`forbidden_referrer` — the request `Origin`/`Referer` is not in this publishable key's allowed domains. `forbidden_ip` — the caller's IP is not in this secret key's allowlist.", "originalRequest": { "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7219bdc-c3d8-43ed-abd9-64d52776ab72", "name": "`rate_limited` — the per-key burst limit was exceeded. Honour `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "addresses", "autocomplete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) What the user has typed. Minimum 3 characters.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque session token tying these keystrokes to the eventual billable retrieve.", "type": "text/plain" }, "key": "session", "value": "" }, { "disabled": false, "description": { "content": "Maximum suggestions to return.", "type": "text/plain" }, "key": "limit", "value": "8" }, { "disabled": false, "description": { "content": "Restrict to one state or territory. (This can only be one of NSW,VIC,QLD,WA,SA,TAS,ACT,NT)", "type": "text/plain" }, "key": "state", "value": "SA" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8c33ed2a-0b9f-4a4b-9a29-6f71742ead85", "name": "Retrieve the full record for a suggestion", "request": { "name": "Retrieve the full record for a suggestion", "description": { "content": "Returns the structured address for an id returned by `autocomplete`.\n\n**This is the billable call.** With a `session` token it bills once per session; without one it bills every time.", "type": "text/plain" }, "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e2d28a29-f6dc-4179-b71e-84d70c869e6d", "name": "The address record.", "originalRequest": { "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-WattleAddr-Quota-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-WattleAddr-Quota-Remaining", "value": "" } ], "body": "{\n \"billed\": \"\",\n \"components\": {\n \"flat_number\": \"\",\n \"level_number\": \"\",\n \"street_number\": \"\",\n \"street_name\": \"\",\n \"street_type\": \"\",\n \"locality\": \"\",\n \"state\": \"\",\n \"postcode\": \"\"\n },\n \"confidence\": \"low\",\n \"formatted\": \"\",\n \"geo\": null,\n \"gnaf_release\": \"\",\n \"id\": \"\",\n \"source\": \"gnaf\",\n \"test\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9a47d5e-483e-459d-b35d-2db43818fd62", "name": "`unauthorized` — no key supplied. `invalid_key` — the key is unknown or revoked.", "originalRequest": { "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2941045e-711a-4075-9b7d-38df6eca0ef8", "name": "`quota_exceeded` — the plan's monthly lookup quota is used up. `feature_unavailable` — the endpoint is not in this plan. `test_mode_expired` — the workspace's free test-mode window has closed.", "originalRequest": { "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c525146-bdd2-42f2-996f-670070926bb2", "name": "`forbidden_referrer` — the request `Origin`/`Referer` is not in this publishable key's allowed domains. `forbidden_ip` — the caller's IP is not in this secret key's allowlist.", "originalRequest": { "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7821ef53-a57a-453f-acbf-292fdbb5a40b", "name": "`not_found` — no address with that id.", "originalRequest": { "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c925f9-5467-4fe0-9ddb-e0fe455469da", "name": "`rate_limited` — the per-key burst limit was exceeded. Honour `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "addresses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The same token used during autocomplete. Omitting it means every call bills.", "type": "text/plain" }, "key": "session", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) G-NAF address detail PID, taken from a suggestion's `id`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aef60480-4e97-4027-b2c6-521c3954c16a", "name": "Match a free-text address to a canonical record", "request": { "name": "Match a free-text address to a canonical record", "description": { "content": "Takes an address as a single string and returns the best canonical G-NAF match with structured components. Useful for cleaning addresses you already hold.\n\nBillable on the same session rules as `retrieve`, and **only when it matches** — a miss is never charged.", "type": "text/plain" }, "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e5592b83-0c25-4aef-8ea3-618d28eabdcd", "name": "Match result. `matched: false` is a normal outcome, not an error.", "originalRequest": { "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-WattleAddr-Quota-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-WattleAddr-Quota-Remaining", "value": "" } ], "body": "{\n \"matched\": \"\",\n \"match\": {\n \"id\": \"\",\n \"formatted\": \"\",\n \"components\": {\n \"flat_number\": \"\",\n \"level_number\": \"\",\n \"street_number\": \"\",\n \"street_name\": \"\",\n \"street_type\": \"\",\n \"locality\": \"\",\n \"state\": \"\",\n \"postcode\": \"\"\n },\n \"geo\": null,\n \"confidence\": \"medium\"\n },\n \"confidence\": \"low\",\n \"alternatives\": [\n {\n \"id\": \"\",\n \"formatted\": \"\",\n \"score\": \"\"\n },\n {\n \"id\": \"\",\n \"formatted\": \"\",\n \"score\": \"\"\n }\n ],\n \"source\": \"gnaf\",\n \"gnaf_release\": \"\",\n \"billed\": \"\",\n \"notice\": {\n \"code\": \"postal_address_unsupported\",\n \"message\": \"\",\n \"kind\": \"GPO Box\"\n },\n \"test\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f42c6922-d17d-4060-b1d2-1465c85d7a5d", "name": "`bad_request` — a parameter is missing or too short (`q` and `address` need at least 3 characters).", "originalRequest": { "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4b7fd73-78f8-4daa-85b6-5fc32840810b", "name": "`unauthorized` — no key supplied. `invalid_key` — the key is unknown or revoked.", "originalRequest": { "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65650890-be7e-4cd9-b8e8-b14b975013cd", "name": "`quota_exceeded` — the plan's monthly lookup quota is used up. `feature_unavailable` — the endpoint is not in this plan. `test_mode_expired` — the workspace's free test-mode window has closed.", "originalRequest": { "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "245c7920-8cb4-4949-9595-3aeeba80986a", "name": "`forbidden_referrer` — the request `Origin`/`Referer` is not in this publishable key's allowed domains. `forbidden_ip` — the caller's IP is not in this secret key's allowlist.", "originalRequest": { "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1f015d7-646b-44f3-9149-08db6e6b12df", "name": "`rate_limited` — the per-key burst limit was exceeded. Honour `Retry-After`.", "originalRequest": { "url": { "path": [ "v1", "addresses", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"session\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Service", "description": "Service health and dataset vintage.", "item": [ { "id": "e36f3a9a-58d0-4504-8fbd-43e1e100e655", "name": "Service health and dataset vintage", "request": { "name": "Service health and dataset vintage", "description": { "content": "Unauthenticated. Reports engine and database health, which G-NAF release is being served, and which Australian region is serving it.", "type": "text/plain" }, "url": { "path": [ "v1", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5e79d233-f27d-4c78-96a9-a82e3fd11d6e", "name": "Service status.", "originalRequest": { "url": { "path": [ "v1", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"operational\",\n \"engine\": {\n \"name\": \"\",\n \"ok\": \"\"\n },\n \"database\": \"\",\n \"gnaf_release\": \"\",\n \"region\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf272fe6-5cb5-4e8b-a08d-8c30f1d0838e", "name": "`engine_unavailable` — the address engine or database is unreachable. The body still parses as an Error.", "originalRequest": { "url": { "path": [ "v1", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"rate_limited\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.wattleaddr.com.au" } ], "info": { "_postman_id": "27f73777-795b-46a2-b27a-f53fe2d83bfd", "name": "WattleAddr Address API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Australian address autocomplete, retrieve and verification, built on the Geocoded National Address File (G-NAF) and served entirely from Australian infrastructure.\n\n## Billing model\n\nBilling is per **session**, not per request — the same unit Google Places uses.\n\n1. Generate a session token (any opaque string; a UUID is ideal) when the user starts typing.\n2. Pass it as `session` on every `autocomplete` call. **Autocomplete is never billed**, however many keystrokes it takes.\n3. Pass the same token to `retrieve` (or `verify`). That call bills **once**. Repeating it with the same token does not bill again.\n\nCalling `retrieve` with **no** `session` always bills, because there is nothing to deduplicate against. Always send a session token.\n\n## Key types\n\n- **Secret keys** (`waddr_sk_…`) are for server-side use. They may carry an IP allowlist.\n- **Publishable keys** (`waddr_pk_…`) are safe in a browser. They are restricted to the domains you configure, checked against the request `Origin`/`Referer`.\n\n## Coverage boundary\n\nG-NAF is a register of **physical** addresses. It contains no PO Boxes, GPO Boxes, Locked Bags or Private Bags, and it says nothing about whether Australia Post delivers to an address. Queries for postal addresses return `200` with an empty result and a `postal_address_unsupported` notice — see the `Notice` schema.\n\nContact Support:\n Name: WattleAddr\n Email: info@rrsols.com.au", "type": "text/plain" } } }