Demographics API
Changed onSearch for demographics in a given geographic level.
Request
- Base URLhttps://api.domain.com.au
- Auth
- API key in header x-api-key
- or OAuth 2Authorization codehttps://auth.domain.com.au/v1/connect/authorizeClient credentialsToken URLhttps://auth.domain.com.au/v1/connect/tokenScopesapi_demographics_read
- TypeScripthttps://skmtc.dev/domain/apis/domain-public-api/docs/v2/demographics/:state/:suburb/:postcode/get.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
The Australian state abbreviation
Suburb name to retrieve data for
Suburb Post Code for suburbs with official post codes.
Query parameters
Census Year of data to return
Comma separated list of census topics to retrieve demographic data for e.g. "Rent,TransportToWork" Possible values include:
- AgeGroupOfPopulation
- CountryOfBirth
- NatureOfOccupancy
- Occupation
- GeographicalPopulation
- DwellingStructure
- EducationAttendance
- HousingLoanRepayment
- MaritalStatus
- Religion
- TransportToWork
- FamilyComposition
- HouseholdIncome
- Rent
- LabourForceStatus
Response
Historical data returned
Changes
- breaking
the
queryrequest parameteryearwas restricted to a list of enum values - breaking
added the pattern
^\d{4}$to thepathrequest parameterpostcode - breaking
the
////response's property format changed fromint32to no format for status - breaking
the
//response's property format changed fromint64to no format for status - breaking
the
//response's property format changed fromint32to no format for status - info
added the new enum value
2011.00to thequeryrequest parameteryear - info
added the new enum value
2016.00to thequeryrequest parameteryear - info
added the new enum value
2021.00to thequeryrequest parameteryear - info
for the
queryrequest parameteryear, the format was generalized fromint32to no format - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- breaking
- breaking
the
pathrequest parameterpostcodebecame required
- breaking