{ "openapi": "3.0.1", "info": { "title": "Philadelphia Building Permits - Contractor & Property Data", "description": "Philadelphia building & trade permits (public open data, 584,800 permits, 2007-today): type, description, approved scope, issue and completion dates, owner of record, full contractor block, address, council district and geocode.", "version": "0.0", "x-build-id": "9y9uGs24pwIwjoZnH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~philly-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-philly-permits", "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/j0401~philly-permits/runs": { "post": { "operationId": "runs-sync-j0401-philly-permits", "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/j0401~philly-permits/run-sync": { "post": { "operationId": "run-sync-j0401-philly-permits", "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": { "status": { "title": "Permit status", "enum": [ "", "Completed", "Expired", "Issued", "ABANDONED", "Cancelled", "Refused", "CLOSED", "Denied", "REVOKED", "Stop Work", "Amendment Application Incomplete", "Amendment Applicant Revisions", "Amendment Ready For Issue", "Amendment Review", "Amendment Requested", "Amendment Denied", "Withdrawn", "In Review" ], "type": "string", "description": "Exact status. 'Completed' 491,228 / 'Expired' 50,163 / 'Issued' 37,875, plus the amendment workflow states. Blank = any.", "default": "" }, "permitType": { "title": "Permit type", "enum": [ "", "PP_PLUMBNG", "EP_ELECTRL", "BP_ALTER", "Plumbing", "Electrical", "BP_MECH", "Zoning", "Residential Building", "ZP_ZON/USE", "Mechanical", "ZP_USE", "General Permit Minor", "BP_FIRESUP", "ZP_ZONING", "BP_ADMINST", "Building", "Fire Suppression", "BP_NEWCNST", "BP_DEMO", "OPS PERMIT", "BP_ADDITON", "General", "BP_SIGN", "L_FFORM", "Demolition", "Administrative", "Site / Utility Permit", "ZP_ADMIN", "Operations", "Master Plan" ], "type": "string", "description": "Exact permit type. Two vocabularies coexist: HANSEN codes (BP_NEWCNST, PP_PLUMBNG, EP_ELECTRL) and ECLIPSE names (Building, Plumbing, Electrical). Filter 'system' too, or you are reading only one system's share. Blank = any.", "default": "" }, "system": { "title": "System of record", "enum": [ "", "HANSEN", "ECLIPSE" ], "type": "string", "description": "Which source system the row came from: 'HANSEN' 364,847 or 'ECLIPSE' 219,953. The two use different permit-type vocabularies. Blank = both.", "default": "" }, "category": { "title": "Commercial or residential", "enum": [ "", "Residential", "Commercial" ], "type": "string", "description": "Commercial / residential split. Blank on 63% of rows and left blank rather than guessed. Blank = any.", "default": "" }, "contractor": { "title": "Contractor name (contains)", "type": "string", "description": "Substring match on the contractor name (present on 78% of permits), e.g. 'BEST'. Blank = any.", "default": "" }, "owner": { "title": "Owner of record (contains)", "type": "string", "description": "Substring match on the assessed owner of record. Blank = any.", "default": "" }, "address": { "title": "Site address (contains)", "type": "string", "description": "Substring match on the site address, e.g. 'MARKET ST'. Blank = any.", "default": "" }, "permitNumber": { "title": "Permit number (contains)", "type": "string", "description": "Substring match on the permit number. Blank = any.", "default": "" }, "description": { "title": "Permit description (contains)", "type": "string", "description": "Substring match on the permit description. Blank = any.", "default": "" }, "councilDistrict": { "title": "Council district", "minimum": 0, "type": "integer", "description": "City council district number (1-10). Blank = any." }, "issuedFrom": { "title": "Issued date from", "type": "string", "description": "Earliest permit issue date, YYYY-MM-DD. Blank = any.", "default": "" }, "issuedTo": { "title": "Issued date to", "type": "string", "description": "Latest permit issue date, YYYY-MM-DD. Blank = any.", "default": "" }, "mode": { "title": "Mode", "enum": [ "rows", "aggregate" ], "type": "string", "description": "rows = permits matching your filters (default). aggregate = one count row per group (see groupBy).", "default": "rows" }, "groupBy": { "title": "Aggregate by", "enum": [ "", "category", "councilDistrict", "issuedYear", "permitType", "status", "system" ], "type": "string", "description": "Which dimension to aggregate over (mode=aggregate). Blank = permitType. Every group is returned - aggregate mode is not cut off by maxResults.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed in rows mode (0 = default 50; up to 2,000 per run). Each record is metered individually, so there is no per-run charge cap. Aggregate mode returns every group.", "default": 50 } } }, "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 } } } } } } } } } }