{ "openapi": "3.0.1", "info": { "title": "Building Permits for 8 Canadian and US Cities", "description": "Daily-refreshed building permits from eight official city open-data portals in one schema. Personal names removed. Includes a new-since-date mode for alert feeds.", "version": "0.1", "x-build-id": "6ozp5b7l3nXN8kXgE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/openpermits~building-permits-canada-us/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-openpermits-building-permits-canada-us", "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/openpermits~building-permits-canada-us/runs": { "post": { "operationId": "runs-sync-openpermits-building-permits-canada-us", "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/openpermits~building-permits-canada-us/run-sync": { "post": { "operationId": "run-sync-openpermits-building-permits-canada-us", "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": "Cities to read. Choose from calgary, edmonton, san_jose, seattle, toronto, vancouver, washington_dc, minneapolis.", "items": { "type": "string", "enum": [ "calgary", "edmonton", "san_jose", "seattle", "toronto", "vancouver", "washington_dc", "minneapolis" ], "enumTitles": [ "Calgary", "Edmonton", "San Jose", "Seattle", "Toronto", "Vancouver", "Washington DC", "Minneapolis" ] }, "default": [ "calgary" ] }, "issuedFrom": { "title": "Issued or applied on or after", "type": "string", "description": "Earliest permit date (issued date, or applied date when not yet issued), as YYYY-MM-DD. Default: the last 30 days. Ignored when 'Changed or added since' is set." }, "issuedTo": { "title": "Issued or applied on or before", "type": "string", "description": "Latest permit date, as YYYY-MM-DD. Optional." }, "sinceDate": { "title": "Changed or added since (alert mode)", "type": "string", "description": "Return only permits added to the data, or changed, on or after this date (YYYY-MM-DD). Schedule the Actor daily with yesterday's date to get an alert feed. Retained history is up to 365 days." }, "minDeclaredValue": { "title": "Minimum declared project value", "minimum": 0, "type": "integer", "description": "Only permits with a declared value at or above this amount, in the city's currency." }, "contractorPresent": { "title": "Contractor present", "type": "boolean", "description": "Only permits that show a contractor business name. Names that could belong to a person are withheld from every record, so a permit whose contractor is a person counts as having none. Some cities publish no contractor at all (see the coverage table).", "default": false }, "textContains": { "title": "Text contains", "type": "string", "description": "Keep permits whose permit type, work type, work tag or business name contains this text (case-insensitive), for example 'solar' or 'demolition'." }, "maxResults": { "title": "Maximum records", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many records. Free plan: at most 100 per run, whatever you enter.", "default": 10 } } }, "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 } } } } } } } } } }