openapi: 3.1.0 info: version: v2 title: Market description: "- **[Market/Auctions](https://developer.proptrack.com.au/docs/apis/market%2Foperations%2Flist-api-v-2-market-auctions):\ \ GET /api/v2/market/auctions**
Retrieves auction result statistics for a given state, suburb\ \ or greater capital city statistical area\n- **[Market/Rent History](https://developer.proptrack.com.au/docs/apis/market/operations/get-a-api-v-2-market-rent-historic):\ \ GET /api/v2/market/rent/historic/{metric}**
Retrieves historic rental transaction statistics\ \ for a given suburb\n- **[Market/Sale History](https://developer.proptrack.com.au/docs/apis/market/operations/get-a-api-v-2-market-sale-historic):\ \ GET /api/v2/market/sale/historic/{metric}**
Retrieves historic sale transaction statistics for\ \ a given suburb
\n- **[Market/Supply & Demand](https://developer.proptrack.com.au/docs/apis/market/operations/get-a-api-v-2-market-supply-and-demand):\ \ GET /api/v2/market/supply-and-demand/{metric}**
Retrieves property supply and consumer demand\ \ statistics for a given suburb
\n- **[Market/Demographics](https://developer.proptrack.com.au/docs/apis/branches/main/market/operations/list-api-v-2-market-demographics):\ \ GET /api/v2/market/demographics**
Retrieves Demographic statistics for a given suburb or greater\ \ capital city statistical area

\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 paths: /api/v2/market/auctions: get: tags: - Auction Results summary: /api/v2/market/auctions description: Retrieves auction result statistics for a given state, suburb or greater capital city statistical area. operationId: get-api-v2-market-auctions 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: searchType in: query description: Defines the identifier used
Refer to [Search Type Values](https://developer.proptrack.com.au/docs/apis/guide#valid-market-search-types) required: true schema: enum: - suburb - state - gccsa type: string - name: suburb in: query description: 'Suburb name
Note: If `searchType` equals `suburb`, then this field is required' schema: type: string examples: - Berwick - name: state in: query description: 'State or territory within Australia
Note: If `searchType` equals `suburb` or `state`, then this field is required' schema: enum: - act - nsw - nt - qld - sa - tas - vic - wa examples: - vic type: string - name: postcode in: query description: 'Four digit postcode
Note: If `searchType` equals `suburb`, then this field is required' schema: type: number examples: - 3806 - name: gccsaCode in: query description: 'Greater Capital City Statistical Area (GCCSA) code
Note: If `searchType` equals `gccsa`, then this field is required' schema: type: string examples: - 2GMEL - name: startDate in: query description: Start of date range to be queried. Defaulted to 4 weeks prior to today's date if left empty
Format `YYYY-MM-DD` schema: type: string examples: - '2023-08-01' - name: endDate in: query description: End of date range to be queried. Defaulted to today's date if left empty
Format `YYYY-MM-DD` schema: type: string examples: - '2023-09-30' responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: object properties: dateRanges: type: array description: Time period which the metric is expressed across items: type: object properties: startDate: type: string description: "First date in the date range
\r\nFormat `YYYY-MM-DD`" examples: - '2023-10-02' endDate: type: string description: "Final date in the date range
\r\nFormat `YYYY-MM-DD`" examples: - '2023-10-08' metricValues: type: object properties: clearanceRate: type: object description: The percentage of properties that were sold during the date range (including those sold before and after auction) out of the total number of auctions properties: value: type: number description: The clearance rate for the given date range, expressed as a percentage format: float examples: - 63.7344 changePercentage: type: number description: The difference between clearance rate for a given date range and the previous date range, expressed by percentage examples: - 10.13 observations: type: integer description: The number of properties/auctions observed to calculate the clearance rate examples: - 1205 countScheduled: type: object description: The number of properties that were scheduled for auction during the date range properties: value: type: integer description: The scheduled auction count for the given date range examples: - 62 changePercentage: type: number description: The difference between the count for a given date range and the previous date range, expressed by percentage examples: - 31.33 countSold: type: object description: The number of properties that were sold at auction during the date range properties: value: type: integer description: The sold auction count for the given date range examples: - 523 changePercentage: type: number description: The difference between the count for a given date range and the previous date range, expressed by percentage examples: - 42.37 countSoldPrior: type: object description: The number of properties that were sold prior to the scheduled auction during the date range properties: value: type: integer description: The number of properties that were sold prior to the scheduled auction during the date range examples: - 205 changePercentage: type: number description: The difference between the count for a given date range and the previous date range, expressed by percentage examples: - 62.14 countSoldAfter: type: object description: The number of properties that were sold after the scheduled auction during the date range properties: value: type: integer description: The sold after auction count for the given date range examples: - 40 changePercentage: type: number description: The difference between the count for a given date range and the previous date range, expressed by percentage examples: - -16.67 countPassedIn: type: object description: The number of properties that were passed in auction during the date range properties: value: type: integer description: The passed in auction count for the given date range examples: - 303 changePercentage: type: number description: The difference between the count for a given date range and the previous date range, expressed by percentage examples: - 3.72 countWithdrawn: type: object description: The number of properties that were withdrawn from auction during the date range properties: value: type: integer description: The withdrawn auction count for the given date range examples: - 134 changePercentage: type: number description: The difference between the count for a given date range and the previous date range, expressed by percentage examples: - 22.63 x-examples: Example 1: dateRanges: - startDate: '2023-10-02' endDate: '2023-10-08' metricValues: clearanceRate: value: 63.7344 changePercentage: 10.13 observations: 1205 countScheduled: value: 62 changePercentage: 313.33 countSold: value: 523 changePercentage: 462.37 countSoldPrior: value: 205 changePercentage: 632.14 countSoldAfter: value: 40 changePercentage: 166.67 countPassedIn: value: 303 changePercentage: 396.72 countWithdrawn: value: 134 changePercentage: 252.63 - startDate: '2023-10-09' endDate: '2023-10-15' metricValues: clearanceRate: value: 60.3704 changePercentage: -5.28 observations: 1080 countScheduled: value: 51 changePercentage: -17.74 countSold: value: 479 changePercentage: -8.41 countSoldPrior: value: 149 changePercentage: -27.32 countSoldAfter: value: 24 changePercentage: -40 countPassedIn: value: 299 changePercentage: -1.32 countWithdrawn: value: 129 changePercentage: -3.73 examples: Two Weeks of Auction Results: value: dateRanges: - startDate: '2023-10-02' endDate: '2023-10-08' metricValues: clearanceRate: value: 63.7344 changePercentage: 10.13 observations: 1205 countScheduled: value: 62 changePercentage: 313.33 countSold: value: 523 changePercentage: 462.37 countSoldPrior: value: 205 changePercentage: 632.14 countSoldAfter: value: 40 changePercentage: 166.67 countPassedIn: value: 303 changePercentage: 396.72 countWithdrawn: value: 134 changePercentage: 252.63 - startDate: '2023-10-09' endDate: '2023-10-15' metricValues: clearanceRate: value: 60.3704 changePercentage: -5.28 observations: 1080 countScheduled: value: 51 changePercentage: -17.74 countSold: value: 479 changePercentage: -8.41 countSoldPrior: value: 149 changePercentage: -27.32 countSoldAfter: value: 24 changePercentage: -40 countPassedIn: value: 299 changePercentage: -1.32 countWithdrawn: value: 129 changePercentage: -3.73 '400': description: ' > #### Bad Request (400)' 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: searchType: is a required parameter state: is a required parameter postcode: is a required parameter suburb: is a required parameter gccsaCode: is a required parameter startDate: is a required parameter endDate: is a required parameter properties: errors: type: array items: type: object properties: code: description: Defines the type of error that has occurred enum: - 7004 - 7005 - 7007 - 7008 - 7010 - 7011 - 7014 - 7015 description: type: string description: Overview of the error that has occurred example: Required parameter is missing - Please ensure that all required parameters have been included parameters: type: object description: A set of parameters that are causing the error and the rule that was invoked properties: searchType: type: string example: is a required parameter state: type: string example: must only include an allowed value postcode: type: string example: must be an integer suburb: type: string example: is a required parameter when searching by suburb gccsaCode: type: string example: is a required parameter when searching by gccsa startDate: type: string example: must be in ISO_8601 format (YYYY-MM-DD) endDate: type: string example: must be in ISO_8601 format (YYYY-MM-DD) required: - code - description examples: 7004 - Required Parameter Missing: value: errors: - code: 7004 description: Required parameter is missing - Please ensure that all required parameters have been included parameters: searchType: is a required parameter state: is a required parameter when searching by state or suburb postcode: is a required parameter when searching by suburb suburb: is a required parameter when searching by suburb gccsaCode: is a required parameter when searching by gccsa 7005 - Invalid Value Entry: value: errors: - code: 7005 description: Invalid value entry - Please ensure that all values entered are valid parameters: startDate: is not a valid date endDate: is not a valid date 7007 - Non-Allowed Value in Enum Field: value: errors: - code: 7007 description: A non-allowed value has been included into an enum field - Please ensure that the value entered is an allowed option parameters: searchType: must only include an allowed value state: must only include an allowed value 7008 - Incorrect Field Type: value: errors: - code: 7008 description: An incorrect field type has been included - Please ensure that all values are using the correct field type parameters: postcode: must be an integer 7010 - Incorrect Format: value: errors: - code: 7010 description: An incorrect format has been included - Please ensure that the correct formatting has been used for all parameters parameters: startDate: must be in ISO_8601 format (YYYY-MM-DD) endDate: must be in ISO_8601 format (YYYY-MM-DD) 7011 - Above/Below Limit: value: errors: - code: 7011 description: A value above/below the allowed limit has been included - Please ensure that a valid value has been entered parameters: postcode: must not exceed 4 digits 7014 - Invalid Date Range: value: errors: - code: 7014 description: An invalid date range has been included - Please ensure that the start and end dates are valid parameters: startDate: cannot exceed the current date endDate: cannot exceed the current date 7015 - Conflicting Date Range: value: errors: - code: 7015 description: A conflicting date range has been included - Please ensure that the start and end dates are compatible parameters: startDate: cannot be set as a date after endDate '401': description: ' > #### Unauthorized (401)' 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: description: Defines the type of error that has occurred enum: - 9012 - 9016 level: description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' deprecated: true enum: - CRITICAL description: type: string description: Overview of the error that has occurred example: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description examples: 9012 - Invalid Auth Token: value: 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 9016 - Expired Auth Token: value: errors: - code: 9016 level: CRITICAL description: Authentication token has expired - Please ensure that a valid token authentication request has been completed before trying again '403': description: ' > #### Forbidden (403)' 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: 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 examples: 9003 - Access Denied: value: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint '404': description: ' > #### Not Found (404)' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 7002 level: CRITICAL description: Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct properties: errors: type: array items: type: object properties: code: enum: - 7002 description: Defines the type of error that has occurred description: type: string example: Unknown identifier, the included location does not match a record within our system - Please ensure that the identifier is correct description: Overview of the error that has occurred parameters: type: object x-stoplight: id: fwibzr5ow9gcz description: A set of parameters that are causing the error and the rule that was invoked properties: gccsa: type: string x-stoplight: id: qs3j3puelq6dc example: cannot be found suburb: type: string x-stoplight: id: ujm1ijk0s1qj4 example: cannot be found required: - code - description examples: 7002 - Unknown Identifier: value: errors: - code: 7002 description: Unknown identifier, the included location does not match a record within our system - Please ensure that the identifier is correct parameters: suburb: cannot be found '429': description: ' > #### Too Many Requests (429)' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL 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 level: 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 example: Rate limit has been exceeded - Please try again shortly description: Overview of the error that has occurred required: - code - description examples: 9011- Rate Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly 9011 - Quota Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Quota limit has been reached - Please contact our customer support team at support@proptrack.com for further information '500': description: ' > #### Internal Server Error (500)' servers: - url: https://data.proptrack.com x-stoplight: id: df1d5fvuid3k9 /api/v2/market/rent/historic/{metric}: get: tags: - Rent History summary: /api/v2/market/rent/historic/{metric} description: Retrieves historic rental transaction statistics for a given suburb. operationId: market.rent-history 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: propertyTypes in: query description: 'The type of properties that will be queried against
Note: Values are comma separated' required: true schema: enum: - house - unit examples: - house,unit type: array - name: frequency in: query description: Reporting frequency
`monthly` frequency is applicable for `rental-transaction-volume`, `median-days-on-market` and `median-rental-price` metrics only schema: enum: - yearly - monthly default: yearly examples: - yearly type: string - name: state in: query description: State or territory within Australia required: true schema: enum: - act - nsw - nt - qld - sa - tas - vic - wa examples: - nsw type: string - name: postcode in: query description: Four digit postcode required: true schema: type: integer examples: - 2000 - name: suburb in: query description: Suburb name required: true schema: type: string examples: - Sydney - name: startDate in: query description: Start of date range to be queried. Defaulted to 12 months prior to today's date if left empty
Applicable for `rental-transaction-volume` and `median-rental-price` metrics only
Format `YYYY-MM-DD` schema: type: string format: date examples: - '2022-07-01' - name: endDate in: query description: End of date range to be queried. Defaulted to today's date if left empty
Applicable for `rental-transaction-volume` and `median-rental-price` metrics only
Format `YYYY-MM-DD` schema: type: string format: date examples: - '2022-09-01' - name: metric in: path description: Property market metric. Refer to [Market Metrics](https://developer.proptrack.com.au/docs/apis/guide#market-metrics) for more information. required: true schema: enum: - median-rental-yield - rental-transaction-volume - median-rental-price - median-days-on-market examples: - median-rental-yield responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: array items: type: object properties: propertyType: enum: - house - unit description: Type of property dateRanges: type: array description: Time period which the metric is expressed across items: type: object properties: startDate: type: string description: First date in the date range
Format `YYYY-MM-DD` format: date examples: - '2021-10-01' endDate: type: string description: Last date in the date range
Format `YYYY-MM-DD` format: date examples: - '2022-09-30' metricValues: type: array items: type: object properties: bedrooms: enum: - '0' - '1' - '2' - '3' - '4' - 4+ - 5+ - combined description: Number of bedrooms that the metric is expressed by examples: - '3' value: type: number description: Data for the chosen corresponding metric format: float examples: - 1.305889 x-examples: Example 1: - propertyType: house dateRanges: - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 10 - bedrooms: '2' value: 11 - bedrooms: '3' value: 18 - bedrooms: '4' value: 24 - bedrooms: 5+ value: 14 - propertyType: unit dateRanges: - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 14 - bedrooms: '2' value: 14 - bedrooms: '3' value: 16 - bedrooms: 4+ value: 16 examples: Median Days on Site (yearly): value: - propertyType: house dateRanges: - startDate: '2020-01-01' endDate: '2020-12-31' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 21 - bedrooms: '3' value: 25 - bedrooms: '4' value: 20 - bedrooms: combined value: 22 Rental Transaction Volume (Monthly): value: - propertyType: house dateRanges: - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - startDate: '2020-11-01' endDate: '2021-10-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 16 - bedrooms: '3' value: 15 - bedrooms: '4' value: 11 - bedrooms: 5+ value: 12 - startDate: '2020-12-01' endDate: '2021-11-30' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 18 - bedrooms: '3' value: 19 - bedrooms: '4' value: 22 - bedrooms: 5+ value: 11 - startDate: '2021-01-01' endDate: '2021-12-31' metricValues: - bedrooms: '1' value: 22 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 27 - bedrooms: 5+ value: 23 - startDate: '2021-02-01' endDate: '2022-01-31' metricValues: - bedrooms: '1' value: 14 - bedrooms: '2' value: 15 - bedrooms: '3' value: 18 - bedrooms: '4' value: 19 - bedrooms: 5+ value: 12 - startDate: '2021-03-01' endDate: '2022-02-28' metricValues: - bedrooms: '1' value: 9 - bedrooms: '2' value: 14 - bedrooms: '3' value: 16 - bedrooms: '4' value: 16 - bedrooms: 5+ value: 19 - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 19 - bedrooms: '3' value: 32 - bedrooms: '4' value: 113 - bedrooms: 5+ value: 86 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '1' value: 29 - bedrooms: '2' value: 27 - bedrooms: '3' value: 36 - bedrooms: '4' value: 23 - bedrooms: 5+ value: 44 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '1' value: 31 - bedrooms: '2' value: 23 - bedrooms: '3' value: 23 - bedrooms: '4' value: 48 - bedrooms: 5+ value: 39 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 15 - bedrooms: '3' value: 36 - bedrooms: '4' value: 23 - bedrooms: 5+ value: 44 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '1' value: 28 - bedrooms: '2' value: 24 - bedrooms: '3' value: 55 - bedrooms: '4' value: 93 - bedrooms: 5+ value: 106 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 1 - bedrooms: '2' value: 5 - bedrooms: '3' value: 15 - bedrooms: '4' value: 115 - bedrooms: 5+ value: 102 - propertyType: unit dateRanges: - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 15 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2020-11-01' endDate: '2021-10-31' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 - startDate: '2020-12-01' endDate: '2021-11-30' metricValues: - bedrooms: '0' value: 23 - bedrooms: '1' value: 33 - bedrooms: '2' value: 108 - bedrooms: '3' value: 92 - bedrooms: 4+ value: 16 - startDate: '2021-01-01' endDate: '2021-12-31' metricValues: - bedrooms: '0' value: 17 - bedrooms: '1' value: 51 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2021-02-01' endDate: '2022-01-31' metricValues: - bedrooms: '0' value: 8 - bedrooms: '1' value: 13 - bedrooms: '2' value: 102 - bedrooms: '3' value: 88 - bedrooms: 4+ value: 91 - startDate: '2021-03-01' endDate: '2022-02-28' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 101 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '0' value: 17 - bedrooms: '1' value: 14 - bedrooms: '2' value: 105 - bedrooms: '3' value: 87 - bedrooms: 4+ value: 90 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 15 - bedrooms: '2' value: 66 - bedrooms: '3' value: 90 - bedrooms: 4+ value: 75 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 15 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 Rental Transaction Volume (Yearly): value: - propertyType: house dateRanges: - startDate: '2016-09-01' endDate: '2017-08-31' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - startDate: '2017-09-01' endDate: '2018-08-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 19 - bedrooms: '3' value: 32 - bedrooms: '4' value: 113 - bedrooms: 5+ value: 86 - startDate: '2018-09-01' endDate: '2019-08-31' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - startDate: '2019-09-01' endDate: '2020-08-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 19 - bedrooms: '3' value: 32 - bedrooms: '4' value: 113 - bedrooms: 5+ value: 86 - startDate: '2020-09-01' endDate: '2021-08-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 34 - bedrooms: '3' value: 56 - bedrooms: '4' value: 15 - bedrooms: 5+ value: 92 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - propertyType: unit dateRanges: - startDate: '2016-09-01' endDate: '2017-08-31' metricValues: - bedrooms: '0' value: 5 - bedrooms: '1' value: 19 - bedrooms: '2' value: 22 - bedrooms: '3' value: 87 - bedrooms: 4+ value: 43 - startDate: '2017-09-01' endDate: '2018-08-31' metricValues: - bedrooms: '0' value: 12 - bedrooms: '1' value: 77 - bedrooms: '2' value: 63 - bedrooms: '3' value: 66 - bedrooms: 4+ value: 104 - startDate: '2018-09-01' endDate: '2019-08-31' metricValues: - bedrooms: '0' value: 24 - bedrooms: '1' value: 87 - bedrooms: '2' value: 33 - bedrooms: '3' value: 67 - bedrooms: 4+ value: 83 - startDate: '2019-09-01' endDate: '2020-08-31' metricValues: - bedrooms: '0' value: 13 - bedrooms: '1' value: 31 - bedrooms: '2' value: 36 - bedrooms: '3' value: 44 - bedrooms: 4+ value: 92 - startDate: '2020-09-01' endDate: '2021-08-31' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 15 - bedrooms: '2' value: 23 - bedrooms: '3' value: 46 - bedrooms: 4+ value: 59 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' value: 31 - bedrooms: '1' value: 93 - bedrooms: '2' value: 82 - bedrooms: '3' value: 19 - bedrooms: 4+ value: 23 Median Rental Yield: value: - propertyType: house dateRanges: - startDate: '2024-11-01' endDate: '2024-11-30' metricValues: - bedrooms: '1' value: 0.0158 - bedrooms: '2' value: 0.0228 - bedrooms: '3' value: 0.0238 - bedrooms: '4' value: 0.0261 - bedrooms: 5+ value: 0.0249 - bedrooms: combined value: 0.0253 - propertyType: unit dateRanges: - startDate: '2024-11-01' endDate: '2024-11-30' metricValues: - bedrooms: '1' value: 0.0469 - bedrooms: '2' value: 0.044 - bedrooms: '3' value: 0.0408 - bedrooms: 4+ value: 0.0474 - bedrooms: combined value: 0.0432 Median Rental Price (Monthly): value: - propertyType: house dateRanges: - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '1' value: 568 - bedrooms: '2' value: 720 - bedrooms: '3' value: 760 - bedrooms: '4' value: 900 - bedrooms: 5+ value: 1090 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '1' value: 538 - bedrooms: '2' value: 602 - bedrooms: '3' value: 750 - bedrooms: '4' value: 850 - bedrooms: 5+ value: 1090 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '1' value: 605 - bedrooms: '2' value: 660 - bedrooms: '3' value: 820 - bedrooms: '4' value: 890 - bedrooms: 5+ value: 1080 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '1' value: 590 - bedrooms: '2' value: 690 - bedrooms: '3' value: 800 - bedrooms: '4' value: 900 - bedrooms: 5+ value: 1155 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '1' value: 620 - bedrooms: '2' value: 705 - bedrooms: '3' value: 790 - bedrooms: '4' value: 905 - bedrooms: 5+ value: 1130 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 595 - bedrooms: '2' value: 730 - bedrooms: '3' value: 805 - bedrooms: '4' value: 885 - bedrooms: 5+ value: 1200 - propertyType: unit dateRanges: - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '0' value: 310 - bedrooms: '1' value: 400 - bedrooms: '2' value: 540 - bedrooms: '3' value: 405 - bedrooms: 4+ value: 632 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '0' value: 315 - bedrooms: '1' value: 390 - bedrooms: '2' value: 540 - bedrooms: '3' value: 410 - bedrooms: 4+ value: 605 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '0' value: 325 - bedrooms: '1' value: 410 - bedrooms: '2' value: 555 - bedrooms: '3' value: 410 - bedrooms: 4+ value: 619 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '0' value: 350 - bedrooms: '1' value: 405 - bedrooms: '2' value: 520 - bedrooms: '3' value: 420 - bedrooms: 4+ value: 605 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '0' value: 295 - bedrooms: '1' value: 415 - bedrooms: '2' value: 530 - bedrooms: '3' value: 430 - bedrooms: 4+ value: 620 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' value: 305 - bedrooms: '1' value: 410 - bedrooms: '2' value: 525 - bedrooms: '3' value: 450 - bedrooms: 4+ value: 620 Median Rental Price (Yearly): value: - propertyType: house dateRanges: - startDate: '2017-10-01' endDate: '2018-09-30' metricValues: - bedrooms: '1' value: 340 - bedrooms: '2' value: 397 - bedrooms: '3' value: 575 - bedrooms: '4' value: 870 - bedrooms: 5+ value: 1225 - startDate: '2018-10-01' endDate: '2019-09-30' metricValues: - bedrooms: '1' value: 319 - bedrooms: '2' value: 399 - bedrooms: '3' value: 620 - bedrooms: '4' value: 995 - bedrooms: 5+ value: 1075 - startDate: '2019-10-01' endDate: '2020-09-30' metricValues: - bedrooms: '1' value: 380 - bedrooms: '2' value: 475 - bedrooms: '3' value: 650 - bedrooms: '4' value: 950 - bedrooms: 5+ value: 1140 - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '1' value: 388 - bedrooms: '2' value: 465 - bedrooms: '3' value: 675 - bedrooms: '4' value: 950 - bedrooms: 5+ value: 1300 - propertyType: unit dateRanges: - startDate: '2017-10-01' endDate: '2018-09-30' metricValues: - bedrooms: '0' value: 266 - bedrooms: '1' value: 280 - bedrooms: '2' value: 370 - bedrooms: '3' value: 537.5 - bedrooms: 4+ value: 806.5 - startDate: '2018-10-01' endDate: '2019-09-30' metricValues: - bedrooms: '0' value: 255 - bedrooms: '1' value: 290 - bedrooms: '2' value: 380 - bedrooms: '3' value: 550 - bedrooms: 4+ value: 813 - startDate: '2019-10-01' endDate: '2020-09-30' metricValues: - bedrooms: '0' value: 293 - bedrooms: '1' value: 300 - bedrooms: '2' value: 390 - bedrooms: '3' value: 542.5 - bedrooms: 4+ value: 819 - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '1' value: 287 - bedrooms: '1' value: 295 - bedrooms: '2' value: 400 - bedrooms: '3' value: 595 - bedrooms: 4+ value: 826 No Market Data Available: value: [] Median Days on Site (monthly): value: - propertyType: house dateRanges: - startDate: '2019-03-01' endDate: '2020-02-29' metricValues: - bedrooms: '1' value: 11 - bedrooms: '2' value: 16 - bedrooms: '3' value: 23 - bedrooms: '4' value: 27 - bedrooms: 5+ value: 20 - bedrooms: combined value: 21 - startDate: '2019-04-01' endDate: '2020-03-31' metricValues: - bedrooms: '1' value: 12 - bedrooms: '2' value: 16 - bedrooms: '3' value: 25 - bedrooms: '4' value: 22 - bedrooms: 5+ value: 20 - bedrooms: combined value: 22 - startDate: '2019-05-01' endDate: '2020-04-30' metricValues: - bedrooms: '1' value: 10 - bedrooms: '2' value: 17 - bedrooms: '3' value: 24 - bedrooms: '4' value: 22 - bedrooms: combined value: 23 - startDate: '2019-06-01' endDate: '2020-05-31' metricValues: - bedrooms: '1' value: 10 - bedrooms: '2' value: 17 - bedrooms: '3' value: 26 - bedrooms: '4' value: 21 - bedrooms: combined value: 23 - startDate: '2019-07-01' endDate: '2020-06-30' metricValues: - bedrooms: '1' value: 10 - bedrooms: '2' value: 25 - bedrooms: '3' value: 31 - bedrooms: '4' value: 22 - bedrooms: combined value: 24 - startDate: '2019-08-01' endDate: '2020-07-31' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 24 - bedrooms: '3' value: 28 - bedrooms: '4' value: 22 - bedrooms: combined value: 22 - startDate: '2019-09-01' endDate: '2020-08-31' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 22 - bedrooms: '3' value: 25 - bedrooms: '4' value: 22 - bedrooms: combined value: 23 - startDate: '2019-10-01' endDate: '2020-09-30' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 24 - bedrooms: '3' value: 28 - bedrooms: '4' value: 22 - bedrooms: combined value: 25 - startDate: '2019-11-01' endDate: '2020-10-31' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 22 - bedrooms: '3' value: 25 - bedrooms: '4' value: 22 - bedrooms: combined value: 22 - startDate: '2019-12-01' endDate: '2020-11-30' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 22 - bedrooms: '3' value: 25 - bedrooms: '4' value: 22 - bedrooms: combined value: 22 - startDate: '2020-01-01' endDate: '2020-12-31' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 21 - bedrooms: '3' value: 25 - bedrooms: '4' value: 20 - bedrooms: combined value: 22 - startDate: '2020-02-01' endDate: '2021-01-31' metricValues: - bedrooms: '1' value: 18 - bedrooms: '2' value: 21 - bedrooms: '3' value: 25 - bedrooms: '4' value: 18 - bedrooms: combined value: 22 headers: Content-Type: schema: const: application/json 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#marketrent-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: enum: - 7004 - 7005 - 7007 - 7008 - 7009 - 7010 - 7011 - 7014 - 7015 description: Defines the type of error that has occurred examples: - 7004 level: const: 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 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: A set of parameters that are causing the error and the rule that was invoked properties: metric: type: string examples: - is a required parameter state: type: string examples: - is a required parameter postcode: type: string examples: - is a required parameter suburb: type: string examples: - is a required parameter propertyTypes: type: string examples: - is a required parameter frequency: type: string examples: - must only include one value startDate: type: string examples: - must be in ISO_8601 format (YYYY-MM-DD) endDate: type: string examples: - must be in ISO_8601 format (YYYY-MM-DD) examples: 7004 - Required Parameter Missing: value: errors: - code: 7004 level: CRITICAL description: Required parameter is missing - Please ensure that all required parameters have been included parameters: propertyTypes: is a required parameter state: is a required parameter postcode: is a required parameter suburb: is a required parameter metric: is a required parameter 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#marketrent-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred examples: - 9012 level: const: 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 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 x-examples: Example 1: errors: - code: '7004' level: string description: string examples: 9012 - Authentication Error: value: 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 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#marketrent-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred examples: - Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description 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 '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#marketrent-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 7002 description: Defines the type of error that has occurred examples: - 7002 level: const: 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 description: type: string description: Overview of the error that has occurred examples: - Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct x-examples: Example 1: errors: - code: '7004' level: string description: string examples: 7002 - No Data Found: value: errors: - code: 7002 level: CRITICAL description: Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct 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#marketrent-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 9011 description: Defines the type of error that has occurred examples: - 9011 level: const: 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 description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly x-examples: Example 1: errors: - code: '7004' level: string description: string examples: 9011 - Rate Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly 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#marketrent-history) for information on error handling.' servers: - url: https://data.proptrack.com x-stoplight: id: kqbq6xu33khde /api/v2/market/sale/historic/{metric}: get: tags: - Sale History summary: /api/v2/market/sale/historic/{metric} description: "Retrieves historic sale transaction statistics for a given suburb.\r\n\r\n#### Data\ \ Attribution Notice:\r\nThis endpoint contains State and Territory data which may be subject\ \ to approval by the relevant government department.\r\nDue to licensing agreement requirements,\ \ it is necessary to include data disclaimers and PropTrack branding when displaying this data\ \ in a user experience or printable output.\r\n

\r\nDisclaimer Types: `vg`,`serviceAgent`\r\ \n\r\nPlease refer to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience.\r\n" operationId: market.sale-history 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: propertyTypes in: query description: 'The type of properties that will be queried against
Note: Values are comma separated' required: true schema: enum: - house - unit examples: - house,unit type: array - name: frequency in: query description: Reporting frequency
Returns the monthly or yearly calculated metrics schema: enum: - yearly - monthly default: yearly examples: - yearly type: string - name: state in: query description: State or territory within Australia required: true schema: enum: - act - nsw - nt - qld - sa - tas - vic - wa examples: - nsw type: string - name: postcode in: query description: Four digit postcode required: true schema: type: integer examples: - 2000 - name: suburb in: query description: Suburb name required: true schema: type: string examples: - Sydney - name: startDate in: query description: Start of date range to be queried. Defaulted to 12 months prior to today's date if left empty
Applicable for `sale-transaction-volume` and `median-sale-price` metrics only
Format `YYYY-MM-DD` schema: type: string format: date examples: - '2022-07-01' - name: endDate in: query description: End of date range to be queried. Defaulted to today's date if left empty
Applicable for `sale-transaction-volume` and `median-sale-price` metrics only
Format `YYYY-MM-DD` schema: type: string format: date examples: - '2022-09-01' - name: metric in: path description: Property market metric. Refer to [Market Metrics](https://developer.proptrack.com.au/docs/apis/guide#market-metrics) for more information. required: true schema: enum: - sale-transaction-volume - median-sale-price - median-days-on-market examples: - median-sale-price responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: array items: type: object properties: propertyType: enum: - house - unit description: Type of property dateRanges: type: array description: Time period which the metric is expressed across items: type: object properties: startDate: type: string description: First date in the date range
Format `YYYY-MM-DD` format: date examples: - '2021-10-01' endDate: type: string description: Last date in the date range
Format `YYYY-MM-DD` format: date examples: - '2022-09-30' metricValues: type: array items: type: object properties: bedrooms: enum: - '0' - '1' - '2' - '3' - '4' - 4+ - 5+ - combined description: Number of bedrooms that the metric is expressed by examples: - '3' value: type: number description: Data for the chosen corresponding metric format: float examples: - 1.305889 x-examples: Example 1: - propertyType: house dateRanges: - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 10 - bedrooms: '2' value: 11 - bedrooms: '3' value: 18 - bedrooms: '4' value: 24 - bedrooms: 5+ value: 14 - propertyType: unit dateRanges: - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 14 - bedrooms: '2' value: 14 - bedrooms: '3' value: 16 - bedrooms: 4+ value: 16 examples: Median Days on Site: value: - propertyType: house dateRanges: - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 10 - bedrooms: '2' value: 11 - bedrooms: '3' value: 18 - bedrooms: '4' value: 24 - bedrooms: 5+ value: 14 - propertyType: unit dateRanges: - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 14 - bedrooms: '2' value: 14 - bedrooms: '3' value: 16 - bedrooms: 4+ value: 16 Sale Transaction Volume (Monthly): value: - propertyType: house dateRanges: - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - startDate: '2020-11-01' endDate: '2021-10-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 16 - bedrooms: '3' value: 15 - bedrooms: '4' value: 11 - bedrooms: 5+ value: 12 - startDate: '2020-12-01' endDate: '2021-11-30' metricValues: - bedrooms: '1' value: 13 - bedrooms: '2' value: 18 - bedrooms: '3' value: 19 - bedrooms: '4' value: 22 - bedrooms: 5+ value: 11 - startDate: '2021-01-01' endDate: '2021-12-31' metricValues: - bedrooms: '1' value: 22 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 27 - bedrooms: 5+ value: 23 - startDate: '2021-02-01' endDate: '2022-01-31' metricValues: - bedrooms: '1' value: 14 - bedrooms: '2' value: 15 - bedrooms: '3' value: 18 - bedrooms: '4' value: 19 - bedrooms: 5+ value: 12 - startDate: '2021-03-01' endDate: '2022-02-28' metricValues: - bedrooms: '1' value: 9 - bedrooms: '2' value: 14 - bedrooms: '3' value: 16 - bedrooms: '4' value: 16 - bedrooms: 5+ value: 19 - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 19 - bedrooms: '3' value: 32 - bedrooms: '4' value: 113 - bedrooms: 5+ value: 86 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '1' value: 29 - bedrooms: '2' value: 27 - bedrooms: '3' value: 36 - bedrooms: '4' value: 23 - bedrooms: 5+ value: 44 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '1' value: 31 - bedrooms: '2' value: 23 - bedrooms: '3' value: 23 - bedrooms: '4' value: 48 - bedrooms: 5+ value: 39 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 15 - bedrooms: '3' value: 36 - bedrooms: '4' value: 23 - bedrooms: 5+ value: 44 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '1' value: 28 - bedrooms: '2' value: 24 - bedrooms: '3' value: 55 - bedrooms: '4' value: 93 - bedrooms: 5+ value: 106 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 1 - bedrooms: '2' value: 5 - bedrooms: '3' value: 15 - bedrooms: '4' value: 115 - bedrooms: 5+ value: 102 - propertyType: unit dateRanges: - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 15 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2020-11-01' endDate: '2021-10-31' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 - startDate: '2020-12-01' endDate: '2021-11-30' metricValues: - bedrooms: '0' value: 23 - bedrooms: '1' value: 33 - bedrooms: '2' value: 108 - bedrooms: '3' value: 92 - bedrooms: 4+ value: 16 - startDate: '2021-01-01' endDate: '2021-12-31' metricValues: - bedrooms: '0' value: 17 - bedrooms: '1' value: 51 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2021-02-01' endDate: '2022-01-31' metricValues: - bedrooms: '0' value: 8 - bedrooms: '1' value: 13 - bedrooms: '2' value: 102 - bedrooms: '3' value: 88 - bedrooms: 4+ value: 91 - startDate: '2021-03-01' endDate: '2022-02-28' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 101 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '0' value: 17 - bedrooms: '1' value: 14 - bedrooms: '2' value: 105 - bedrooms: '3' value: 87 - bedrooms: 4+ value: 90 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 15 - bedrooms: '2' value: 66 - bedrooms: '3' value: 90 - bedrooms: 4+ value: 75 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 15 - bedrooms: '2' value: 36 - bedrooms: '3' value: 23 - bedrooms: 4+ value: 44 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' value: 22 - bedrooms: '1' value: 19 - bedrooms: '2' value: 66 - bedrooms: '3' value: 73 - bedrooms: 4+ value: 75 Sale Transaction Volume (Yearly): value: - propertyType: house dateRanges: - startDate: '2016-09-01' endDate: '2017-08-31' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - startDate: '2017-09-01' endDate: '2018-08-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 19 - bedrooms: '3' value: 32 - bedrooms: '4' value: 113 - bedrooms: 5+ value: 86 - startDate: '2018-09-01' endDate: '2019-08-31' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - startDate: '2019-09-01' endDate: '2020-08-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 19 - bedrooms: '3' value: 32 - bedrooms: '4' value: 113 - bedrooms: 5+ value: 86 - startDate: '2020-09-01' endDate: '2021-08-31' metricValues: - bedrooms: '1' value: 19 - bedrooms: '2' value: 34 - bedrooms: '3' value: 56 - bedrooms: '4' value: 15 - bedrooms: 5+ value: 92 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 15 - bedrooms: '2' value: 13 - bedrooms: '3' value: 22 - bedrooms: '4' value: 26 - bedrooms: 5+ value: 8 - propertyType: unit dateRanges: - startDate: '2016-09-01' endDate: '2017-08-31' metricValues: - bedrooms: '0' value: 5 - bedrooms: '1' value: 19 - bedrooms: '2' value: 22 - bedrooms: '3' value: 87 - bedrooms: 4+ value: 43 - startDate: '2017-09-01' endDate: '2018-08-31' metricValues: - bedrooms: '0' value: 12 - bedrooms: '1' value: 77 - bedrooms: '2' value: 63 - bedrooms: '3' value: 66 - bedrooms: 4+ value: 104 - startDate: '2018-09-01' endDate: '2019-08-31' metricValues: - bedrooms: '0' value: 24 - bedrooms: '1' value: 87 - bedrooms: '2' value: 33 - bedrooms: '3' value: 67 - bedrooms: 4+ value: 83 - startDate: '2019-09-01' endDate: '2020-08-31' metricValues: - bedrooms: '0' value: 13 - bedrooms: '1' value: 31 - bedrooms: '2' value: 36 - bedrooms: '3' value: 44 - bedrooms: 4+ value: 92 - startDate: '2020-09-01' endDate: '2021-08-31' metricValues: - bedrooms: '0' value: 15 - bedrooms: '1' value: 15 - bedrooms: '2' value: 23 - bedrooms: '3' value: 46 - bedrooms: 4+ value: 59 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' value: 31 - bedrooms: '1' value: 93 - bedrooms: '2' value: 82 - bedrooms: '3' value: 19 - bedrooms: 4+ value: 23 Median Sale Price (Monthly): value: - propertyType: house dateRanges: - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '1' value: 568000 - bedrooms: '2' value: 720000 - bedrooms: '3' value: 760000 - bedrooms: '4' value: 900000 - bedrooms: 5+ value: 1090000 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '1' value: 538000 - bedrooms: '2' value: 602000 - bedrooms: '3' value: 750000 - bedrooms: '4' value: 850000 - bedrooms: 5+ value: 1090000 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '1' value: 605000 - bedrooms: '2' value: 660000 - bedrooms: '3' value: 820000 - bedrooms: '4' value: 890000 - bedrooms: 5+ value: 1080000 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '1' value: 590000 - bedrooms: '2' value: 690000 - bedrooms: '3' value: 800000 - bedrooms: '4' value: 900000 - bedrooms: 5+ value: 1155000 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '1' value: 620000 - bedrooms: '2' value: 705000 - bedrooms: '3' value: 790000 - bedrooms: '4' value: 905000 - bedrooms: 5+ value: 1130000 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' value: 595000 - bedrooms: '2' value: 730000 - bedrooms: '3' value: 805000 - bedrooms: '4' value: 885000 - bedrooms: 5+ value: 1200000 - propertyType: unit dateRanges: - startDate: '2021-04-01' endDate: '2022-03-31' metricValues: - bedrooms: '0' value: 310000 - bedrooms: '1' value: 400000 - bedrooms: '2' value: 540000 - bedrooms: '3' value: 405000 - bedrooms: 4+ value: 632000 - startDate: '2021-05-01' endDate: '2022-04-30' metricValues: - bedrooms: '0' value: 315000 - bedrooms: '1' value: 390000 - bedrooms: '2' value: 540000 - bedrooms: '3' value: 410000 - bedrooms: 4+ value: 605000 - startDate: '2021-06-01' endDate: '2022-05-31' metricValues: - bedrooms: '0' value: 325000 - bedrooms: '1' value: 410000 - bedrooms: '2' value: 555000 - bedrooms: '3' value: 410000 - bedrooms: 4+ value: 619000 - startDate: '2021-07-01' endDate: '2022-06-30' metricValues: - bedrooms: '0' value: 350000 - bedrooms: '1' value: 405000 - bedrooms: '2' value: 520000 - bedrooms: '3' value: 420000 - bedrooms: 4+ value: 605000 - startDate: '2021-08-01' endDate: '2022-07-31' metricValues: - bedrooms: '0' value: 295000 - bedrooms: '1' value: 415000 - bedrooms: '2' value: 530000 - bedrooms: '3' value: 430000 - bedrooms: 4+ value: 620000 - startDate: '2021-09-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' value: 305000 - bedrooms: '1' value: 410000 - bedrooms: '2' value: 525000 - bedrooms: '3' value: 450000 - bedrooms: 4+ value: 620000 Median Sale Price (Yearly): value: - propertyType: house dateRanges: - startDate: '2017-10-01' endDate: '2018-09-30' metricValues: - bedrooms: '1' value: 340000 - bedrooms: '2' value: 397000 - bedrooms: '3' value: 575000 - bedrooms: '4' value: 870000 - bedrooms: 5+ value: 1225000 - startDate: '2018-10-01' endDate: '2019-09-30' metricValues: - bedrooms: '1' value: 319000 - bedrooms: '2' value: 399000 - bedrooms: '3' value: 620000 - bedrooms: '4' value: 995000 - bedrooms: 5+ value: 1075000 - startDate: '2019-10-01' endDate: '2020-09-30' metricValues: - bedrooms: '1' value: 380000 - bedrooms: '2' value: 475000 - bedrooms: '3' value: 650000 - bedrooms: '4' value: 950000 - bedrooms: 5+ value: 1140000 - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '1' value: 388000 - bedrooms: '2' value: 465000 - bedrooms: '3' value: 675000 - bedrooms: '4' value: 950000 - bedrooms: 5+ value: 1300000 - propertyType: unit dateRanges: - startDate: '2017-10-01' endDate: '2018-09-30' metricValues: - bedrooms: '0' value: 266000 - bedrooms: '1' value: 280000 - bedrooms: '2' value: 370000 - bedrooms: '3' value: 537500 - bedrooms: 4+ value: 806500 - startDate: '2018-10-01' endDate: '2019-09-30' metricValues: - bedrooms: '0' value: 255000 - bedrooms: '1' value: 290000 - bedrooms: '2' value: 380000 - bedrooms: '3' value: 550000 - bedrooms: 4+ value: 813000 - startDate: '2019-10-01' endDate: '2020-09-30' metricValues: - bedrooms: '0' value: 293000 - bedrooms: '1' value: 300000 - bedrooms: '2' value: 390000 - bedrooms: '3' value: 542500 - bedrooms: 4+ value: 819000 - startDate: '2020-10-01' endDate: '2021-09-30' metricValues: - bedrooms: '1' value: 287000 - bedrooms: '1' value: 295000 - bedrooms: '2' value: 400000 - bedrooms: '3' value: 595000 - bedrooms: 4+ value: 826000 headers: Content-Type: schema: const: application/json 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#marketsale-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: enum: - 7004 - 7005 - 7007 - 7008 - 7009 - 7010 - 7011 - 7014 - 7015 description: Defines the type of error that has occurred examples: - 7004 level: const: 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 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: A set of parameters that are causing the error and the rule that was invoked properties: metric: type: string examples: - is a required parameter state: type: string examples: - is a required parameter postcode: type: string examples: - is a required parameter suburb: type: string examples: - is a required parameter propertyTypes: type: string examples: - is a required parameter frequency: type: string examples: - must only include one value startDate: type: string examples: - must be in ISO_8601 format (YYYY-MM-DD) endDate: type: string examples: - must be in ISO_8601 format (YYYY-MM-DD) required: - code - description x-examples: Example 1: errors: - code: '7004' level: string description: string parameters: metric: string state: string postcode: string suburb: string propertyTypes: string frequency: string startDate: string endDate: string examples: 7004 - Required Parameter Missing: value: errors: - code: 7004 level: CRITICAL description: Required parameter is missing - Please ensure that all required parameters have been included parameters: propertyTypes: is a required parameter state: is a required parameter postcode: is a required parameter suburb: is a required parameter metric: is a required parameter 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#marketsale-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred examples: - 9012 level: const: 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 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 x-examples: Example 1: errors: - code: '7004' level: string description: string examples: 9012 - Authentication Error: value: 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 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#marketsale-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred examples: - Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description 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 '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#marketsale-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 7002 description: Defines the type of error that has occurred examples: - 7002 level: const: 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 description: type: string description: Overview of the error that has occurred examples: - Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct required: - code - description x-examples: Example 1: errors: - code: string level: string description: string examples: 7002 - No Data Found: value: errors: - code: 7002 level: CRITICAL description: Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct 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#marketsale-history) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 9011 description: Defines the type of error that has occurred examples: - 9011 level: const: 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 description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly required: - code - description x-examples: Example 1: errors: - code: string level: string description: string examples: 9011 - Rate Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly 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#marketsale-history) for information on error handling.' servers: - url: https://data.proptrack.com x-stoplight: id: 7qgcnnd7tsay1 /api/v2/market/supply-and-demand/{metric}: get: tags: - Supply & Demand summary: /api/v2/market/supply-and-demand/{metric} description: Retrieves property supply and consumer demand statistics for a given suburb. operationId: market.supply-and-demand 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: state in: query description: State or territory within Australia required: true schema: enum: - act - nsw - nt - qld - sa - tas - vic - wa examples: - nsw type: string - name: postcode in: query description: Four digit postcode required: true schema: type: integer examples: - 2000 - name: suburb in: query description: Suburb name required: true schema: type: string examples: - Sydney - name: startDate in: query description: Start of date range to be queried. Defaulted to 12 months prior to today's date if left empty
Format `YYYY-MM-DD` schema: type: string format: date examples: - '2022-08-01' - name: endDate in: query description: End of date range to be queried. Defaulted to today's date if left empty
Format `YYYY-MM-DD` schema: type: string format: date examples: - '2022-09-30' - name: propertyTypes in: query description: 'The type of properties that will be queried against
Note: Values are comma separated' required: true schema: enum: - house - unit examples: - house,unit type: array - name: frequency in: query description: Reporting frequency schema: enum: - monthly - weekly default: monthly examples: - monthly type: string - name: metric in: path description: Property market metric. Refer to [Market Metrics](https://developer.proptrack.com.au/docs/apis/guide#market-metrics) for more information. required: true schema: enum: - potential-buyers - potential-renters examples: - potential-buyers responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: array x-examples: Example 1: - propertyType: house dateRanges: - startDate: '2022-09-01' endDate: '2022-09-30' metricValues: - bedrooms: '1' supply: 22 demand: 921 supplyChangePercentage: 24.1379310344 demandChangePercentage: 2.12539851222 - bedrooms: '2' supply: 28 demand: 1044 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '4' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 5+ supply: 19 demand: 883 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - startDate: '2022-08-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' supply: 22 demand: 1002 supplyChangePercentage: 0 demandChangePercentage: 8.794788273615636 - bedrooms: '2' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '4' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 5+ supply: 13 demand: 998 supplyChangePercentage: -31.57894736842105 demandChangePercentage: 13.023782559456398 - propertyType: unit dateRanges: - startDate: '2022-09-01' endDate: '2022-09-30' metricValues: - bedrooms: '1' supply: 22 demand: 921 supplyChangePercentage: 24.1379310344 demandChangePercentage: 2.12539851222 - bedrooms: '2' supply: 28 demand: 1044 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '4' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 5+ supply: 19 demand: 883 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - startDate: '2022-08-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' supply: 22 demand: 1002 supplyChangePercentage: 0 demandChangePercentage: 8.794788273615636 - bedrooms: '2' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '4' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 5+ supply: 13 demand: 998 supplyChangePercentage: -31.57894736842105 demandChangePercentage: 13.023782559456398 items: type: object properties: propertyType: enum: - house - unit description: Type of property examples: - house dateRanges: type: array description: Time period which the metric is expressed across items: type: object properties: startDate: type: string description: First date in the date range
Format `YYYY-MM-DD` format: date examples: - '2022-08-01' endDate: type: string description: Last date in the date range
Format `YYYY-MM-DD` format: date examples: - '2022-08-31' metricValues: type: array items: type: object properties: bedrooms: enum: - '0' - '1' - '2' - '3' - '4' - 4+ - 5+ - combined description: Number of bedrooms that the metric is expressed by examples: - 5+ supply: type: - integer - 'null' description: "The number of listings for sale or rent (based on the\ \ metric)
\r\nNote that a `null` value indicates data in unavailable\ \ for the date range" examples: - 22 demand: type: - integer - 'null' description: "The number of people who are seriously interested in sale\ \ or rent listings. Serious interest is defined as people who complete\ \ a number of actions, including things like saving a property or\ \ saving an inspection time.
\r\nNote that a `null` value indicates\ \ data in unavailable for the date range" examples: - 921 supplyChangePercentage: type: number description: The difference between supply for a given date range and the previous date range, expressed by percentage format: float examples: - 24.13793 demandChangePercentage: type: number description: The difference between demand for a given date range and the previous date range, expressed by percentage format: float examples: - 2.125398 examples: Potential Buyers - (Monthly): value: - propertyType: house dateRanges: - startDate: '2022-09-01' endDate: '2022-09-30' metricValues: - bedrooms: '1' supply: 22 demand: 921 supplyChangePercentage: 24.1379310344 demandChangePercentage: 2.12539851222 - bedrooms: '2' supply: 28 demand: 1044 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '4' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 5+ supply: 19 demand: 883 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - startDate: '2022-08-01' endDate: '2022-08-31' metricValues: - bedrooms: '1' supply: 22 demand: 1002 supplyChangePercentage: 0 demandChangePercentage: 8.794788273615636 - bedrooms: '2' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '4' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 5+ supply: 13 demand: 998 supplyChangePercentage: -31.57894736842105 demandChangePercentage: 13.023782559456398 - propertyType: unit dateRanges: - startDate: '2022-09-01' endDate: '2022-09-30' metricValues: - bedrooms: '0' supply: 22 demand: 921 supplyChangePercentage: 24.1379310344 demandChangePercentage: 2.12539851222 - bedrooms: '1' supply: 28 demand: 1044 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - bedrooms: '2' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 4+ supply: 19 demand: 883 supplyChangePercentage: 19.175 demandChangePercentage: 1.77753654 - startDate: '2022-08-01' endDate: '2022-08-31' metricValues: - bedrooms: '0' supply: 22 demand: 1002 supplyChangePercentage: 0 demandChangePercentage: 8.794788273615636 - bedrooms: '1' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '2' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: '3' supply: 29 demand: 1143 supplyChangePercentage: 3.571428571428571 demandChangePercentage: 9.482758620689655 - bedrooms: 4+ supply: 13 demand: 998 supplyChangePercentage: -31.57894736842105 demandChangePercentage: 13.023782559456398 Potential Renters (Weekly): value: - propertyType: house dateRanges: - startDate: '2022-08-01' endDate: '2022-08-07' metricValues: - bedrooms: '1' supply: 19 demand: 992 supplyChangePercentage: 18.75 demandChangePercentage: -0.99800399 - bedrooms: '2' supply: 19 demand: 1165 supplyChangePercentage: -38.7096774 demandChangePercentage: 7.17571297148 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 23 demand: 906 supplyChangePercentage: 35.294117647 demandChangePercentage: 2.2573363431 - startDate: '2022-08-08' endDate: '2022-08-14' metricValues: - bedrooms: '1' supply: 19 demand: 992 supplyChangePercentage: 18.75 demandChangePercentage: -0.99800399 - bedrooms: '2' supply: 19 demand: 1165 supplyChangePercentage: -38.7096774 demandChangePercentage: 7.17571297148 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 23 demand: 906 supplyChangePercentage: 35.294117647 demandChangePercentage: 2.2573363431 - startDate: '2022-08-15' endDate: '2022-08-21' metricValues: - bedrooms: '1' supply: 19 demand: 992 supplyChangePercentage: 18.75 demandChangePercentage: -0.99800399 - bedrooms: '2' supply: 19 demand: 1165 supplyChangePercentage: -38.7096774 demandChangePercentage: 7.17571297148 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 23 demand: 906 supplyChangePercentage: 35.294117647 demandChangePercentage: 2.2573363431 - startDate: '2022-08-22' endDate: '2022-08-28' metricValues: - bedrooms: '1' supply: 13 demand: 1167 supplyChangePercentage: -31.57894737 demandChangePercentage: 17.64112903 - bedrooms: '2' supply: 27 demand: 1089 supplyChangePercentage: 42.105263 demandChangePercentage: -6.52360515 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 20 demand: 1333 supplyChangePercentage: -13.0434783 demandChangePercentage: 47.1302428 - startDate: '2022-08-29' endDate: '2022-09-04' metricValues: - bedrooms: '1' supply: 19 demand: 1082 supplyChangePercentage: 46.15384615 demandChangePercentage: -7.2836332 - bedrooms: '2' supply: 19 demand: 1486 supplyChangePercentage: -29.62962963 demandChangePercentage: 36.4554637 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 12 demand: 1287 supplyChangePercentage: -40 demandChangePercentage: -3.450862716 - startDate: '2022-09-05' endDate: '2022-09-11' metricValues: - bedrooms: '1' supply: 18 demand: 1244 supplyChangePercentage: -5.2631578947 demandChangePercentage: 14.97227357 - bedrooms: '2' supply: 23 demand: 1335 supplyChangePercentage: 21.0526316 demandChangePercentage: -10.1615074 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 11 demand: 1334 supplyChangePercentage: -8.3333333332 demandChangePercentage: 3.651903652 - startDate: '2022-09-12' endDate: '2022-09-18' metricValues: - bedrooms: '1' supply: 22 demand: 1034 supplyChangePercentage: 22.2222222 demandChangePercentage: -16.8810289 - bedrooms: '2' supply: 25 demand: 1144 supplyChangePercentage: 8.695652174 demandChangePercentage: -14.3071161 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 19 demand: 887 supplyChangePercentage: 72.72727273 demandChangePercentage: -33.50824588 - startDate: '2022-09-19' endDate: '2022-09-25' metricValues: - bedrooms: '1' supply: 18 demand: 1727 supplyChangePercentage: -18.181818183 demandChangePercentage: 67.021276596 - bedrooms: '2' supply: 22 demand: 1374 supplyChangePercentage: -12 demandChangePercentage: 20.1048951 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 13 demand: 1226 supplyChangePercentage: -31.578947368 demandChangePercentage: 38.21871477 - startDate: '2022-09-26' endDate: '2022-10-02' metricValues: - bedrooms: '1' supply: 17 demand: 1201 supplyChangePercentage: -5.55555555 demandChangePercentage: -30.45744065 - bedrooms: '2' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '3' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: '4' supply: 16 demand: 1204 supplyChangePercentage: -27.27272727 demandChangePercentage: -12.372635 - bedrooms: 5+ supply: 19 demand: 1162 supplyChangePercentage: 46.153846154 demandChangePercentage: -5.220228385 headers: Content-Type: schema: const: application/json 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#marketsupply--demand) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: enum: - 7004 - 7005 - 7007 - 7008 - 7009 - 7010 - 7011 - 7014 - 7015 description: Defines the type of error that has occurred examples: - 7004 level: const: 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 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: A set of parameters that are causing the error and the rule that was invoked properties: metric: type: string examples: - is a required parameter state: type: string examples: - is a required parameter postcode: type: string examples: - is a required parameter suburb: type: string examples: - is a required parameter propertyTypes: type: string examples: - is a required parameter frequency: type: string examples: - must only include one value startDate: type: string examples: - must be in ISO_8601 format (YYYY-MM-DD) endDate: type: string examples: - must be in ISO_8601 format (YYYY-MM-DD) x-examples: Example 1: errors: - code: 7014 level: CRITICAL description: An invalid date range has been included - Please ensure that the start and end dates are valid parameters: startDate: cannot exceed the current date endDate: cannot exceed the current date examples: 7004 - Required Parameter Missing: value: errors: - code: 7004 level: CRITICAL description: Required parameter is missing - Please ensure that all required parameters have been included parameters: propertyTypes: is a required parameter state: is a required parameter postcode: is a required parameter suburb: is a required parameter metric: is a required parameter 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#marketsupply--demand) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred examples: - 9012 level: const: 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 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 x-examples: Example 1: errors: - code: 9016 level: CRITICAL description: Authentication token has expired - Please ensure that a valid token authentication request has been completed before trying again examples: 9012 - Authentication Error: value: 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 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#marketsupply--demand) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred examples: - Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description 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 '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#marketsupply--demand) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: const: 7002 description: Defines the type of error that has occurred examples: - 7002 level: const: 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 description: type: string description: Overview of the error that has occurred examples: - Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct x-examples: Example 1: errors: - code: 7002 level: CRITICAL description: Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct examples: 7002 - No Data Found: value: errors: - code: 7002 level: CRITICAL description: Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct 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#marketsupply--demand) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: const: 9011 description: Defines the type of error that has occurred examples: - 9011 enum: [] level: const: 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 enum: - CRITICAL description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly examples: 9011 - Rate Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly 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#marketsupply--demand) for information on error handling.' servers: - url: https://data.proptrack.com x-stoplight: id: zt4h5tmmucx2v /api/v2/market/demographics: get: summary: /api/v2/market/demographics responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: object x-examples: Example 1: dateRanges: - startDate: '2023-10-02' endDate: '2023-10-08' metricValues: clearanceRate: value: 63.7344 changePercentage: 10.13 observations: 1205 countScheduled: value: 62 changePercentage: 313.33 countSold: value: 523 changePercentage: 462.37 countSoldPrior: value: 205 changePercentage: 632.14 countSoldAfter: value: 40 changePercentage: 166.67 countPassedIn: value: 303 changePercentage: 396.72 countWithdrawn: value: 134 changePercentage: 252.63 - startDate: '2023-10-09' endDate: '2023-10-15' metricValues: clearanceRate: value: 60.3704 changePercentage: -5.28 observations: 1080 countScheduled: value: 51 changePercentage: -17.74 countSold: value: 479 changePercentage: -8.41 countSoldPrior: value: 149 changePercentage: -27.32 countSoldAfter: value: 24 changePercentage: -40 countPassedIn: value: 299 changePercentage: -1.32 countWithdrawn: value: 129 changePercentage: -3.73 properties: demographicMarketMetrics: type: object x-stoplight: id: svngramxykorp description: Demographic metrics for external customers as per latest census data from ABS properties: age: type: object description: Age Group Demographic metrics properties: ageMedian: type: number x-stoplight: id: qe5zq5u5hu73n example: 45 description: median age format: float ageDetails: type: array x-stoplight: id: 56jdgsypdmcts description: Population details who are aged within the respective age groups items: x-stoplight: id: anq2ms54vgd6h type: object properties: ageGroup: x-stoplight: id: idwd9wkisvplu description: "Age Group Ranges\r\nE.g.:
\r\nUnder 15
\r\n15-64
\r\ \nOver 65
" enum: - under15 - 15to64 - over65 percentage: type: number x-stoplight: id: qa311maqemseu format: float example: 33.33 description: The percentage of population who are aged within the respective age groups ' householdIncome': type: object x-stoplight: id: 3niuvv9xw2ekn description: Household income demographic metrics properties: medianWeeklyHouseholdIncome: type: number x-stoplight: id: 7dcqw3q3s788m description: median weekly household income as per Census example: 45000 format: float householdSize: type: object x-stoplight: id: cdh8s7jcwhhzu description: Household size demographic metrics properties: meanHouseholdSize: type: number x-stoplight: id: 89zbgr6ds90x8 format: float example: 2.52 description: The average household size as per Census householdType: type: object x-stoplight: id: zwsdudyofqnt6 description: Houshold type demographic metrics properties: householdGroup: type: array x-stoplight: id: puo5wxq2gm74l description: House Hold Group Demographic Metrics items: x-stoplight: id: r57fwvkwegf9c type: object properties: householdTypes: x-stoplight: id: gwqqw683y1cb4 description: 'The percentage of Households which are classified as
Family, Group and Single ' enum: - family - group - single percentage: type: number x-stoplight: id: om36yzv3sb5b9 format: float example: 2.5 description: Household Composition Percentage population: type: object x-stoplight: id: bhcfo0uoenoo9 description: Demographic Population metrics properties: totalPopulation: type: integer x-stoplight: id: qp8jn41l5upqb description: 'The total of population count as per Census ' example: 25422788 tenure: type: object x-stoplight: id: o9n7mtwlt6n2p description: Tenure type demographic metrics properties: tenureTypeGroup: type: array x-stoplight: id: teppo6e79iop5 description: Tenure Type Groups items: x-stoplight: id: dqpn6tfgtrnkc type: object properties: tenureType: x-stoplight: id: nrno1xm115d4k enum: - notStated - withMortgage - ownedOutright - rented - notClearlyClassified description: 'Tenure type grouping ' percentage: type: number x-stoplight: id: pi7yyvbzlp364 format: float description: Tenure type percentage examples: Example 1: value: demographicMarketMetrics: age: ageMedian: 45 ageDetails: - ageGroup: under15 percentage: 33.33 ' householdIncome': medianWeeklyHouseholdIncome: 45000 householdSize: meanHouseholdSize: 2.52 householdType: householdGroup: - householdType: family percentage: 2.5 population: totalPopulation: 25422788 tenure: tenureTypeGroup: - tenureType: notStated percentage: -3.402823669209385e+38 '400': description: ' > #### Bad Request (400)' 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: searchType: is a required parameter state: is a required parameter postcode: is a required parameter suburb: is a required parameter gccsaCode: is a required parameter startDate: is a required parameter endDate: is a required parameter properties: errors: type: array items: type: object required: - code - description properties: code: description: Defines the type of error that has occurred enum: - 7004 - 7007 - 7008 - 7010 - 7011 - 7014 - 7015 description: type: string description: Overview of the error that has occurred example: Required parameter is missing - Please ensure that all required parameters have been included parameters: type: object description: A set of parameters that are causing the error and the rule that was invoked properties: searchType: type: string example: is a required parameter state: type: string example: must only include an allowed value postcode: type: string example: must be an integer suburb: type: string example: is a required parameter when searching by suburb gccsaCode: type: string example: is a required parameter when searching by gccsa examples: 7004 - Required Parameter Missing: value: errors: - code: 7004 description: Required parameter is missing - Please ensure that all required parameters have been included parameters: searchType: is a required parameter state: is a required parameter when searching by state or suburb postcode: is a required parameter when searching by suburb suburb: is a required parameter when searching by suburb gccsaCode: is a required parameter when searching by gccsa 7007 - Non-Allowed Value in Enum Field: value: errors: - code: 7007 description: A non-allowed value has been included into an enum field - Please ensure that the value entered is an allowed option parameters: searchType: must only include an allowed value state: must only include an allowed value 7008 - Incorrect Field Type: value: errors: - code: 7008 description: An incorrect field type has been included - Please ensure that all values are using the correct field type parameters: postcode: must be an integer 7010 - Incorrect Format: value: errors: - code: 7010 description: An incorrect format has been included - Please ensure that the correct formatting has been used for all parameters parameters: startDate: must be in ISO_8601 format (YYYY-MM-DD) endDate: must be in ISO_8601 format (YYYY-MM-DD) 7011 - Above/Below Limit: value: errors: - code: 7011 description: A value above/below the allowed limit has been included - Please ensure that a valid value has been entered parameters: postcode: must not exceed 4 digits 7014 - Invalid Date Range: value: errors: - code: 7014 description: An invalid date range has been included - Please ensure that the start and end dates are valid parameters: startDate: cannot exceed the current date endDate: cannot exceed the current date 7015 - Conflicting Date Range: value: errors: - code: 7015 description: A conflicting date range has been included - Please ensure that the start and end dates are compatible parameters: startDate: cannot be set as a date after endDate '401': description: ' > #### Unauthorized (401)' 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: description: Defines the type of error that has occurred enum: - 9012 - 9016 level: description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' deprecated: true enum: - CRITICAL description: type: string description: Overview of the error that has occurred example: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description examples: 9012 - Invalid Auth Token: value: 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 9016 - Expired Auth Token: value: errors: - code: 9016 level: CRITICAL description: Authentication token has expired - Please ensure that a valid token authentication request has been completed before trying again '403': description: ' > #### Forbidden (403)' 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: 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 examples: 9003 - Access Denied: value: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint '404': description: ' > #### Not Found (404)' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 7002 level: CRITICAL description: Unknown identifier, the included address does not match a record within our system - Please ensure that the state, suburb and postcode are correct properties: errors: type: array items: type: object required: - code - description properties: code: enum: - 7002 description: Defines the type of error that has occurred description: type: string example: Unknown identifier, the included location does not match a record within our system - Please ensure that the identifier is correct description: Overview of the error that has occurred examples: 7002 - Unknown Identifier: value: errors: - code: 7002 description: Unknown identifier, the included location does not match a record within our system - Please ensure that the identifier is correct parameters: suburb: cannot be found '429': description: ' > #### Too Many Requests (429)' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL 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 level: 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 example: Rate limit has been exceeded - Please try again shortly description: Overview of the error that has occurred required: - code - description examples: 9011- Rate Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly 9011 - Quota Limit Exceeded: value: errors: - code: 9011 level: CRITICAL description: Quota limit has been reached - Please contact our customer support team at support@proptrack.com for further information '500': description: ' > #### Internal Server Error (500)' operationId: /api/v2/market/demographics x-stoplight: id: lv6zom9raoksb description: "Retrieves Demographic statistics for a given suburb or greater capital city statistical\ \ area\r\n
Note: This endpoint will bring in 'latest' census data\r\n#### Data Attribution\ \ Notice:\r\nThis endpoint contains data licensed from the Commonwealth of Australia under the\ \ Creative Commons Attribution International (CC BY 4.0) License. Appropriate attribution should\ \ be given when displaying this data.\r\n\r\nDisclaimer Types:`abs`\r\n\r\nPlease refer to [Disclaimers\ \ and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding) for more information\ \ on implementing data source disclaimers in your experience.\r\n" parameters: - schema: type: string example: Berwick in: query name: suburb description: 'Suburb name
Note: If `searchType` equals `suburb`, then this field is required' - schema: type: string example: '3806' in: query name: postcode description: 'Four digit postcode
Note: If `searchType` equals `suburb`, then this field is required' - schema: type: string example: 2GMEL in: query name: gccsaCode description: 'Greater Capital City Statistical Area (GCCSA) code.
Note: If `searchType` equals `gccsa`, then this field is required' - schema: type: string enum: - suburb - gccsa in: query name: searchType description: Defines the identifier used
Refer to [Search Type Values](https://developer.proptrack.com.au/docs/apis/guide#valid-market-search-types). required: true - in: header name: Authorization 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 - schema: type: string enum: - vic - act - nsw - sa - tas - wa - qld - nt in: query name: state description: 'State or territory within Australia
Note: If `searchType` equals `suburb`, then this field is required' tags: - Demographics parameters: []