openapi: 3.2.0
info:
  title: Domain Group Demographics API
  contact:
    name: Domain Developer Support
    email: api@domain.com.au
  termsOfService: https://developer.domain.com.au/docs/latest/support/terms
  version: '1.0'
  description: 'Operations tagged Demographics across 2 of this provider''s published API definitions: domain-group-openapi-latest.json, domain-group-openapi-v2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.domain.com.au/
  description: Primary
- url: https://api.domain.com.au/sandbox/
  description: Sandbox
tags:
- name: Demographics
paths:
  /v2/demographics/{state}/{suburb}/{postcode}:
    get:
      tags:
      - Demographics
      summary: Demographics API
      description: Search for demographics in a given geographic level.
      operationId: Demographics_Get_ByNamedSuburb
      parameters:
      - name: state
        in: path
        description: 'The Australian state abbreviation

          '
        required: true
        style: simple
        schema:
          type: string
        example: NSW
      - name: suburb
        in: path
        description: 'Suburb name to retrieve data for

          '
        required: true
        style: simple
        schema:
          type: string
        example: Pyrmont
      - name: postcode
        in: path
        description: 'Suburb Post Code for suburbs with official post codes.

          '
        required: true
        style: simple
        schema:
          pattern: ^\d{4}$
          type: string
        example: '2009'
      - name: year
        in: query
        description: Census Year of data to return
        style: form
        schema:
          enum:
          - 2011
          - 2016
          - 2021
          type: integer
      - name: types
        in: query
        description: '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

          '
        style: form
        schema:
          type: string
      responses:
        '200':
          description: Historical data returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemographicsResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_demographics_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
components:
  schemas:
    DemographicsResponse:
      type: object
      properties:
        demographics:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              total:
                type: integer
              year:
                type: integer
              items:
                type: array
                items:
                  type: object
                  properties:
                    label:
                      type: string
                    value:
                      type: integer
                    composition:
                      type: string
  securitySchemes:
    apikey:
      type: apiKey
      description: API Key in Header
      name: x-api-key
      in: header
    oauth2:
      type: oauth2
      description: OAuth 2
      flows:
        clientCredentials:
          tokenUrl: https://auth.domain.com.au/v1/connect/token
          scopes:
            api_addresslocators_read: api_addresslocators_read
            api_agencies_read: api_agencies_read
            api_agencies_write: api_agencies_write
            api_authorities_write: api_authorities_write
            api_avm_read: api_avm_read
            api_campaignperformance_read: api_campaignperformance_read
            api_dataset_read: api_dataset_read
            api_demographics_read: api_demographics_read
            api_enquiries_read: api_enquiries_read
            api_enquiries_write: api_enquiries_write
            api_listingperformance_read: api_listingperformance_read
            api_listings_read: api_listings_read
            api_listings_write: api_listings_write
            api_locations_read: api_locations_read
            api_projectperformance_read: api_projectperformance_read
            api_properties_read: api_properties_read
            api_propertyportfolio_read: api_propertyportfolio_read
            api_propertyportfolio_write: api_propertyportfolio_write
            api_propertyreports_read: api_propertyreports_read
            api_salesresults_read: api_salesresults_read
            api_statistics_write: api_statistics_write
            api_suburbhistorical_read: api_suburbhistorical_read
            api_suburbperformance_read: api_suburbperformance_read
            api_suburbsummary_read: api_suburbsummary_read
            api_webhooks_write: api_webhooks_write
        authorizationCode:
          authorizationUrl: https://auth.domain.com.au/v1/connect/authorize
          tokenUrl: https://auth.domain.com.au/v1/connect/token
          refreshUrl: https://auth.domain.com.au/v1/connect/token
          scopes:
            api_addresslocators_read: api_addresslocators_read
            api_agencies_read: api_agencies_read
            api_agencies_write: api_agencies_write
            api_authorities_write: api_authorities_write
            api_avm_read: api_avm_read
            api_campaignperformance_read: api_campaignperformance_read
            api_dataset_read: api_dataset_read
            api_demographics_read: api_demographics_read
            api_enquiries_read: api_enquiries_read
            api_enquiries_write: api_enquiries_write
            api_listingperformance_read: api_listingperformance_read
            api_listings_read: api_listings_read
            api_listings_write: api_listings_write
            api_locations_read: api_locations_read
            api_projectperformance_read: api_projectperformance_read
            api_properties_read: api_properties_read
            api_propertyportfolio_read: api_propertyportfolio_read
            api_propertyportfolio_write: api_propertyportfolio_write
            api_propertyreports_read: api_propertyreports_read
            api_salesresults_read: api_salesresults_read
            api_statistics_write: api_statistics_write
            api_suburbhistorical_read: api_suburbhistorical_read
            api_suburbperformance_read: api_suburbperformance_read
            api_suburbsummary_read: api_suburbsummary_read
            api_webhooks_write: api_webhooks_write
x-refined-from:
- domain-group-openapi-latest.json
- domain-group-openapi-v2.json