{ "openapi": "3.0.1", "info": { "title": "Us Building Permits Scraper", "version": "1.0", "x-build-id": "HoKXuKpqObSN0Dtn2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/velvety_bedbug~us-building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-velvety_bedbug-us-building-permits-scraper", "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/velvety_bedbug~us-building-permits-scraper/runs": { "post": { "operationId": "runs-sync-velvety_bedbug-us-building-permits-scraper", "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/velvety_bedbug~us-building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-velvety_bedbug-us-building-permits-scraper", "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": { "city": { "title": "City", "enum": [ "all", "Albany, NY", "Albuquerque, NM", "Anaheim, CA", "Arlington, TX", "Aurora, CO", "Austin, TX", "Baltimore, MD", "Baton Rouge, LA", "Boise, ID", "Boston, MA", "Buffalo, NY", "Cambridge, MA", "Cape Coral, FL", "Charlotte, NC", "Chattanooga, TN", "Chesapeake, VA", "Chicago, IL", "Cincinnati, OH", "Cleveland, OH", "Columbus, OH", "Corona, CA", "Dallas, TX", "Denver, CO", "Detroit, MI", "Durham, NC", "El Paso, TX", "Elk Grove, CA", "Fort Lauderdale, FL", "Fort Worth, TX", "Fresno, CA", "Gainesville, FL", "Gilbert, AZ", "Greensboro, NC", "Henderson, NV", "Honolulu, HI", "Irving, TX", "Jackson County, OR", "Johns Creek, GA", "Kansas City, MO", "Knoxville, TN", "Las Vegas, NV", "Little Rock, AR", "Los Angeles, CA", "Louisville, KY", "Lubbock, TX", "Marin County, CA", "Memphis, TN", "Mesa, AZ", "Miami, FL", "Miami-Dade, FL", "Milwaukee, WI", "Minneapolis, MN", "Montgomery County, MD", "Montgomery, AL", "Murfreesboro, TN", "Nashville, TN", "New Hanover County, NC", "New Orleans, LA", "New York City, NY", "Norfolk, VA", "Orlando, FL", "Parker, CO", "Peoria, AZ", "Philadelphia, PA", "Pierce County, WA", "Pittsburgh, PA", "Portland, OR", "Providence, RI", "Raleigh, NC", "Rockford, IL", "Roseville, CA", "Sacramento, CA", "Saint Paul, MN", "Salt Lake City, UT", "San Antonio, TX", "San Diego, CA", "San Francisco, CA", "San Jose, CA", "San Marcos, TX", "Scottsdale, AZ", "Seattle, WA", "Sioux Falls, SD", "Somerville, MA", "Spokane, WA", "St. Louis, MO", "Tacoma, WA", "Tallahassee, FL", "Tampa, FL", "Tempe, AZ", "Tucson, AZ", "Urbana, IL", "Virginia Beach, VA", "Wichita, KS", "Williamson County, TX", "Winston-Salem, NC", "Worcester, MA" ], "type": "string", "description": "City or region to scrape. Use 'all' to scrape all 96 supported cities.", "default": "Chicago, IL" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of permit records to return (0 = unlimited).", "default": 10 } } }, "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 } } } } } } } } } }