--- title: "Get Address" method: GET path: "/addresses/{addressId}" tags: ["address"] --- # Get Address `GET /addresses/{addressId}` ## Request - Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin) - URL: `/addresses/{addressId}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) returns detailed information about a specific address ## Path parameters - `addressId` string, required ## Response `200` successful query - Address: A physical Australian address in structured and unstructured formats. If an address has a "flat" component (e.g. UNIT 12, 32 SOME ST...), then it will also have an `smla` field, a shortened version of `mla`. e.g. (12/32 SOME ST...) Corrected 2026-08-09: this description previously also promised `ssla` on this representation. It is not served here. `ssla` is real, but it belongs to the search result, not the address detail: the loader lifts `sla` and `ssla` out before building the stored object this endpoint spreads, so `ssla` never reaches it. Same class as the `geo` name corrected below - a shipped spec naming something the endpoint does not return. - `pid` string, required: The Persistent Identifier is unique to the real world feature this record represents. - `structured` StructuredAddress, required - `buildingName` string: Combines both building/property name fields. (AS4590:2006 5.7). - `lotNumber` object - `prefix` string - `number` string - `suffix` string - `flat` object - `type` object - `name` string - `code` string - `prefix` string - `number` integer - `suffix` string - `level` object - `type` object - `na,e` string - `code` string - `prefix` string - `number` integer - `suffix` string - `number` object - `prefix` string - `number` integer - `suffix` string - `last` object - `prefix` string - `number` integer - `suffix` string - `street` object - `name` string - `type` object - `name` string - `code` string - `suffix` object - `name` string - `code` string - `locality` object - `name` string - `class` object - `code` string - `name` string - `state` object - `name` string - `abbreviation` string - `postcode` string - `confidence` integer: Reflects how many contributor databases this address appears in (0 = 1 database, 1 = 2 database etc.). - `sla` string, required: The full address flattened to a single line. The primary use is for search results and for autocomplete. - `mla` string[], required: The full address flattened to at most four lines. The primary use is for address labels - `smla` string[]: The full address flattened to at most four lines. The primary use is for address labels - `geocoding` AddressGeocoding: Geocoding information about the address - `level` object - `code` integer: Binary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc. - `name` string: Name of the geocode level type code. - `geocodes` object[] - `default` boolean: Indicates if the geocode is the default or a site geocode (i.e. from *_ADDRESS_DEFAULT_GEOCODE_psv or from *_ADDRESS_SITE_GEOCODE_psv) - `latitude` number - `longitude` number - `reliability` object - `code` integer: Spatial precision of the geocode expressed as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). - `name` string: Name of the geocode reliability code. - `type` object - `code` integer: Unique abbreviation for geocode feature. (e.g. "PRCL") (SAWG 7.4.1). - `name` string: Name of the geocode type code. - `description` string: Additional textual data - `precedence` string: DEPRECATED - do not depend on this field. It carries the source dataset's primary/secondary flag and has never been part of any published spec. It is documented here only so its removal is announced rather than silent. (Swagger 2.0 has no `deprecated` keyword for schema properties, so the signal is carried in this description; the OpenAPI 3 spec served at /api-docs sets `deprecated: true`.) - `sla_range_expanded` string[]: DEPRECATED - do not depend on this field, and do not use it for search. It holds the two endpoint forms of a range address, but it has NEVER been searchable: it was written to a path the index mapping does not cover, so no query has ever matched it. Range addresses are already reachable by either endpoint without it. Scheduled for removal; retained for now only so the response body and ETag of existing range addresses do not change. (Swagger 2.0 has no `deprecated` keyword for schema properties, so the signal is carried in this description; the OpenAPI 3 spec served at /api-docs sets `deprecated: true`.) ## Other responses - `404`: not found - `500`: unexpected error - `503`: service unavailable ## Changes - **2026-08-09** `4a4c43b9b253`: 2 info - api operation id `getAddress` removed and replaced with `` - added the non-success response with the status `404` - **2026-07-17** `6217bf13b26e`: 2 info - api operation id `getAddress` was added - removed the non-success response with the status `404` - **2026-04-01** `08b94015aaa5`: 2 info - api operation id `getAddress` removed and replaced with `` - added the non-success response with the status `404` - **2021-04-26** `d76dcbb665be`: 2 info - added the non-success response with the status `500` - added the non-success response with the status `503` - **2019-07-30** `b37ff2c71cfe`: 1 warning - the optional response header `Link` removed for the status `200` [Operation history](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/changes/addresses/:addressId/get.md) --- [API](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass.md) - [All operations](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/llms.txt) - [OpenAPI document](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/revisions/4a4c43b9b253?raw)