openapi: 3.2.0
info:
  title: Microburbs Property Data Property - Amenities API
  summary: Suburb and property data for every Australian locality.
  description: '**One REST API for demographics, market indicators, risk scores, AVM and

    ranking — backed by 25+ years of Australian transactions and census data.**


    ```bash

    curl ''https://api.microburbs.com.au/v1/properties/GANSW704074813/profile'' \

    -H ''Authorization: Bearer test''

    ```


    ## Why Microburbs


    - **Data depth** — Demographics, lifestyle, risk, market, AVM and growth forecasts — all keyed to the same national suburb and property graph.'
  version: 1.0.0
servers:
- url: https://api.microburbs.com.au
  description: Production
security:
- BearerAuth: []
tags:
- name: Property - Amenities
  description: Nearby amenities and transport within 1km.
paths:
  /v1/properties/{gnaf_id}/amenities/nearby:
    get:
      tags:
      - Property - Amenities
      summary: Nearby amenities
      description: 'Curated amenities (supermarkets, green spaces, restaurants/cafes)

        within `radius_m` of the property, bucketed and nearest-first.


        **Price: 10¢ per call.**'
      operationId: get_property_amenities_nearby_v1_properties__gnaf_id__amenities_nearby_get
      parameters:
      - name: gnaf_id
        in: path
        required: true
        schema:
          type: string
          title: Gnaf Id
          example: GANSW704074813
        example: GANSW704074813
      - name: radius_m
        in: query
        required: false
        schema:
          type: integer
          maximum: 5000
          minimum: 100
          description: Search radius in metres (100–5000, default 1000).
          default: 1000
          title: Radius M
        description: Search radius in metres (100–5000, default 1000).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_AmenitiesNearby_'
              example:
                data:
                  center_lat: -33.802479
                  center_lng: 151.219715
                  counts:
                    green_spaces: 4
                    restaurant: 11
                    supermarket: 2
                  gnaf_id: GANSW704360755
                  radius_m: 1000
                  results:
                  - category: Supermarket
                    distance_m: 240
                    lat: -33.8011
                    lng: 151.2216
                    name: Castlecrag Village
                  - category: Green Spaces
                    distance_m: 190
                    lat: -33.8038
                    lng: 151.218
          headers:
            X-Cost-Cents:
              description: Exact cents billed for this call.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Spent-Cents:
              description: Cumulative cents Autumn reports used for this prepaid wallet.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Remaining-Cents:
              description: Spendable prepaid credit left after this call.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Period-End:
              description: Start of the next UTC calendar month. Prepaid credit does not expire at this timestamp.
              required: true
              schema:
                type: string
                format: date-time
            X-Balance-Cents:
              description: Compatibility alias of X-Remaining-Cents.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Rate-Card-Version:
              description: Version of the endpoint rate card used for this call.
              required: true
              schema:
                type: integer
                minimum: 1
            X-Request-Id:
              description: Request identifier to quote in support requests.
              required: true
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
              example:
                detail:
                - type: missing
                  loc:
                  - query
                  - address
                  msg: Field required
                  input: null
      x-price-cents: 10
  /v1/properties/{gnaf_id}/transport/nearby:
    get:
      tags:
      - Property - Amenities
      summary: Nearest transport by mode
      description: 'Nearest train / tram / bus / ferry stop to the property, per mode,

        with distance. Widen `radius_m` for the nearest station beyond 1km.


        **Price: 5¢ per call.**'
      operationId: get_property_transport_nearby_v1_properties__gnaf_id__transport_nearby_get
      parameters:
      - name: gnaf_id
        in: path
        required: true
        schema:
          type: string
          title: Gnaf Id
          example: GANSW704074813
        example: GANSW704074813
      - name: radius_m
        in: query
        required: false
        schema:
          type: integer
          maximum: 5000
          minimum: 100
          description: Search radius in metres (100–5000, default 1000).
          default: 1000
          title: Radius M
        description: Search radius in metres (100–5000, default 1000).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_TransportNearby_'
              example:
                data:
                  center_lat: -33.802479
                  center_lng: 151.219715
                  counts:
                    bus: 6
                    ferry: 0
                    train: 0
                    tram: 0
                  gnaf_id: GANSW704360755
                  nearest:
                    bus:
                      distance_m: 130
                      label: Bus stop
                      lat: -33.8031
                      lng: 151.2201
                  radius_m: 1000
          headers:
            X-Cost-Cents:
              description: Exact cents billed for this call.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Spent-Cents:
              description: Cumulative cents Autumn reports used for this prepaid wallet.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Remaining-Cents:
              description: Spendable prepaid credit left after this call.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Period-End:
              description: Start of the next UTC calendar month. Prepaid credit does not expire at this timestamp.
              required: true
              schema:
                type: string
                format: date-time
            X-Balance-Cents:
              description: Compatibility alias of X-Remaining-Cents.
              required: true
              schema:
                type: integer
                minimum: 0
            X-Rate-Card-Version:
              description: Version of the endpoint rate card used for this call.
              required: true
              schema:
                type: integer
                minimum: 1
            X-Request-Id:
              description: Request identifier to quote in support requests.
              required: true
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
              example:
                detail:
                - type: missing
                  loc:
                  - query
                  - address
                  msg: Field required
                  input: null
      x-price-cents: 5
components:
  schemas:
    TransportStop:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Stop / station name (blank for bus & tram stops).
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
          description: 'Mode label: Train station / Tram stop / Bus stop / Ferry terminal.'
        lat:
          anyOf:
          - type: number
          - type: 'null'
          title: Lat
          description: Latitude (WGS84).
        lng:
          anyOf:
          - type: number
          - type: 'null'
          title: Lng
          description: Longitude (WGS84).
        distance_m:
          anyOf:
          - type: integer
          - type: 'null'
          title: Distance M
          description: Straight-line distance from the property, metres.
      additionalProperties: true
      type: object
      title: TransportStop
      description: The nearest stop/station of one mode.
    TransportNearby:
      properties:
        gnaf_id:
          type: string
          title: Gnaf Id
          description: GNAF property identifier.
        center_lat:
          type: number
          title: Center Lat
          description: Property latitude (WGS84).
        center_lng:
          type: number
          title: Center Lng
          description: Property longitude (WGS84).
        radius_m:
          type: integer
          title: Radius M
          description: Search radius applied, metres.
        counts:
          additionalProperties:
            type: integer
          type: object
          title: Counts
          description: Count per mode within the radius (train / tram / bus / ferry).
        nearest:
          additionalProperties:
            anyOf:
            - $ref: '#/components/schemas/TransportStop'
            - type: 'null'
          type: object
          title: Nearest
          description: Nearest stop per mode; null when none falls inside the radius.
      additionalProperties: true
      type: object
      required:
      - gnaf_id
      - center_lat
      - center_lng
      - radius_m
      - counts
      - nearest
      title: TransportNearby
      description: Nearest public-transport stop per mode within the radius.
      example:
        center_lat: -33.802479
        center_lng: 151.219715
        counts:
          bus: 6
          ferry: 0
          train: 0
          tram: 0
        gnaf_id: GANSW704360755
        nearest:
          bus:
            distance_m: 130
            label: Bus stop
            lat: -33.8031
            lng: 151.2201
        radius_m: 1000
    ApiResponse_AmenitiesNearby_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/AmenitiesNearby'
          - type: 'null'
          description: The endpoint's payload, or `null` when Microburbs has no value.
        available:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Available
          description: '`false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator.'
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success.
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: Human-readable explanation. Omitted on success.
      type: object
      title: ApiResponse[AmenitiesNearby]
    AmenitiesNearby:
      properties:
        gnaf_id:
          type: string
          title: Gnaf Id
          description: GNAF property identifier.
        center_lat:
          type: number
          title: Center Lat
          description: Property latitude (WGS84).
        center_lng:
          type: number
          title: Center Lng
          description: Property longitude (WGS84).
        radius_m:
          type: integer
          title: Radius M
          description: Search radius applied, metres.
        counts:
          additionalProperties:
            type: integer
          type: object
          title: Counts
          description: Count per bucket within the radius (exact, pre-cap).
        results:
          items:
            $ref: '#/components/schemas/AmenityRow'
          type: array
          title: Results
          description: Amenities, nearest first (capped at 80).
      additionalProperties: true
      type: object
      required:
      - gnaf_id
      - center_lat
      - center_lng
      - radius_m
      - counts
      - results
      title: AmenitiesNearby
      description: Curated amenities within the radius, bucketed and nearest-first.
      example:
        center_lat: -33.802479
        center_lng: 151.219715
        counts:
          green_spaces: 4
          restaurant: 11
          supermarket: 2
        gnaf_id: GANSW704360755
        radius_m: 1000
        results:
        - category: Supermarket
          distance_m: 240
          lat: -33.8011
          lng: 151.2216
          name: Castlecrag Village
        - category: Green Spaces
          distance_m: 190
          lat: -33.8038
          lng: 151.218
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ApiResponse_TransportNearby_:
      properties:
        data:
          anyOf:
          - $ref: '#/components/schemas/TransportNearby'
          - type: 'null'
          description: The endpoint's payload, or `null` when Microburbs has no value.
        available:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Available
          description: '`false` on no-data responses. Omitted on success — branch on `data !== null` if you want a single discriminator.'
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Machine-readable slug naming the no-data condition (e.g. `no_avm_for_GANSW704074813`). Stable per endpoint. Omitted on success.
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: Human-readable explanation. Omitted on success.
      type: object
      title: ApiResponse[TransportNearby]
    AmenityRow:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Amenity name, where known.
        category:
          anyOf:
          - type: string
          - type: 'null'
          title: Category
          description: 'Bucket: Supermarket / Green Spaces / Restaurant.'
        lat:
          anyOf:
          - type: number
          - type: 'null'
          title: Lat
          description: Latitude (WGS84).
        lng:
          anyOf:
          - type: number
          - type: 'null'
          title: Lng
          description: Longitude (WGS84).
        distance_m:
          anyOf:
          - type: integer
          - type: 'null'
          title: Distance M
          description: Straight-line distance from the property, metres.
      additionalProperties: true
      type: object
      title: AmenityRow
      description: One nearby amenity.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key as Bearer token. Use `test` for the public sandbox (works only for GNAFs GANSW704074813, GAACT714845944, GAVIC419929404, GAQLD162849753, GAWA_146662014, GASA_422266490, GATAS702292990, GANT_703835649 and SALs 'Belmont North', 'Bondi', 'St Kilda (Vic.)', 'Fortitude Valley', 'Subiaco', 'Unley', 'Sandy Bay', 'Kambah', 'Nightcliff', always 0¢). Mint your own at /developers/keys for full access.
x-tagGroups:
- name: Suburb
  tags:
  - Suburb - Hero
  - Suburb - Profile
  - Suburb - Market
  - Suburb - Forecast
  - Suburb - Listings
  - Suburb - Sales
  - Suburb - Street Forecasts
  - Suburb - Demographics
  - Suburb - Ethnicity
  - Suburb - Development
  - Suburb - Schools
  - Suburb - Risks
  - Suburb - Crime
  - Suburb - Lifestyle
  - Suburb - Similar
  - Suburb - Shapes
- name: Finders
  tags:
  - Suburb - Finder
- name: Property
  tags:
  - Property - Profile
  - Property - Basics
  - Property - Valuation
  - Property - History
  - Property - Title
  - Property - Comparables
  - Property - Development
  - Property - Schools
  - Property - Amenities
  - Property - Risks
  - Property - Surroundings
  - Property - Context
- name: Area Statistics
  tags:
  - Area Statistics
- name: Mesh Block
  tags:
  - Mesh Block - Profile
- name: LGA
  tags:
  - LGA - Profile
- name: SA4
  tags:
  - SA4 - Profile
- name: Geocode
  tags:
  - Geocode
- name: Account
  tags:
  - Account