{ "openapi": "3.0.1", "info": { "title": "Building Permit Address Lookup - Open & Expired Permit Check", "description": "Check an address in 10 supported US cities for building permits: permit history, open permits, and permits issued but never finaled. One verdict row per address. No homeowner personal data.", "version": "1.0", "x-build-id": "I1763oNGmHHv9j5fF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maydit~building-permit-address-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maydit-building-permit-address-lookup", "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/maydit~building-permit-address-lookup/runs": { "post": { "operationId": "runs-sync-maydit-building-permit-address-lookup", "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/maydit~building-permit-address-lookup/run-sync": { "post": { "operationId": "run-sync-maydit-building-permit-address-lookup", "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": { "city": { "title": "City portal", "enum": [ "austin", "seattle", "cincinnati", "new_york", "chicago", "san_francisco", "los_angeles", "mesa", "baton_rouge", "marin_county" ], "type": "string", "description": "Which municipal permit portal to query. One city per run - addresses from another city will not match. The label states what each portal supports: only some publish the expiration and final-inspection data needed to flag an expired-but-open permit.", "default": "austin" }, "addresses": { "title": "Addresses to check", "type": "array", "description": "One street address per line in the selected city. A house number is required; unit, city, state and ZIP are optional and ignored when matching. A successful lookup produces one saved address-verdict row; failed lookups are reported instead. The Console prefills three Austin examples. Empty addresses use that sample only when Austin is selected; other cities require your own addresses.", "items": { "type": "string" } }, "lookbackYears": { "title": "Permit history lookback (years)", "minimum": 1, "maximum": 60, "type": "integer", "description": "How far back to search permit history from today. 10 years covers most disclosure and underwriting needs; raise it for a full property history, lower it to speed up a large address list.", "default": 10 }, "maxPermitsPerAddress": { "title": "Maximum permits fetched per address", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper bound on permits fetched per address before matching, newest first. The default of 100 covers any normal parcel; large commercial sites can hold several hundred permits, so raise it if you are checking one. When an address hits this cap its row says so (permitCapReached: true, and the summary reads \"at least N\"), because older permits were not fetched.", "default": 100 }, "maxRunSeconds": { "title": "Run time budget (seconds)", "minimum": 30, "type": "integer", "description": "Stop cleanly after this many seconds and keep whatever has already been written, rather than being killed mid-run. Raise it for long address lists - roughly 1-2 seconds per address.", "default": 240 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional Socrata app token to raise the open-data rate limit on long address lists. Free to obtain from any Socrata portal. Not required for normal use." } } }, "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 } } } } } } } } } }