{ "openapi": "3.0.1", "info": { "title": "Solar & Battery Permits + Installer Rankings (ATX/SEA/SF)", "description": "Solar PV and battery permits from Austin, Seattle and San Francisco open data, with installer rankings. No homeowner names, street addresses, coordinates, or contact details. Location is limited to ZIP code. System size (kW) is filled in for most SF and Seattle permits and about 40% of Austin ones.", "version": "0.2", "x-build-id": "1fzXufSu2mt1yjAfY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sublime_maypop~us-solar-permits-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sublime_maypop-us-solar-permits-data", "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/sublime_maypop~us-solar-permits-data/runs": { "post": { "operationId": "runs-sync-sublime_maypop-us-solar-permits-data", "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/sublime_maypop~us-solar-permits-data/run-sync": { "post": { "operationId": "run-sync-sublime_maypop-us-solar-permits-data", "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": "City permit datasets to query.", "items": { "type": "string", "enum": [ "AUSTIN", "SEATTLE", "SAN_FRANCISCO" ], "enumTitles": [ "Austin, TX (Issued Construction Permits)", "Seattle, WA (SDCI Electrical Permits)", "San Francisco, CA (DBI Electrical Permits)" ] }, "default": [ "AUSTIN", "SEATTLE", "SAN_FRANCISCO" ] }, "permitType": { "title": "Permit type", "enum": [ "both", "solar", "battery" ], "type": "string", "description": "Keyword match on the work description: solar PV, battery storage, or both.", "default": "both" }, "outputMode": { "title": "Output mode", "enum": [ "permits", "installerSummary" ], "type": "string", "description": "'permits' = one row per permit. 'installerSummary' = permit count per contractor per city (Austin and Seattle only; San Francisco publishes no contractor).", "default": "permits" }, "dateFrom": { "title": "Issued from (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Filter by permit issue date. Permits not yet issued are excluded when set." }, "dateTo": { "title": "Issued to (YYYY-MM-DD)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Upper bound of the issue date filter." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Only permits in these 5-digit ZIP codes.", "items": { "type": "string" } }, "contractorContains": { "title": "Contractor name contains", "type": "string", "description": "Case-insensitive substring of the contractor company name (Austin, Seattle)." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum dataset items across all cities (you are charged per item).", "default": 1000 }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 4, "type": "integer", "description": "Politeness limit toward the city portals.", "default": 1 }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free token from dev.socrata.com for higher throttling limits." } } }, "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 } } } } } } } } } }