{ "openapi": "3.0.1", "info": { "title": "Building Permit Lead Monitor for Contractors", "description": "Turn new building permits into contractor and supplier sales leads. Pulls the most-recent issued permits from NYC DOB open data or any Socrata civic portal: address, work type, job description, estimated cost, applicant business, and owner. Zero-config default run. Public data, no login.", "version": "0.1", "x-build-id": "cArhlSD9N2lmjgm8g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lavender_whistle~building-permits-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lavender_whistle-building-permits-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/lavender_whistle~building-permits-monitor/runs": { "post": { "operationId": "runs-sync-lavender_whistle-building-permits-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/lavender_whistle~building-permits-monitor/run-sync": { "post": { "operationId": "run-sync-lavender_whistle-building-permits-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": { "datasetUrl": { "title": "Socrata dataset URL", "type": "string", "description": "The Socrata (SODA) resource endpoint ending in .json. Default is NYC DOB NOW Approved Permits. Point it at any city's building-permit dataset (e.g. Chicago, LA, Austin) to reuse this actor.", "default": "https://data.cityofnewyork.us/resource/rbx6-tga4.json" }, "dateField": { "title": "Recency date field", "type": "string", "description": "The dataset column used to sort by newest first and to apply the lookback window. Default issued_date (NYC DOB NOW). Use issuance_date for the legacy NYC DOB dataset, or the target portal's own permit-date column.", "default": "issued_date" }, "borough": { "title": "Borough (NYC only)", "enum": [ "", "Manhattan", "Bronx", "Brooklyn", "Queens", "Staten Island" ], "type": "string", "description": "Optional NYC borough filter. Leave blank for all boroughs. Ignored on non-NYC datasets that have no borough column.", "default": "" }, "workType": { "title": "Work type contains", "type": "string", "description": "Optional case-insensitive filter on the work_type column, e.g. Solar, Plumbing, General Construction, Boiler. Leave blank for all permit types.", "default": "" }, "minJobCost": { "title": "Minimum estimated job cost (USD)", "minimum": 0, "type": "integer", "description": "Only return permits whose estimated job cost is at least this amount, to focus on larger, higher-value leads. 0 disables the filter.", "default": 0 }, "lookbackDays": { "title": "Lookback (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only return permits dated within this many days of today, using the recency date field. 0 disables the window and returns the newest permits regardless of age (safest for a guaranteed result).", "default": 0 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of permit lead rows to return per run.", "default": 25 } } }, "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 } } } } } } } } } }