Casa Intelligence Planning API

openapi: 3.2.0
info:
  title: Casa Intelligence Engine Planning API
  description: Proprietary data ingestion, analysis, and prediction engine for Queensland property development intelligence.
  version: 2.0.0
tags:
- name: Planning
paths:
  /api/v1/planning/use-permissibility:
    get:
      tags:
      - Planning
      summary: Get Use Permissibility
      description: Look up whether a use is permitted in a zone and at what assessment level.
      operationId: get_use_permissibility_api_v1_planning_use_permissibility_get
      security:
      - HTTPBearer: []
      parameters:
      - name: use
        in: query
        required: true
        schema:
          type: string
          minLength: 2
          description: Use name to look up (e.g. 'Dwelling house', 'Food and drink outlet')
          title: Use
        description: Use name to look up (e.g. 'Dwelling house', 'Food and drink outlet')
      - name: zone_code
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          description: Zone code (e.g. 'LDR', 'NC', 'MU')
          title: Zone Code
        description: Zone code (e.g. 'LDR', 'NC', 'MU')
      - name: lga
        in: query
        required: true
        schema:
          type: string
          minLength: 3
          description: LGA name (e.g. 'Brisbane', 'Gold Coast')
          title: Lga
        description: LGA name (e.g. 'Brisbane', 'Gold Coast')
      - name: precinct
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Precinct the land sits in, as stamped on the parcel (ci_properties.overlay_details->'zone_precinct'->>'code'). Required to get a single answer where a scheme answers per precinct — Moreton Bay's General residential precincts differ. Omit it and differing uses come back state=not_held with every precinct's answer named, which is the truth rather than a guess.
          title: Precinct
        description: Precinct the land sits in, as stamped on the parcel (ci_properties.overlay_details->'zone_precinct'->>'code'). Required to get a single answer where a scheme answers per precinct — Moreton Bay's General residential precincts differ. Omit it and differing uses come back state=not_held with every precinct's answer named, which is the truth rather than a guess.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsePermissibilityResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/planning/infrastructure-charges:
    get:
      tags:
      - Planning
      summary: Get Infrastructure Charges
      description: Look up official infrastructure charges and compare with actual charges from DA data.
      operationId: get_infrastructure_charges_api_v1_planning_infrastructure_charges_get
      security:
      - HTTPBearer: []
      parameters:
      - name: lga
        in: query
        required: true
        schema:
          type: string
          minLength: 3
          description: LGA name
          title: Lga
        description: LGA name
      - name: use_category
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Use category (e.g. 'residential', 'commercial')
          title: Use Category
        description: Use category (e.g. 'residential', 'commercial')
      - name: lots
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 200
            minimum: 1
          - type: 'null'
          description: Number of proposed lots/dwellings
          title: Lots
        description: Number of proposed lots/dwellings
      - name: zone_code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Zone code for comparable actual charges
          title: Zone Code
        description: Zone code for comparable actual charges
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfrastructureChargesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/planning/assessment-requirements:
    get:
      tags:
      - Planning
      summary: Get Assessment Requirements
      description: Get assessment level and applicable codes for a zone and development type.
      operationId: get_assessment_requirements_api_v1_planning_assessment_requirements_get
      security:
      - HTTPBearer: []
      parameters:
      - name: lga
        in: query
        required: true
        schema:
          type: string
          minLength: 3
          title: Lga
      - name: zone_code
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          title: Zone Code
      - name: development_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: MCU, RaL, operational_work, building_work
          title: Development Type
        description: MCU, RaL, operational_work, building_work
      - name: use_or_activity
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Specific use to filter by
          title: Use Or Activity
        description: Specific use to filter by
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentRequirementsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/planning/provision-search:
    get:
      tags:
      - Planning
      summary: Search Provisions
      description: Search planning scheme provisions using full-text search.
      operationId: search_provisions_api_v1_planning_provision_search_get
      security:
      - HTTPBearer: []
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
          minLength: 3
          description: Search text
          title: Query
        description: Search text
      - name: lga
        in: query
        required: true
        schema:
          type: string
          minLength: 3
          title: Lga
      - name: provision_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by type: zone_code, overlay_code, development_code, etc.'
          title: Provision Type
        description: 'Filter by type: zone_code, overlay_code, development_code, etc.'
      - name: zone_code
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Zone Code
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvisionSearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/planning/schemes:
    get:
      tags:
      - Planning
      summary: List Schemes
      description: List all available planning schemes with data coverage stats.
      operationId: list_schemes_api_v1_planning_schemes_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlanningSchemeInfo'
                type: array
                title: Response List Schemes Api V1 Planning Schemes Get
      security:
      - HTTPBearer: []
components:
  schemas:
    UsePermissibilityResponse:
      properties:
        exact_match:
          anyOf:
          - $ref: '#/components/schemas/UsePermissibilityResult'
          - type: 'null'
        similar_matches:
          items:
            $ref: '#/components/schemas/UsePermissibilityResult'
          type: array
          title: Similar Matches
          default: []
        query:
          type: string
          title: Query
        zone_code:
          type: string
          title: Zone Code
        lga:
          type: string
          title: Lga
        state:
          type: string
          title: State
          default: permitted
        statement:
          anyOf:
          - type: string
          - type: 'null'
          title: Statement
        citation:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Citation
        disclaimer:
          type: string
          title: Disclaimer
          default: This information is indicative only and based on the data sources cited. It should be verified against the current planning scheme and is not a substitute for professional planning advice. Planning schemes are amended regularly — always check the latest version before making decisions.
      type: object
      required:
      - query
      - zone_code
      - lga
      title: UsePermissibilityResponse
    InfrastructureChargesResponse:
      properties:
        lga:
          type: string
          title: Lga
        resolution_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Resolution Name
        effective_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Effective Date
        charges:
          items:
            $ref: '#/components/schemas/ChargeItem'
          type: array
          title: Charges
          default: []
        total_estimated_charge:
          anyOf:
          - type: number
          - type: 'null'
          title: Total Estimated Charge
        comparable_actual_charges:
          anyOf:
          - $ref: '#/components/schemas/ComparableCharges'
          - type: 'null'
        zone_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Zone Code
        use_category:
          anyOf:
          - type: string
          - type: 'null'
          title: Use Category
        citation:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Citation
        comparable_citation:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Comparable Citation
        disclaimer:
          type: string
          title: Disclaimer
          default: This information is indicative only and based on the data sources cited. It should be verified against the current planning scheme and is not a substitute for professional planning advice. Planning schemes are amended regularly — always check the latest version before making decisions.
      type: object
      required:
      - lga
      title: InfrastructureChargesResponse
    ChargeItem:
      properties:
        network:
          type: string
          title: Network
        charge_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Charge Type
        charge_rate:
          type: number
          title: Charge Rate
        demand_unit:
          anyOf:
          - type: string
          - type: 'null'
          title: Demand Unit
        estimated_quantity:
          anyOf:
          - type: integer
          - type: 'null'
          title: Estimated Quantity
        estimated_charge:
          anyOf:
          - type: number
          - type: 'null'
          title: Estimated Charge
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
      type: object
      required:
      - network
      - charge_rate
      title: ChargeItem
    UsePermissibilityResult:
      properties:
        use_name:
          type: string
          title: Use Name
        zone_code:
          type: string
          title: Zone Code
        zone_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Zone Name
        lga:
          type: string
          title: Lga
        permissibility:
          type: string
          title: Permissibility
        state:
          type: string
          title: State
          default: permitted
        statement:
          anyOf:
          - type: string
          - type: 'null'
          title: Statement
        definition:
          anyOf:
          - type: string
          - type: 'null'
          title: Definition
        conditions:
          anyOf:
          - type: string
          - type: 'null'
          title: Conditions
        applicable_codes:
          items:
            type: string
          type: array
          title: Applicable Codes
          default: []
        provision_reference:
          anyOf:
          - type: string
          - type: 'null'
          title: Provision Reference
        scheme_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Scheme Name
      type: object
      required:
      - use_name
      - zone_code
      - lga
      - permissibility
      title: UsePermissibilityResult
    AssessmentRequirement:
      properties:
        development_type:
          type: string
          title: Development Type
        use_or_activity:
          anyOf:
          - type: string
          - type: 'null'
          title: Use Or Activity
        category_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Category Description
        assessment_level:
          type: string
          title: Assessment Level
        applicable_codes:
          items:
            type: string
          type: array
          title: Applicable Codes
          default: []
        provision_reference:
          anyOf:
          - type: string
          - type: 'null'
          title: Provision Reference
      type: object
      required:
      - development_type
      - assessment_level
      title: AssessmentRequirement
    AssessmentRequirementsResponse:
      properties:
        lga:
          type: string
          title: Lga
        zone_code:
          type: string
          title: Zone Code
        requirements:
          items:
            $ref: '#/components/schemas/AssessmentRequirement'
          type: array
          title: Requirements
          default: []
        scheme_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Scheme Name
        total:
          type: integer
          title: Total
          default: 0
        citation:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Citation
        disclaimer:
          type: string
          title: Disclaimer
          default: This information is indicative only and based on the data sources cited. It should be verified against the current planning scheme and is not a substitute for professional planning advice. Planning schemes are amended regularly — always check the latest version before making decisions.
      type: object
      required:
      - lga
      - zone_code
      title: AssessmentRequirementsResponse
    ProvisionResult:
      properties:
        id:
          type: string
          title: Id
        section_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Section Number
        section_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Section Title
        provision_type:
          type: string
          title: Provision Type
        zone_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Zone Code
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        full_text:
          type: string
          title: Full Text
        key_parameters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Key Parameters
        relevance_score:
          anyOf:
          - type: number
          - type: 'null'
          title: Relevance Score
      type: object
      required:
      - id
      - provision_type
      - full_text
      title: ProvisionResult
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlanningSchemeInfo:
      properties:
        id:
          type: string
          title: Id
        lga:
          type: string
          title: Lga
        scheme_name:
          type: string
          title: Scheme Name
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
        effective_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Effective Date
        source_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Url
        total_provisions:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Provisions
        assessment_entries:
          type: integer
          title: Assessment Entries
          default: 0
        use_table_entries:
          type: integer
          title: Use Table Entries
          default: 0
        charges_entries:
          type: integer
          title: Charges Entries
          default: 0
      type: object
      required:
      - id
      - lga
      - scheme_name
      title: PlanningSchemeInfo
    ProvisionSearchResponse:
      properties:
        query:
          type: string
          title: Query
        lga:
          type: string
          title: Lga
        results:
          items:
            $ref: '#/components/schemas/ProvisionResult'
          type: array
          title: Results
          default: []
        total:
          type: integer
          title: Total
          default: 0
      type: object
      required:
      - query
      - lga
      title: ProvisionSearchResponse
    ComparableCharges:
      properties:
        median:
          anyOf:
          - type: number
          - type: 'null'
          title: Median
        avg:
          anyOf:
          - type: number
          - type: 'null'
          title: Avg
        min:
          anyOf:
          - type: number
          - type: 'null'
          title: Min
        max:
          anyOf:
          - type: number
          - type: 'null'
          title: Max
        sample_size:
          type: integer
          title: Sample Size
          default: 0
      type: object
      title: ComparableCharges
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key