{
"openapi": "3.0.1",
"info": {
"title": "US Accela Building Permit Grid",
"description": "Scrape public Accela Citizen Access building permit grids — property address, permit type, status, and dates. Unofficial — not affiliated with Accela.",
"version": "0.1",
"x-build-id": "TqwdJoR2eBZ7eE4md"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/bakos_bence~accela-permits/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-bakos_bence-accela-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/bakos_bence~accela-permits/runs": {
"post": {
"operationId": "runs-sync-bakos_bence-accela-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/bakos_bence~accela-permits/run-sync": {
"post": {
"operationId": "run-sync-bakos_bence-accela-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": {
"tenants": {
"title": "Accela tenant codes",
"type": "array",
"description": "One code per portal — the first path segment on https://aca-prod.accela.com/{code}/ (not the city name). Salt Lake City is SLCREF. Pick a suggestion or paste the code from your agency’s ACA link. Examples: SLCREF, COSP, OAKLAND, alameda, SANTACLARA.",
"items": {
"type": "string"
},
"default": [
"SLCREF"
]
},
"module": {
"title": "Permit module",
"type": "string",
"description": "ACA module name — almost always Building for residential/commercial permits.",
"default": "Building"
},
"daysBack": {
"title": "Days to look back",
"type": "integer",
"description": "When Start/End dates are empty, search from today back this many days. Quiet portals auto-widen to 90 then 365.",
"default": 90
},
"startDate": {
"title": "Start date (optional)",
"type": "string",
"description": "First day of the search window. In Console, use the date picker (stores YYYY-MM-DD). API/JSON may also send MM/DD/YYYY."
},
"endDate": {
"title": "End date (optional)",
"type": "string",
"description": "Last day of the search window (picker → YYYY-MM-DD). Leave empty with Start empty to use “days back” instead."
},
"streetName": {
"title": "Street contains (optional)",
"type": "string",
"description": "Keep permits whose street line includes this text (e.g. MAIN)."
},
"zipCode": {
"title": "ZIP code (optional)",
"type": "string",
"description": "Keep permits in this ZIP only."
},
"maxItems": {
"title": "Max permit rows",
"type": "integer",
"description": "Hard cap across all tenants. Prefill 5 keeps the first run cheap; raise for exports.",
"default": 5
},
"maxPermits": {
"title": "Max permits (paxiq alias)",
"minimum": 0,
"type": "integer",
"description": "Same cap as Max permit rows — for paxiq migration when you send maxPermits without maxItems.",
"default": 5
},
"keyword": {
"title": "Keyword (paxiq alias)",
"type": "string",
"description": "Maps to street filter when Street contains is empty."
},
"city": {
"title": "City (paxiq alias)",
"type": "string",
"description": "Accepted for paxiq scripts; Accela still needs tenant codes above."
},
"state": {
"title": "State (paxiq alias)",
"type": "string",
"description": "Accepted for paxiq compatibility. Use with tenant codes."
},
"cities": {
"title": "Cities batch (paxiq alias)",
"type": "array",
"description": "Accepted for paxiq compatibility. Prefer tenant codes in the list above."
},
"proxyConfiguration": {
"title": "Apify Proxy Configuration",
"type": "object",
"description": "Managed by the Actor; leave default. Direct curl_cffi — Residential/Unblocker are not used.",
"default": {
"useApifyProxy": false
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}