{ "openapi": "3.0.1", "info": { "title": "🏗️ NYC Building Permits ✅ $1.50/1K Records", "description": "Search recent NYC DOB NOW construction permits by borough, estimated cost, work keywords and use clues. Export structured project data with service tags and explainable review priorities.", "version": "0.1", "x-build-id": "pDapex0UjJr3AyINa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/peaceful_volute~construction-permit-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-peaceful_volute-construction-permit-leads", "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/peaceful_volute~construction-permit-leads/runs": { "post": { "operationId": "runs-sync-peaceful_volute-construction-permit-leads", "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/peaceful_volute~construction-permit-leads/run-sync": { "post": { "operationId": "run-sync-peaceful_volute-construction-permit-leads", "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": { "daysBack": { "title": "Days to look back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Find permits issued from midnight in New York this many days ago through the end of today. Source updates may lag issuance.", "default": 30 }, "boroughs": { "title": "NYC boroughs", "maxItems": 50, "type": "array", "description": "Optional borough names: Bronx, Brooklyn, Manhattan, Queens, Staten Island. Leave empty for all five. Case does not matter.", "items": { "type": "string" }, "default": [] }, "minEstimatedCost": { "title": "Minimum estimated project cost (USD)", "minimum": 0, "maximum": 1000000000000000, "type": "number", "description": "Keep filings with an estimated job cost at least this amount. This is a project estimate, not an available contract or remaining budget. Missing costs are excluded.", "default": 100000 }, "keywords": { "title": "Work description keywords", "maxItems": 50, "type": "array", "description": "Optional words or phrases to find in the work description or work type. A permit matches if ANY term appears, ignoring case. Leave empty for all work.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Maximum permits to return", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop after saving this many distinct permit records (1–500). Related disciplines may belong to one project. Fewer records may match your filters or page limit.", "default": 100 }, "maxPages": { "title": "Search page limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Limit how far to search: 1–100 pages, up to 100 source rows per page (or Maximum permits, if lower). Filtering can produce fewer results. Retries may make additional requests.", "default": 10 }, "usageHint": { "title": "Suggested use of the work area", "enum": [ "all", "commercial", "residential", "unknown" ], "type": "string", "description": "Optional clue from the work description, not verified legal occupancy. Commercial, residential and unknown match only that exact clue. Unknown is never commercial. All also includes mixed/ambiguous work and conversions to residential use. Applied after retrieval, so restrictive filters may hit the search page limit.", "default": "all" } } }, "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 } } } } } } } } } }