{ "openapi": "3.0.1", "info": { "title": "Detroit BSEED Permits, Inspections & Blight Tickets", "description": "Fifteen Detroit BSEED datasets in one actor: permits, inspections, rental registrations, compliance certificates, business licences and 909k blight tickets. Filter by date, ZIP, council district, parcel, address, type or status; aggregate by the same dimensions.", "version": "0.0", "x-build-id": "CMoAx2FY2AK8vhXbR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~detroit-bseed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-detroit-bseed", "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~detroit-bseed/runs": { "post": { "operationId": "runs-sync-j0401-detroit-bseed", "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~detroit-bseed/run-sync": { "post": { "operationId": "run-sync-j0401-detroit-bseed", "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": { "corpus": { "title": "Dataset", "enum": [ "trades-permits", "building-permits", "rental-registrations", "demolition-inspections", "plan-reviews", "demolition-permits", "vacant-property", "occupancy-certificates", "presale-inspections", "residential-compliance", "commercial-compliance", "commercial-certs", "rental-compliance", "business-licenses", "blight-tickets" ], "type": "string", "description": "Which BSEED layer to read. Each has its own date field, filters and record shape.", "default": "trades-permits" }, "mode": { "title": "Mode", "enum": [ "", "search", "aggregate" ], "type": "string", "description": "search = matching records. aggregate = one row per group. Leave blank: aggregate when groupBy is set, otherwise search." }, "groupBy": { "title": "Group by (aggregate)", "enum": [ "", "zip", "councilDistrict", "neighborhood", "type", "status", "parcelId" ], "type": "string", "description": "Dimension for mode=aggregate. Defaults to zip." }, "maxResults": { "title": "Max records", "type": "integer", "description": "Records to deliver in search mode (default 50, max 25000).", "default": 50 }, "dateFrom": { "title": "Date from", "type": "string", "description": "Start of the record's own date field, YYYY-MM-DD (issued / inspection / submitted / expiration, depending on the dataset)." }, "dateTo": { "title": "Date to", "type": "string", "description": "End date, YYYY-MM-DD." }, "zip": { "title": "ZIP code", "type": "string", "description": "Five-digit Detroit ZIP, e.g. \"48207\"." }, "councilDistrict": { "title": "Council district", "type": "string", "description": "Detroit council district, e.g. \"5\"." }, "neighborhood": { "title": "Neighbourhood", "type": "string", "description": "Detroit neighbourhood name." }, "parcelId": { "title": "Parcel ID", "type": "string", "description": "Detroit parcel number." }, "address": { "title": "Address contains", "type": "string", "description": "Case-insensitive substring of the property address, e.g. \"Woodward\"." }, "type": { "title": "Type", "type": "string", "description": "Permit / registration / inspection / licence type or plan-review task. Exact match; not every dataset has a type." }, "status": { "title": "Status / result", "type": "string", "description": "Inspection result, plan-review status, compliance indicator or ticket disposition. Exact match; not every dataset has a status." } } }, "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 } } } } } } } } } }