{ "openapi": "3.0.1", "info": { "title": "San Francisco Building Permits Feed: DataSF Open Data (PDDL)", "description": "New building permits from San Francisco's DataSF open data API (public domain, PDDL 1.0): address, parcel, work description, permit type, status, dates, estimated cost, uses, units and map point. Keyword, cost and ZIP filters, dedupe across runs. Unofficial.", "version": "0.2", "x-build-id": "T1T1MMBZ8pzw3owpF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fecklesspleb~city-building-permits-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fecklesspleb-city-building-permits-feed", "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/fecklesspleb~city-building-permits-feed/runs": { "post": { "operationId": "runs-sync-fecklesspleb-city-building-permits-feed", "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/fecklesspleb~city-building-permits-feed/run-sync": { "post": { "operationId": "run-sync-fecklesspleb-city-building-permits-feed", "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": [ "daily_feed", "date_range" ], "type": "string", "description": "daily_feed = the last N days (schedule it daily; only new permits are returned on each run). date_range = a fixed window.", "default": "daily_feed" }, "dateBasis": { "title": "Date to filter on", "enum": [ "issued", "filed" ], "type": "string", "description": "issued = permit issue date (issued_date). filed = application filed date (filed_date).", "default": "issued" }, "lookbackDays": { "title": "Look back (days)", "minimum": 0, "maximum": 90, "type": "integer", "description": "Daily feed only: how many days back from today (Pacific time) to include.", "default": 7 }, "startDate": { "title": "Start date", "type": "string", "description": "Date range only, YYYY-MM-DD." }, "endDate": { "title": "End date", "type": "string", "description": "Date range only, YYYY-MM-DD (default today)." }, "keyword": { "title": "Keyword in work description", "type": "string", "description": "Optional, case-insensitive, e.g. solar, ADU, roof, demolition, EV." }, "minEstimatedCost": { "title": "Minimum estimated cost (USD)", "minimum": 0, "type": "integer", "description": "Optional. Skip permits whose estimated job cost is lower." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional 5-digit San Francisco ZIP codes, e.g. 94110.", "items": { "type": "string" } }, "maxItems": { "title": "Max permits", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Hard cap on permits saved (and charged) per run. Default 4 (at most $0.008).", "default": 4 }, "onlyNewSinceLastRun": { "title": "Only permits not returned before", "enum": [ "auto", "yes", "no" ], "type": "string", "description": "auto = yes in daily feed mode, no in date range mode.", "default": "auto" }, "stateKey": { "title": "Dedupe state key", "type": "string", "description": "Use a different key per saved task so their dedupe memories do not mix.", "default": "default" } } }, "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 } } } } } } } } } }