{ "openapi": "3.0.1", "info": { "title": "Building Permits Feed - Construction Leads (7 US Cities)", "description": "Daily feed of newly issued building permits from Chicago, NYC, Los Angeles, Austin, Seattle, New Orleans and Baton Rouge. Job value, address, owner and contractor in one schema. Filter by value and keywords; returns only permits you haven't seen.", "version": "0.0", "x-build-id": "WrbtB11DMFkSi1PTt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/real_mccoy~building-permits-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-real_mccoy-building-permits-feed", "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/real_mccoy~building-permits-feed/runs": { "post": { "operationId": "runs-sync-real_mccoy-building-permits-feed", "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/real_mccoy~building-permits-feed/run-sync": { "post": { "operationId": "run-sync-real_mccoy-building-permits-feed", "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", "type": "array", "description": "Leave empty for all 7 cities.", "items": { "type": "string", "enum": [ "Chicago", "New York City", "Los Angeles", "Austin", "Seattle", "New Orleans", "Baton Rouge" ] } }, "issuedWithinDays": { "title": "Issued within the last N days", "minimum": 1, "maximum": 90, "type": "integer", "description": "How far back to look (1-90). Some cities publish with a 1-3 day delay.", "default": 7 }, "minValue": { "title": "Minimum estimated value ($)", "minimum": 0, "type": "integer", "description": "Only permits with a reported job value at or above this amount. 0 = no minimum.", "default": 0 }, "keywords": { "title": "Keywords (any)", "type": "array", "description": "Keep permits whose description or type contains any of these, e.g. roof, solar, pool, HVAC, demolition, new construction.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop permits whose description or type contains any of these.", "items": { "type": "string" } }, "permitTypes": { "title": "Permit type contains", "type": "array", "description": "Optional: match on permit type / work class text, e.g. Electrical, Plumbing, New Building.", "items": { "type": "string" } }, "onlyWithContractor": { "title": "Only permits with a named contractor", "type": "boolean", "description": "Skip permits where the city did not publish a contractor name.", "default": false }, "onlyNew": { "title": "Only permits I haven't received before", "type": "boolean", "description": "Remembers permits returned on earlier runs (per monitor name) so a daily schedule gives you only fresh leads.", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Use a different name for each saved search so their memories stay separate.", "default": "default" }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Maximum permits to return (and be charged for) per run.", "default": 200 } } }, "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 } } } } } } } } } }