{ "openapi": "3.0.1", "info": { "title": "New York Building Permits Scraper | Chicago, LA, 12 Cities", "description": "Scrape building permits from 12 US cities in one run at $1.50 per 1,000 permits, cheaper than the leading tools, with a new-or-changed mode and contractor-only filter. NYC, LA, Chicago, Austin and more in one schema: type, address, valuation, status, contractor, phone.", "version": "0.4", "x-build-id": "OcZvF0UYmF3Ljyeud" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aurelix~building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aurelix-building-permits-scraper", "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/aurelix~building-permits-scraper/runs": { "post": { "operationId": "runs-sync-aurelix-building-permits-scraper", "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/aurelix~building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-aurelix-building-permits-scraper", "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": "Which city datasets to read, all building permits issued by the city: 'seattle', 'chicago', 'nyc' (DOB NOW approved work permits), 'los-angeles' (issued since 2020), 'san-francisco', 'austin' (issued construction permits), 'baton-rouge' (East Baton Rouge Parish), 'cincinnati', 'mesa', 'new-orleans', 'norfolk', 'orlando'. Example: ['nyc', 'austin'].", "items": { "type": "string", "enum": [ "seattle", "chicago", "nyc", "los-angeles", "san-francisco", "austin", "baton-rouge", "cincinnati", "mesa", "new-orleans", "norfolk", "orlando" ], "enumTitles": [ "Seattle, WA", "Chicago, IL", "New York City, NY (DOB NOW)", "Los Angeles, CA", "San Francisco, CA", "Austin, TX", "Baton Rouge, LA (East Baton Rouge Parish)", "Cincinnati, OH", "Mesa, AZ", "New Orleans, LA", "Norfolk, VA", "Orlando, FL" ] }, "default": [ "seattle", "chicago", "nyc", "los-angeles", "san-francisco", "austin", "baton-rouge", "cincinnati", "mesa", "new-orleans", "norfolk", "orlando" ] }, "daysBack": { "title": "Issued in the last N days", "minimum": 0, "maximum": 90, "type": "integer", "description": "Keep permits issued on or after today minus this many days (UTC). Example: 1 for a daily feed, 7 for a weekly one. At most 90.", "default": 7 }, "permitTypes": { "title": "Permit types", "type": "array", "description": "Keep permits whose type or subtype contains one of these (case-insensitive), e.g. ['new', 'demolition', 'plumbing', 'alter', 'single family']. Empty = all.", "default": [], "items": { "type": "string" } }, "statuses": { "title": "Statuses", "type": "array", "description": "Keep permits whose status contains one of these (case-insensitive), e.g. ['issued', 'active', 'complete']. Empty = all.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep permits whose description of work or address contains one of these (case-insensitive), e.g. ['solar', 'roof', 'ADU', 'Broadway']. Empty = all.", "default": [], "items": { "type": "string" } }, "minValuation": { "title": "Minimum valuation (USD)", "minimum": 0, "type": "integer", "description": "Keep permits whose declared project value is at least this many US dollars. Permits with no value are dropped when this is above 0. Example: 100000.", "default": 0 }, "contractorOnly": { "title": "Only permits with a contractor company", "type": "boolean", "description": "Keep only permits that name a contractor company (Seattle, Chicago, NYC, Austin, Baton Rouge, Cincinnati, Mesa, New Orleans and Orlando publish one; Los Angeles, San Francisco and Norfolk do not).", "default": false }, "maxResultsPerCity": { "title": "Max results per city", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Upper limit of results per city after filters, newest first. 0 = no limit (at most 50,000 rows are read per city).", "default": 1000 }, "incremental": { "title": "Only new or changed since last run", "type": "boolean", "description": "Return only permits not returned by a previous run with the same cities and filters, plus permits whose status has changed. Use with a daily or weekly schedule.", "default": false }, "stateKey": { "title": "Incremental state name (optional)", "type": "string", "description": "Name for the 'new since last run' memory. Leave empty to derive it from the cities and filters; set it to keep separate feeds apart, e.g. 'nyc-solar'." }, "slackWebhookUrl": { "title": "Slack webhook URL (optional)", "type": "string", "description": "After each run, post a short digest to Slack: how many results were saved (new ones only when 'Only new or changed since last run' is on) and the top 10 with links, e.g. https://hooks.slack.com/services/T000/B000/XXXX. Nothing is posted when the run saved nothing. Leave empty to skip." }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "After each run, POST the same digest as JSON (actor, newOnly, count, items = top 10 results, runUrl, text) to any URL, e.g. a Zapier, Make or n8n webhook. Nothing is sent when the run saved nothing. Leave empty to skip." } } }, "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 } } } } } } } } } }