{ "openapi": "3.0.1", "info": { "title": "CA San Francisco Building Permits", "description": "San Francisco building permits (public open data, 1.3M records) - the city's full permit file with engineering depth (cost, use, units, ADU, occupancy, status, dates, neighborhood). Filter by type/status/ADU/address or pull the daily change stream.", "version": "0.0", "x-build-id": "h6epVg6dcaAUaryVh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~ca-sf-permits/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-ca-sf-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~ca-sf-permits/runs": { "post": { "operationId": "runs-sync-j0401-ca-sf-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~ca-sf-permits/run-sync": { "post": { "operationId": "run-sync-j0401-ca-sf-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": { "mode": { "title": "Mode", "enum": [ "rows", "delta", "aggregate" ], "type": "string", "description": "rows = permits matching your filters (default). delta = the daily change stream: permits the SF permit office touched since `changedSince`. aggregate = one count row per group (see groupBy).", "default": "rows" }, "permitType": { "title": "Permit type", "type": "string", "description": "Permit type (fuzzy, matches the type name): new construction, additions alterations or repairs, OTC alterations, demolitions, sign, grade. Blank = any.", "default": "" }, "status": { "title": "Status", "type": "string", "description": "Permit status. Use a source value: complete, issued, expired, cancelled, filed, withdrawn, approved, revoked, denied, ... Blank = any. Most permits end 'complete'; live work is 'issued' / 'filed' / 'plancheck'.", "default": "" }, "aduOnly": { "title": "ADU permits only", "type": "boolean", "description": "When on, returns only accessory-dwelling-unit (ADU) permits.", "default": false }, "address": { "title": "Address", "type": "string", "description": "Street number or street name, e.g. 'Market' or '1200'. Matches the permit's street line.", "default": "" }, "streetName": { "title": "Street name", "type": "string", "description": "Street name only (matches the street field exactly-ish).", "default": "" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Analysis neighborhood substring, e.g. 'Mission', 'Sunset', 'Marina'.", "default": "" }, "supervisorDistrict": { "title": "Supervisor district", "type": "string", "description": "SF supervisor district number (1-11).", "default": "" }, "zipcode": { "title": "ZIP code", "type": "string", "description": "Permit ZIP code.", "default": "" }, "issuedFrom": { "title": "Issued on or after", "type": "string", "description": "Only permits issued on/after this date (YYYY-MM-DD).", "default": "" }, "issuedTo": { "title": "Issued before", "type": "string", "description": "Only permits issued before this date (YYYY-MM-DD).", "default": "" }, "createdFrom": { "title": "Created on or after", "type": "string", "description": "Only permits created on/after this date.", "default": "" }, "createdTo": { "title": "Created before", "type": "string", "description": "Only permits created before this date.", "default": "" }, "changedSince": { "title": "Changed since", "type": "string", "description": "Only rows the daily refresh touched on/after this date (YYYY-MM-DD). Use with mode=delta for the change stream; blank in delta mode = last 24h.", "default": "" }, "groupBy": { "title": "Aggregate by", "enum": [ "status", "permitTypeDescription", "permitType", "neighborhood", "supervisorDistrict", "zipcode", "proposedUse" ], "type": "string", "description": "Which dimension to aggregate over. status -> the live vs done mix; permitTypeDescription -> what kind of work; neighborhood -> where.", "default": "status" }, "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 } } } } } } } } } }