{ "openapi": "3.0.1", "info": { "title": "US Building Permits Scraper - 10 Cities, One Schema", "description": "Scrape US building permits from 10 city open-data portals into one clean schema. Contractor and applicant leads with address, valuation, and dates. Filter and export to CSV.", "version": "1.0", "x-build-id": "TfbefBdtPqGAk1cbN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maydit~us-building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maydit-us-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/maydit~us-building-permits-scraper/runs": { "post": { "operationId": "runs-sync-maydit-us-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/maydit~us-building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-maydit-us-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 cities to scrape. Leave empty to scrape all supported cities.", "items": { "type": "string", "enum": [ "chicago", "san_francisco", "new_york", "austin", "seattle", "los_angeles", "baton_rouge", "cincinnati", "mesa", "marin_county" ], "enumTitles": [ "Chicago, IL", "San Francisco, CA", "New York, NY", "Austin, TX", "Seattle, WA", "Los Angeles, CA", "Baton Rouge, LA", "Cincinnati, OH", "Mesa, AZ", "Marin County, CA" ] }, "default": [ "chicago", "san_francisco", "new_york", "austin", "seattle", "los_angeles", "baton_rouge", "cincinnati", "mesa", "marin_county" ] }, "issuedSince": { "title": "Issued since", "type": "string", "description": "Only permits issued on or after this date (YYYY-MM-DD). Use this for recurring/monitoring runs, e.g. last 7 days." }, "issuedUntil": { "title": "Issued until", "type": "string", "description": "Only permits issued on or before this date (YYYY-MM-DD)." }, "permitTypeKeywords": { "title": "Permit type keywords", "type": "array", "description": "Only keep permits whose type/description/class contains one of these keywords (case-insensitive). E.g. 'solar', 'roof', 'pool', 'demolition'. Leave empty for all.", "default": [], "items": { "type": "string" } }, "minValuation": { "title": "Minimum job valuation (USD)", "type": "integer", "description": "Only keep permits with a reported job valuation at or above this amount. Applied server-side for cities that publish valuation (Chicago, San Francisco, Austin, Seattle). New York does not publish job cost." }, "onlyWithContractor": { "title": "Only permits with a contractor name", "type": "boolean", "description": "Keep only records that include a contractor/company name (best for lead generation). Note: San Francisco does not publish contractor names.", "default": false }, "maxResultsPerCity": { "title": "Max results per city", "minimum": 1, "type": "integer", "description": "Upper bound on permits returned per city per run.", "default": 1000 }, "includeRaw": { "title": "Include raw source record", "type": "boolean", "description": "Attach the full original source record to each result under 'raw'. Increases output size.", "default": false }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional Socrata app token to raise API rate limits on large runs. Free to obtain from any Socrata portal. Not required for normal use." } } }, "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 } } } } } } } } } }