openapi: 3.1.0 info: version: v2 title: Address API description: "- **[Address/Match](https://developer.proptrack.com.au/docs/apis/address/operations/get-a-api-v-2-address-match):\ \ GET /api/v2/address/match**
Matches to a corresponding record on PropTrack's master address\ \ file based on a given address string
\n- **[Address/Suggest](https://developer.proptrack.com.au/docs/apis/address/operations/get-a-api-v-2-address-suggest):\ \ GET /api/v2/address/suggest**
Suggests a list of addresses based on a given address string
\n\
\n\n
\n
\n \n \n \n \n
\n \n Getting Started\n
\n \n \ \ Start your journey\n \n \n \n \n \n \n \n \n \ \ API References\n \n \n Explore our knowledge base\n \ \ \n \n \n\ \ \n \n \n \n \n Useful Docs\n \n \n \ \ Helpful resources\n \n \n \n \n \n \n \n \n Get in Touch\n \n\ \ \n Connect with us\n \n \n\ \ \n \n \n" termsOfService: https://developer.proptrack.com.au/docs/apis/terms-of-use contact: name: PropTrack url: https://www.proptrack.com.au/contact-us email: https://www.proptrack.com.au/contact-us servers: - url: https://data.proptrack.com description: '' paths: /api/v2/address/match: get: tags: - Match summary: /api/v2/address/match description: "Matches to a corresponding record on PropTrack's master address file based on a given\ \ address string.\r\n

\r\n\r\nRefer to the [API Guide](https://developer.proptrack.com.au/docs/apis/guide#address-matching)\ \ for best practices for input address formatting." operationId: address.match parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO - name: q in: query description: Address on which to search required: true schema: type: string examples: - 123A Smith Street Sydney NSW 2000 responses: '200': description: ' > #### Success (200) ' content: application/json: schema: type: object x-examples: example-1: propertyId: '123456' gpid: GANSW1234 address: addressIdentifier: 123A/123 Smith Street Sydney NSW 1234 properties: propertyId: type: string description: Unique identifier for a property examples: - '123456' gpid: type: string description: Geoscape issued unique identifer examples: - GANSW1234 matchScore: enum: - EXCELLENT - GOOD - OK - POOR description: Defines the quality of the match returned
Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality) type: string x-stoplight: id: 1b2q9cygd9erf address: type: object properties: fullAddress: type: string description: Full address of the matched property examples: - 123A/123 Smith Street Sydney NSW 1234 example: LOT 1,UNIT 1,2-6 LOUISA ROAD,BIRCHGROVE NSW 2041 lotNumber: type: - string - 'null' x-stoplight: id: pymnxtikzkbua example: '1' description: Lot number of the matched property unitNumber: type: - string - 'null' x-stoplight: id: kgrs2jb1lq4cx example: '1' description: Unit number of the matched property streetNumber: type: string x-stoplight: id: vanyby1exss91 example: 2-6 description: Street number of the matched property streetName: type: string x-stoplight: id: 84orxvfoykgxm example: LOUISA description: Street name of the matched property streetType: type: string x-stoplight: id: x4ndwcma3f8mz example: ROAD description: Street type of the matched property suburb: type: string x-stoplight: id: sj6i762vc7cao example: BIRCHGROVE description: Suburb name of the matched property state: type: string x-stoplight: id: 0x37l2p398s6e example: NSW description: State name (abbreviated) of the matched property postcode: type: string x-stoplight: id: l9zq1qsuny2qa example: '2041' description: The postal area code of the matched property examples: Example 1: value: propertyId: '123456' gpid: GANSW1234 matchScore: EXCELLENT address: fullAddress: LOT 1,UNIT 1,2-6 LOUISA ROAD,BIRCHGROVE NSW 2041 lotNumber: '1' unitNumber: '1' streetNumber: 2-6 streetName: LOUISA streetType: ROAD suburb: BIRCHGROVE state: NSW postcode: '2041' headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addressmatch) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 7004 level: CRITICAL description: Required parameter is missing - Please ensure that all required parameters are included in the request parameters: q: The address parameter must be present in the request properties: errors: type: array items: type: object properties: code: type: integer enum: - 7004 description: Defines the type of error that has occurred level: type: string deprecated: true enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' description: type: string description: Overview of the error that has occurred example: Required parameter is missing - Please ensure that all required parameters are included in the request parameters: type: object description: Lists the parameter/s which is causing the error, and the rule that was invoked properties: q: type: string example: The address parameter must be present in the request required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addressmatch) for information on error handling.' content: application/json: schema: type: object x-examples: example-1: errors: - code: 9012 description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addressmatch) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint properties: errors: type: array items: type: object properties: code: type: integer enum: - 9003 example: 9003 description: Defines the type of error that has occurred description: type: string example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint description: Overview of the error that has occurred required: - code - description '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addressmatch) for information on error handling.' content: application/json: schema: type: object x-examples: example-1: errors: - code: 7002 description: Address cannot be matched, the address entered does not match a record within our system - Please consider revising the address query parameter properties: errors: type: array items: type: object properties: code: enum: - 7002 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Address cannot be matched, the address entered does not match a record within our system - Please consider revising the address query parameter required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addressmatch) for information on error handling.' content: application/json: schema: type: object x-examples: example-1: errors: - code: 9011 description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: enum: - 9011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addressmatch) for information on error handling.' servers: - url: https://data.proptrack.com /api/v2/address/suggest: get: tags: - Suggest summary: /api/v2/address/suggest description: Suggests a list of addresses based on a given address string. operationId: address.suggest parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO - name: q in: query description: Address on which to search
Refer to [minimum required input](https://developer.proptrack.com.au/docs/apis/faqs#what-is-the-minimum-required-input) required: true schema: type: string examples: - 1/67 Louisa Rd - name: numberOfResults in: query description: Defines the maximum number of results that are returned as suggested addresses schema: type: integer minimum: 1 maximum: 25 default: 25 examples: - 25 responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: array items: type: object properties: propertyId: type: string description: Unique identifier for a property examples: - '1026185' address: type: object properties: fullAddress: type: string description: Full address of the suggested property examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 unitNumber: type: - string - 'null' description: Unit number of the suggested property examples: - UNIT 1 streetNumber: type: string description: Street number of the suggested property examples: - '67' streetName: type: string description: Street name of the suggested property examples: - LOUISA streetType: type: string description: Street type of the suggested property examples: - RD suburb: type: string description: Suburb of the suggested property examples: - BIRCHGROVE postcode: type: integer description: Postcode of the suggested property examples: - 2041 state: type: string description: State of the suggested property examples: - NSW x-examples: Example 1: - propertyId: '1234567' address: fullAddress: 1/260 COBBITTY ROAD COBBITTY NSW 2570 unitNumber: UNIT 1 streetNumber: '260' streetName: COBBITTY streetType: RD suburb: COBBITTY postcode: 2570 state: NSW - propertyId: '1234568' address: fullAddress: 261 COBBITTY ROAD COBBITTY NSW 2570 unitNumber: null streetNumber: '261' streetName: COBBITTY streetType: RD suburb: COBBITTY postcode: 2570 state: NSW - propertyId: '1234570' address: fullAddress: 263 COBBITTY ROAD COBBITTY NSW 2570 unitNumber: null streetNumber: '263' streetName: COBBITTY streetType: RD suburb: COBBITTY postcode: 2570 state: NSW - propertyId: '1234571' address: fullAddress: 264 COBBITTY ROAD COBBITTY NSW 2570 unitNumber: null streetNumber: '264' streetName: COBBITTY streetType: RD suburb: COBBITTY postcode: 2570 state: NSW - propertyId: '1234572' address: fullAddress: 265 COBBITTY ROAD COBBITTY NSW 2570 unitNumber: null streetNumber: '265' streetName: COBBITTY streetType: RD suburb: COBBITTY postcode: 2570 state: NSW examples: Example with 5 results: value: - propertyId: '1026185' address: fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 unitNumber: UNIT 1 streetNumber: '67' streetName: LOUISA streetType: RD suburb: BIRCHGROVE postcode: 2041 state: NSW - propertyId: '1026131' address: fullAddress: 1/2-6 Louisa Rd, Birchgrove, NSW 2041 unitNumber: UNIT 1 streetNumber: 2-6 streetName: LOUISA streetType: RD suburb: BIRCHGROVE postcode: 2041 state: NSW - propertyId: '1026183' address: fullAddress: 1/66 Louisa Rd, Birchgrove, NSW 2041 unitNumber: UNIT 1 streetNumber: '66' streetName: LOUISA streetType: RD suburb: BIRCHGROVE postcode: 2041 state: NSW - propertyId: '1026203' address: fullAddress: 1/68 Louisa Rd, Birchgrove, NSW 2041 unitNumber: UNIT 1 streetNumber: '68' streetName: LOUISA streetType: RD suburb: BIRCHGROVE postcode: 2041 state: NSW - propertyId: '2443521' address: fullAddress: 1/97 Louisa Rd, Birchgrove, NSW 2041 unitNumber: UNIT 1 streetNumber: '97' streetName: LOUISA streetType: RD suburb: BIRCHGROVE postcode: 2041 state: NSW Non-Unit Property with 3 Results: value: - propertyId: '8412322' address: fullAddress: 146 Short St, Birchgrove, NSW 2041 unitNumber: null streetNumber: '146' streetName: SHORT streetType: ST suburb: BIRCHGROVE postcode: 2041 state: NSW - propertyId: '8412307' address: fullAddress: 140 Short St, Birchgrove, NSW 2041 unitNumber: null streetNumber: '140' streetName: SHORT streetType: ST suburb: BIRCHGROVE postcode: 2041 state: NSW - propertyId: '8412306' address: fullAddress: 142 Short St, Birchgrove, NSW 2041 unitNumber: null streetNumber: '142' streetName: SHORT streetType: ST suburb: BIRCHGROVE postcode: 2041 state: NSW No Suggestions Found: value: [] headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addresssuggest) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 7004 level: CRITICAL description: Required parameter is missing - Please ensure that all required parameters have been included parameters: q: q is a required parameter numberOfResults: numberOfResults must not exceed a value of 25 properties: errors: type: array items: type: object properties: code: type: integer enum: - 7004 - 7006 - 7008 - 7011 description: Defines the type of error that has occurred examples: - 7004 level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Required parameter is missing - Please ensure that all required parameters have been included parameters: type: object description: Lists the parameter/s which is causing the error, and the rule that was invoked properties: q: type: string examples: - q is a required parameter numberOfResults: type: string examples: - numberOfResults must not exceed a value of 25 required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addresssuggest) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred examples: - 9012 type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addresssuggest) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint properties: errors: type: array items: type: object properties: code: type: integer description: Defines the type of error that has occurred enum: - 9003 description: type: string description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addresssuggest) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9011 description: Defines the type of error that has occurred examples: - 9011 type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#addresssuggest) for information on error handling.' servers: - url: https://data.proptrack.com