{ "openapi": "3.0.1", "info": { "title": "Permit Signal Scout", "description": "Normalize and rank public permit records into construction opportunity signals.", "version": "0.1", "x-build-id": "M5bWNE72RIHfoFaf9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/careybrown~permit-signal-scout/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-careybrown-permit-signal-scout", "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/careybrown~permit-signal-scout/runs": { "post": { "operationId": "runs-sync-careybrown-permit-signal-scout", "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/careybrown~permit-signal-scout/run-sync": { "post": { "operationId": "run-sync-careybrown-permit-signal-scout", "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": "Official public permit sources to query.", "items": { "type": "string", "enum": [ "austin_tx", "chicago_il", "nyc_ny", "cincinnati_oh", "san_francisco_ca" ] }, "default": [ "austin_tx", "chicago_il", "nyc_ny", "cincinnati_oh", "san_francisco_ca" ] }, "issuedAfter": { "title": "Issued After", "type": "string", "description": "Return permits issued on or after this ISO date. Runtime default is today minus 30 days." }, "issuedBefore": { "title": "Issued Before", "type": "string", "description": "Optional ISO date upper bound for issued date filtering." }, "tradeKeywords": { "title": "Trade Keywords", "type": "array", "description": "Trade terms to match later during classification/scoring.", "items": { "type": "string" }, "default": [ "roofing", "hvac", "solar", "plumbing", "electrical", "remodeling", "adu", "multifamily", "commercial", "restoration", "general construction" ] }, "minEstimatedValue": { "title": "Minimum Estimated Value", "minimum": 0, "type": "number", "description": "Optional minimum estimated permit value. Records with missing value are retained for MVP unless filtering is applied by a later adapter." }, "maxResultsPerCity": { "title": "Maximum Results Per City", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum normalized records to fetch per selected city.", "default": 500 }, "includeAiScoring": { "title": "Include AI Scoring", "type": "boolean", "description": "Reserved for a later version. MVP uses deterministic scoring only and should warn when this is true.", "default": false }, "outputMode": { "title": "Output Mode", "enum": [ "ranked", "byCity", "rawNormalized" ], "type": "string", "description": "Output ordering/grouping mode.", "default": "ranked" }, "includeRawRecord": { "title": "Include Raw Record", "type": "boolean", "description": "Include the original Socrata row on each normalized record.", "default": false }, "sortBy": { "title": "Sort By", "enum": [ "leadQualityScore", "issuedDate", "estimatedValue", "sourceCity" ], "type": "string", "description": "Sort key for final records.", "default": "leadQualityScore" }, "leadGradeFilter": { "title": "Lead Grade Filter", "type": "array", "description": "Lead grades to include after scoring is implemented.", "items": { "type": "string", "enum": [ "A", "B", "C", "D" ] }, "default": [ "A", "B", "C", "D" ] } } }, "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 } } } } } } } } } }