{ "openapi": "3.0.1", "info": { "title": "Boston Permits Scraper", "version": "1.0", "x-build-id": "QojJL7YrEUTQ2qvqh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fortuitous_pirate~boston-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fortuitous_pirate-boston-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/fortuitous_pirate~boston-permits-scraper/runs": { "post": { "operationId": "runs-sync-fortuitous_pirate-boston-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/fortuitous_pirate~boston-permits-scraper/run-sync": { "post": { "operationId": "run-sync-fortuitous_pirate-boston-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": { "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of permits to scrape. Set to 0 for unlimited.", "default": 100 }, "permitType": { "title": "Permit Type", "type": "string", "description": "Filter by permit type description (e.g., 'Long Form/Alteration', 'Short Form Bldg Permit', 'Amendment to a Long Form')" }, "workType": { "title": "Work Type", "type": "string", "description": "Filter by work type code (e.g., 'INTEXT' for Interior/Exterior, 'COB' for City of Boston, 'ERECT' for Erection)" }, "status": { "title": "Status", "type": "string", "description": "Filter by permit status (e.g., 'Open', 'Closed')" }, "dateFrom": { "title": "Date From", "type": "string", "description": "Filter permits issued on or after this date (YYYY-MM-DD format)" }, "dateTo": { "title": "Date To", "type": "string", "description": "Filter permits issued on or before this date (YYYY-MM-DD format)" }, "address": { "title": "Address Search", "type": "string", "description": "Search for permits containing this text in the address field" }, "city": { "title": "City", "type": "string", "description": "Filter by city (e.g., 'Boston', 'Dorchester', 'West Roxbury')" }, "zip": { "title": "ZIP Code", "type": "string", "description": "Filter by ZIP code (e.g., '02109')" }, "ward": { "title": "Ward", "minimum": 1, "maximum": 22, "type": "integer", "description": "Filter by ward number (1-22)" }, "minCost": { "title": "Minimum Cost", "minimum": 0, "type": "integer", "description": "Filter permits with declared valuation at or above this amount (in dollars)" }, "maxCost": { "title": "Maximum Cost", "minimum": 0, "type": "integer", "description": "Filter permits with declared valuation at or below this amount (in dollars)" }, "occupancyType": { "title": "Occupancy Type", "type": "string", "description": "Filter by occupancy type (e.g., 'Res' for Residential, 'Comm' for Commercial, 'Mixed')" }, "minSqFeet": { "title": "Minimum Square Feet", "minimum": 0, "type": "integer", "description": "Filter permits for projects at or above this square footage" }, "sortBy": { "title": "Sort By", "enum": [ "issued_date", "expiration_date", "declared_valuation", "permitnumber", "address", "sq_feet" ], "type": "string", "description": "Field to sort results by", "default": "issued_date" }, "sortOrder": { "title": "Sort Order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sort direction", "default": "desc" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the scraper. Usually not needed for this public API." } } }, "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 } } } } } } } } } }