{
  "openapi": "3.0.1",
  "info": {
    "title": "Victoria Building Permits (Australia) - Data & Suburb Trends",
    "description": "Every building permit issued in Victoria, Australia: cost, work type, building class, suburb, council and builder location. Filter or get suburb trends. Official open data (CC BY 4.0).",
    "version": "1.0",
    "x-build-id": "fgotLOIdBmba3xTeT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/mollydancer~victoria-building-permits/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-mollydancer-victoria-building-permits",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/mollydancer~victoria-building-permits/runs": {
      "post": {
        "operationId": "runs-sync-mollydancer-victoria-building-permits",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/mollydancer~victoria-building-permits/run-sync": {
      "post": {
        "operationId": "run-sync-mollydancer-victoria-building-permits",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "outputMode": {
            "title": "What do you want back?",
            "enum": [
              "permits",
              "summary"
            ],
            "type": "string",
            "description": "Individual permits (one row per permit), or a summary (one row per suburb, council, month, etc.) with counts and total value.",
            "default": "permits"
          },
          "summaryGroupBy": {
            "title": "Summarise by",
            "enum": [
              "suburb",
              "postcode",
              "council",
              "month",
              "workType",
              "buildingClass",
              "buildingUse",
              "builderSuburb"
            ],
            "type": "string",
            "description": "Only used when 'Summary / trends' is selected.",
            "default": "suburb"
          },
          "councils": {
            "title": "Councils",
            "type": "array",
            "description": "Council (municipality) names, e.g. Wyndham, Casey, Melbourne, Greater Geelong. Leave empty for all of Victoria.",
            "items": {
              "type": "string"
            }
          },
          "suburbs": {
            "title": "Suburbs",
            "type": "array",
            "description": "Suburb names, e.g. Werribee, Point Cook, Tarneit.",
            "items": {
              "type": "string"
            }
          },
          "postcodes": {
            "title": "Postcodes",
            "type": "array",
            "description": "4-digit postcodes, e.g. 3030.",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "Region or sub-region names, e.g. Metropolitan, Rural, Outer Melbourne, Inner Melbourne, Gippsland, Western, South Eastern.",
            "items": {
              "type": "string"
            }
          },
          "streetContains": {
            "title": "Street name contains",
            "type": "string",
            "description": "Optional text to match in the street name, e.g. 'Hoppers'."
          },
          "workTypes": {
            "title": "Work types",
            "type": "array",
            "description": "Leave empty for all work types.",
            "items": {
              "type": "string",
              "enum": [
                "New building",
                "Extension",
                "Alteration",
                "Demolition",
                "Change of use",
                "Re-erection",
                "Removal",
                "Other"
              ]
            }
          },
          "buildingUses": {
            "title": "Building uses",
            "type": "array",
            "description": "What the building is used for. Leave empty for all uses.",
            "items": {
              "type": "string",
              "enum": [
                "Domestic",
                "Residential",
                "Commercial",
                "Retail",
                "Industrial",
                "Public Buildings",
                "Hospital/Healthcare"
              ]
            }
          },
          "buildingClasses": {
            "title": "Building classes",
            "type": "array",
            "description": "National Construction Code building class. 1a = houses/townhouses, 2 = apartments, 10a = sheds/garages/carports, 10b = pools/fences/decks.",
            "items": {
              "type": "string",
              "enum": [
                "1a",
                "1b",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7a",
                "7b",
                "8",
                "9a",
                "9b",
                "9c",
                "10a",
                "10b",
                "10c"
              ],
              "enumTitles": [
                "1a – House / townhouse",
                "1b – Small boarding house",
                "2 – Apartments",
                "3 – Hotel / motel / residential care",
                "4 – Dwelling in non-residential building",
                "5 – Office",
                "6 – Shop / retail / cafe",
                "7a – Car park",
                "7b – Warehouse / storage",
                "8 – Factory / lab",
                "9a – Health care",
                "9b – School / church / hall / venue",
                "9c – Aged care",
                "10a – Shed / garage / carport",
                "10b – Pool / fence / deck / retaining wall",
                "10c – Bushfire shelter"
              ]
            }
          },
          "ownershipSectors": {
            "title": "Ownership sector",
            "type": "array",
            "description": "Who owns the project. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "Private",
                "Local government",
                "State government",
                "Commonwealth government"
              ]
            }
          },
          "minNewDwellings": {
            "title": "Minimum new dwellings",
            "minimum": 0,
            "type": "integer",
            "description": "e.g. 2 to find multi-unit developments."
          },
          "solarHotWater": {
            "title": "Solar hot water installed",
            "type": "boolean",
            "description": "Tick to keep only permits reporting solar hot water. Leave unset for all."
          },
          "rainwaterTank": {
            "title": "Rainwater tank installed",
            "type": "boolean",
            "description": "Tick to keep only permits reporting a rainwater tank. Leave unset for all."
          },
          "minCost": {
            "title": "Minimum cost of works (AUD)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include permits with at least this cost of works, in Australian dollars."
          },
          "maxCost": {
            "title": "Maximum cost of works (AUD)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include permits with at most this cost of works, in Australian dollars."
          },
          "dateFrom": {
            "title": "Permit issued from",
            "type": "string",
            "description": "YYYY-MM-DD"
          },
          "dateTo": {
            "title": "Permit issued to",
            "type": "string",
            "description": "YYYY-MM-DD (inclusive)"
          },
          "sortBy": {
            "title": "Sort permits by",
            "enum": [
              "permitDateDesc",
              "permitDateAsc",
              "costDesc",
              "costAsc"
            ],
            "type": "string",
            "description": "Order of the permit rows. Ignored in summary mode.",
            "default": "permitDateDesc"
          },
          "maxResults": {
            "title": "Maximum rows",
            "minimum": 1,
            "maximum": 200000,
            "type": "integer",
            "description": "Stop after this many rows. You are charged per row returned.",
            "default": 1000
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}