{ "openapi": "3.0.1", "info": { "title": "MD Baltimore City Building Permits", "description": "Baltimore City building & housing permits (~292k, 2019-present, open data): full permit file - scope-of-work, cost, existing/proposed land use, address, neighborhood, district, housing typology, original vs modification. Search by case/keyword/address/cost/date; aggregate by neighborhood/use.", "version": "0.0", "x-build-id": "xSO3UO3uf4zYY1vBP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~md-baltimore-building-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-md-baltimore-building-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~md-baltimore-building-permits/runs": { "post": { "operationId": "runs-sync-j0401-md-baltimore-building-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~md-baltimore-building-permits/run-sync": { "post": { "operationId": "run-sync-j0401-md-baltimore-building-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": { "caseNumber": { "title": "Case number", "type": "string", "description": "Exact permit case number (e.g. BRCM-26-005127, BCCM-25-000001), case-insensitive.", "default": "" }, "keyword": { "title": "Keyword in scope of work", "type": "string", "description": "Search the full scope-of-work text + project name (e.g. 'sprinkler', 'deck', 'roof', 'monument sign'). The permit type lives in this free text.", "default": "" }, "address": { "title": "Street address", "type": "string", "description": "Street address substring (e.g. 'Monroe').", "default": "" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Neighborhood name substring (e.g. 'Canton', 'Fells Point').", "default": "" }, "councilDistrict": { "title": "Council district", "minimum": 0, "type": "integer", "description": "Baltimore City council district 1-14. 0 / blank = all districts.", "default": 0 }, "modification": { "title": "Original or modification", "enum": [ "", "original", "modification" ], "type": "string", "description": "original = new permits (IsPermitModification 0); modification = amendments to existing permits (1). Blank = both.", "default": "" }, "minCost": { "title": "Minimum project cost ($)", "minimum": 0, "type": "integer", "description": "Only permits with recorded project cost >= this amount. Cost is blank on ~32% of permits the city did not value.", "default": 0 }, "maxCost": { "title": "Maximum project cost ($)", "minimum": 0, "type": "integer", "description": "Only permits with recorded project cost <= this amount (0 = no upper bound).", "default": 0 }, "use": { "title": "Land use", "type": "string", "description": "Substring matched against existing or proposed land use (e.g. 'Dwelling', 'Rowhouse', 'Commercial'). Matches the human-readable use names.", "default": "" }, "housingMarketTypology": { "title": "Housing market typology", "enum": [ "", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "NonResidential", "Rental Market 1", "Rental Market 2", "Subsidized Rental Market" ], "type": "string", "description": "Baltimore's housing-market class (2017 typology A-J + rental categories) used in the city's own market analysis.", "default": "" }, "issuedFrom": { "title": "Issued on or after", "type": "string", "description": "Only permits issued on/after this date (YYYY-MM-DD). Register starts 2019-01-01.", "default": "" }, "issuedTo": { "title": "Issued on or before", "type": "string", "description": "Only permits issued on/before this date (YYYY-MM-DD).", "default": "" }, "aggregate": { "title": "Aggregate instead of records", "type": "boolean", "description": "When on, returns one summary record per group (see groupBy) with a count instead of individual permits.", "default": false }, "groupBy": { "title": "Aggregate by", "enum": [ "neighborhood", "councilDistrict", "housingMarketTypology", "existingUse", "proposedUse", "isModification" ], "type": "string", "description": "Which dimension to aggregate over. isModification = original vs modification split.", "default": "neighborhood" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed (0 = up to ~10k per run; each record is metered individually, so there is no per-run charge cap). An aggregate has at most a few hundred groups.", "default": 200 } } }, "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 } } } } } } } } } }