{ "openapi": "3.0.1", "info": { "title": "Charlotte & Mecklenburg Permit Leads", "description": "New building, electrical, mechanical and plumbing permits from Mecklenburg County, NC (Charlotte and surrounding towns), refreshed daily from the county's current Accela system. Flags projects that don't have an electrical, HVAC or plumbing permit yet.", "version": "0.1", "x-build-id": "FtbkHg7vEZIZcodAC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/flecked_coffee~charlotte-permit-leads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-flecked_coffee-charlotte-permit-leads", "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/flecked_coffee~charlotte-permit-leads/runs": { "post": { "operationId": "runs-sync-flecked_coffee-charlotte-permit-leads", "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/flecked_coffee~charlotte-permit-leads/run-sync": { "post": { "operationId": "run-sync-flecked_coffee-charlotte-permit-leads", "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": { "daysBack": { "title": "Days back", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days of issued permits to return, ending today. Ignored if you set a start date.", "default": 7 }, "startDate": { "title": "Start date", "type": "string", "description": "Optional. First issue date to include (YYYY-MM-DD)." }, "endDate": { "title": "End date", "type": "string", "description": "Optional. Last issue date to include (YYYY-MM-DD). Defaults to today." }, "onlyProjectsMissingTrade": { "title": "Only projects still missing this trade", "enum": [ "none", "Electrical", "Mechanical", "Plumbing" ], "type": "string", "description": "Return only project permits (new buildings, additions, upfits, pools, accessory buildings...) that don't have this trade's permit on file yet. Good for finding jobs that still need a sub.", "default": "none" }, "workTypes": { "title": "Work types", "type": "array", "description": "Leave empty for all. Trade permits: Electrical, Mechanical, Plumbing, Fire, Equipment Changeout, Roofing, SolarPV. Project permits: New, Alteration, Addition, Upfit, Shell, StandaloneBuilding, PoolSpa, Accessory, Demolition, Site Works.", "items": { "type": "string" } }, "category": { "title": "Residential or commercial", "enum": [ "any", "Residential", "Commercial" ], "type": "string", "description": "Keep only residential (RES-) or commercial (COM-) permits, or both.", "default": "any" }, "jurisdictions": { "title": "Towns", "type": "array", "description": "Leave empty for the whole county. Options: Charlotte, Huntersville, Cornelius, Davidson, Matthews, Mint Hill, Pineville, Mecklenburg (unincorporated).", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Leave empty for all ZIP codes.", "items": { "type": "string" } }, "minProjectValue": { "title": "Minimum project value ($)", "minimum": 0, "type": "integer", "description": "Skip permits with a declared construction cost below this. Many trade permits have no value and are skipped when this is set." }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep permits whose description, project name or building use contains any of these words, e.g. generator, EV charger, panel, restaurant.", "items": { "type": "string" } }, "includeClosed": { "title": "Include cancelled and withdrawn permits", "type": "boolean", "description": "Also return permits the county marked cancelled, withdrawn, denied or expired.", "default": false }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many permits. 0 means no limit.", "default": 0 }, "county": { "title": "County", "enum": [ "mecklenburg" ], "type": "string", "description": "Which county's permit system to read. Mecklenburg County, NC is the only one so far.", "default": "mecklenburg" } } }, "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 } } } } } } } } } }