{ "openapi": "3.0.1", "info": { "title": "Us Municipal Building Permits Accela Scraper", "description": "Search public Accela Citizen Access permits by agency, date and keyword. Extract permit status, project addresses, disclosed job values and contractor details. Export construction records for project monitoring, market research and prospecting.", "version": "0.0", "x-build-id": "AeVhMO9X6EsiczmNf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arezdev~us-municipal-building-permits-accela-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arezdev-us-municipal-building-permits-accela-scraper", "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/arezdev~us-municipal-building-permits-accela-scraper/runs": { "post": { "operationId": "runs-sync-arezdev-us-municipal-building-permits-accela-scraper", "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/arezdev~us-municipal-building-permits-accela-scraper/run-sync": { "post": { "operationId": "run-sync-arezdev-us-municipal-building-permits-accela-scraper", "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": { "agencyCode": { "title": "Agency", "enum": [ "SANJOSE", "ATLANTA_GA", "TAMPA", "DENVER", "CLEVELAND", "SACRAMENTO", "OAKLAND", "SANANTONIO", "CUSTOM" ], "type": "string", "description": "Agency portal preset. San Antonio maps to COSA. Availability can change; use CUSTOM for a current official Accela portal. The legacy San Jose preset may be unavailable.", "default": "SANANTONIO" }, "customAccelaPortalUrl": { "title": "Custom Accela portal URL", "type": "string", "description": "Required for CUSTOM. Agency base URL or full Cap/CapHome.aspx URL. Public HTTP/HTTPS URLs without credentials only." }, "moduleName": { "title": "Module", "enum": [ "Building", "Permits", "Planning" ], "type": "string", "description": "Search module enabled by the selected agency.", "default": "Building" }, "startDate": { "title": "Filed on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive start date in YYYY-MM-DD format.", "default": "2026-09-01" }, "endDate": { "title": "Filed on or before", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive end date in YYYY-MM-DD format. Must not precede the start date.", "default": "2026-09-05" }, "keywordFilter": { "title": "Keyword filter", "maxLength": 256, "type": "string", "description": "Optional case-insensitive literal substring matched against listing number, type, status, address, and description. Examples: solar, roofing, HVAC." }, "fetchContractorDetails": { "title": "Fetch contractor details and job value", "type": "boolean", "description": "Open matching detail pages for public contractor, applicant, and valuation fields. Missing public fields remain null.", "default": true }, "maxItems": { "title": "Maximum saved records", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum combined SUCCESS and ERROR rows. Free Apify users are limited to 25 saved rows per run.", "default": 25 }, "timeoutSecs": { "title": "Request timeout in seconds", "minimum": 5, "maximum": 60, "type": "integer", "description": "Timeout per HTTP attempt. Redirects and permitted fallbacks can require additional attempts.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Direct first, then datacenter on HTTP 403/429/503. Explicitly enable Apify Proxy for a configured final tier, including residential groups. Set useApifyProxy to false for direct-only access. Custom proxy URLs are exclusive." } } }, "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 } } } } } } } } } }