{ "openapi": "3.0.1", "info": { "title": "Building Permit Lead Monitor: Chicago, NYC, Austin", "description": "Monitor official building-permit datasets in Chicago, New York City, and Austin. Return new, updated, and removed permit signals with project details, valuation, published contacts, and source links. Send results to HubSpot, Airtable, n8n, or Slack.", "version": "1.0", "x-build-id": "ULLshcBewt94fnwt3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~construction-permit-lead-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-construction-permit-lead-monitor", "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/getascraper~construction-permit-lead-monitor/runs": { "post": { "operationId": "runs-sync-getascraper-construction-permit-lead-monitor", "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/getascraper~construction-permit-lead-monitor/run-sync": { "post": { "operationId": "run-sync-getascraper-construction-permit-lead-monitor", "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": { "cities": { "title": "Cities", "minItems": 1, "maxItems": 3, "uniqueItems": true, "type": "array", "description": "Select one or more official public permit datasets: Chicago, New York City, or Austin.", "items": { "type": "string", "enum": [ "chicago", "nyc", "austin" ], "enumTitles": [ "Chicago", "New York City", "Austin" ] }, "default": [ "chicago" ] }, "dateFrom": { "title": "Issue Date From", "type": "string", "description": "Optional ISO date lower bound for the city dataset issue date.", "default": "" }, "dateTo": { "title": "Issue Date To", "type": "string", "description": "Optional ISO date upper bound for the city dataset issue date.", "default": "" }, "permitTypes": { "title": "Permit Types", "maxItems": 20, "type": "array", "description": "Optional source permit type labels. Values are matched against the selected city adapter.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "keywords": { "title": "Description Keyword", "maxLength": 80, "type": "string", "description": "Optional keyword matched against the adapter's public description field.", "default": "" }, "mode": { "title": "Output Mode", "enum": [ "changesOnly", "full" ], "type": "string", "description": "Full returns the current snapshot. Changes only compares a complete city scope with the saved baseline.", "default": "changesOnly" }, "pageSize": { "title": "Records Per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Rows requested from each Socrata page, plus one probe row to detect a cap.", "default": 15 }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum pages requested per city. A capped scan cannot update comparison state.", "default": 1 }, "maxRecords": { "title": "Maximum Records Returned", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum rows written across the selected cities.", "default": 15 } } }, "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 } } }, "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 } } } } } } } } } }