{
  "openapi": "3.0.1",
  "info": {
    "title": "US Short-Term Rental Permit & Host Leads Scraper",
    "description": "Scrape US short-term rental (Airbnb/VRBO) host & operator leads from official city permit registries: owner/operator name, phone, email, business entity, property address, permit status & dates, multi-property operator detection, lead score + monitoring. No browser.",
    "version": "0.1",
    "x-build-id": "whmfvzW2xKdsfKyFn"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~us-short-term-rental-permit-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-us-short-term-rental-permit-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/scrapesage~us-short-term-rental-permit-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-us-short-term-rental-permit-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/scrapesage~us-short-term-rental-permit-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-us-short-term-rental-permit-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": {
          "sources": {
            "title": "Cities / data sources",
            "type": "array",
            "description": "Which official city / county short-term-rental permit registries to query. <b>neworleans</b> = New Orleans non-commercial STRs (owner + operator + phone + email). <b>neworleans-comm</b> = New Orleans all active STR licenses (license holder + geo). <b>orlando</b> = Orlando, FL (holder + phone + email). <b>seattle</b> = Seattle, WA (business-license linked). <b>denver</b> = Denver, CO. <b>cambridge</b> = Cambridge, MA (property + Airbnb/VRBO listing links). <b>marin</b> = Marin County, CA (business name). <b>norfolk</b> = Norfolk, VA (bedrooms + max guests). <b>austin</b> = Austin, TX. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "neworleans",
                "neworleans-comm",
                "orlando",
                "seattle",
                "denver",
                "cambridge",
                "marin",
                "norfolk",
                "austin"
              ],
              "enumTitles": [
                "New Orleans, LA — Non-Commercial (owner+operator+email)",
                "New Orleans, LA — All Active",
                "Orlando, FL (phone+email)",
                "Seattle, WA",
                "Denver, CO",
                "Cambridge, MA (listing links)",
                "Marin County, CA",
                "Norfolk, VA",
                "Austin, TX"
              ]
            },
            "default": [
              "neworleans",
              "neworleans-comm",
              "orlando",
              "seattle",
              "denver",
              "cambridge",
              "marin",
              "norfolk",
              "austin"
            ]
          },
          "states": {
            "title": "States (optional)",
            "type": "array",
            "description": "Optionally restrict to these 2-letter state codes (<code>LA</code>, <code>FL</code>, <code>WA</code>, <code>CO</code>, <code>MA</code>, <code>CA</code>, <code>VA</code>, <code>TX</code>). Narrows the selected sources to those states.",
            "items": {
              "type": "string"
            }
          },
          "nameQuery": {
            "title": "Owner / operator name contains",
            "type": "string",
            "description": "Only return permits whose owner / operator / business name contains this text (case-insensitive), e.g. <code>Vacasa</code>, <code>Properties</code>, or a surname. Applied server-side where the source publishes a name field, otherwise client-side."
          },
          "cities": {
            "title": "Cities / towns",
            "type": "array",
            "description": "Filter by the property's city / town (case-insensitive exact match). Useful inside county sources — e.g. <code>San Rafael</code>, <code>Mill Valley</code>, <code>Sausalito</code> (Marin County). Single-city sources ignore this.",
            "items": {
              "type": "string"
            }
          },
          "zipCodes": {
            "title": "ZIP codes (prefix)",
            "type": "array",
            "description": "Filter by property ZIP — full ZIP (<code>32801</code>) or a prefix (<code>328</code> matches all 328xx).",
            "items": {
              "type": "string"
            }
          },
          "leadFilters": {
            "title": "Lead & host filters",
            "type": "string",
            "description": "The filters below target the best STR host / operator leads."
          },
          "withContactOnly": {
            "title": "With phone or email only",
            "type": "boolean",
            "description": "Only permits that have a phone number OR an email address. Best for direct outreach lists. (Contact data is published by New Orleans non-commercial and Orlando.)",
            "default": false
          },
          "withEmailOnly": {
            "title": "With email only",
            "type": "boolean",
            "description": "Only permits with an email address — the highest-converting STR host leads.",
            "default": false
          },
          "withPhoneOnly": {
            "title": "With phone only",
            "type": "boolean",
            "description": "Only permits with a phone number — best for tele-prospecting.",
            "default": false
          },
          "businessEntitiesOnly": {
            "title": "Business operators only (B2B)",
            "type": "boolean",
            "description": "Only permits held by a business entity (LLC, Inc, Properties, Management, Rentals, etc.) or flagged commercial — professional STR operators, the highest-value B2B leads.",
            "default": false
          },
          "multiPropertyOnly": {
            "title": "Multi-property operators only",
            "type": "boolean",
            "description": "Only hosts / operators that hold 2+ permits in the scanned data — property managers and professional operators running portfolios. Premium B2B leads for STR software, co-hosting, cleaning & insurance vendors.",
            "default": false
          },
          "strScope": {
            "title": "Rental scope",
            "type": "array",
            "description": "Filter by normalized rental scope. <b>owner-occupied</b> = owner-occupied / partial / homestay / private room. <b>whole-unit</b> = whole-unit / non-owner-occupied / commercial (typically a dedicated investment property = stronger B2B lead).",
            "items": {
              "type": "string",
              "enum": [
                "owner-occupied",
                "whole-unit"
              ],
              "enumTitles": [
                "Owner-occupied / partial / homestay",
                "Whole-unit / non-owner-occupied"
              ]
            }
          },
          "statuses": {
            "title": "Permit status",
            "type": "array",
            "description": "Filter by normalized permit status. <b>active</b> = active / current / issued / valid. <b>pending</b> = application in review. <b>expired</b> = past expiration. <b>inactive</b> = closed / revoked / cancelled / surrendered. <b>unknown</b> = status not published. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "pending",
                "expired",
                "inactive",
                "unknown"
              ],
              "enumTitles": [
                "Active",
                "Pending",
                "Expired",
                "Inactive / closed",
                "Unknown"
              ]
            }
          },
          "activeOnly": {
            "title": "Active permits only",
            "type": "boolean",
            "description": "Shortcut for status = active and not past expiration. Recommended for live outreach lists.",
            "default": false
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties with at least this many bedrooms (where published — Seattle, Cambridge, Norfolk)."
          },
          "minOccupancy": {
            "title": "Min max-occupancy / guests",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties licensed for at least this many guests (where published — New Orleans, Cambridge, Norfolk). Larger properties = bigger operators."
          },
          "newPermitsOnly": {
            "title": "Newly permitted only (GTM intent)",
            "type": "boolean",
            "description": "Only permits issued within the new-permit window below. Brand-new STR hosts are the highest-intent buyers — they need management software, cleaning, dynamic pricing, insurance, furnishing & supplies.",
            "default": false
          },
          "newPermitDays": {
            "title": "New-permit window (days)",
            "minimum": 1,
            "type": "integer",
            "description": "How recent the permit issue / application date must be to count as 'newly permitted'. Default 365.",
            "default": 365
          },
          "issuedAfter": {
            "title": "Issued on/after",
            "type": "string",
            "description": "Only permits issued / applied on or after this date (YYYY-MM-DD)."
          },
          "expiringBefore": {
            "title": "Expiring on/before",
            "type": "string",
            "description": "Only permits expiring on or before this date (YYYY-MM-DD) — renewal-timing leads (where the source publishes an expiration date)."
          },
          "minLeadScore": {
            "title": "Minimum lead score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only return records with a lead score (0–100) at or above this value."
          },
          "includeSourceFields": {
            "title": "Include raw source fields",
            "type": "boolean",
            "description": "Attach the full original permit row (every published column) as <code>sourceFields</code> on each record, so no data is lost. Turn off for a leaner dataset.",
            "default": true
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of host / operator lead records to return in this run (across all selected cities).",
            "default": 1000
          },
          "maxResultsPerSource": {
            "title": "Max results per source (optional)",
            "minimum": 1,
            "type": "integer",
            "description": "Cap how many records are taken from each city before the global limit and sorting. Leave blank to use the same value as Max results."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "leadScore",
              "newest",
              "portfolioSize",
              "occupancy",
              "none"
            ],
            "type": "string",
            "description": "Order of the returned records. <b>leadScore</b> = best leads first (default). <b>newest</b> = most recently issued permits first. <b>portfolioSize</b> = biggest multi-property operators first. <b>occupancy</b> = largest properties first. <b>none</b> = natural order (fastest).",
            "default": "leadScore"
          },
          "deduplicateResults": {
            "title": "Deduplicate within a run",
            "type": "boolean",
            "description": "Skip duplicate permit records within this run (recommended).",
            "default": true
          },
          "monitorMode": {
            "title": "Monitoring mode — only new records",
            "type": "boolean",
            "description": "Remember which permits were already returned (in a named key-value store) and emit ONLY records that are new since the last run — each tagged <code>monitorEvent: \"new\"</code>. A renewal, a status change or a brand-new permit also surfaces as new. Run on a Schedule to capture new STR hosts as fresh leads. Works alongside Apify Schedules (the schedule starts the run; monitoring decides what's new).",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Names the memory used by monitoring mode. Use a distinct key per saved watch (e.g. per city or filter) so different monitors don't share state.",
            "default": "default"
          },
          "socrataAppToken": {
            "title": "Socrata app token (optional)",
            "type": "string",
            "description": "Optional Socrata app token for higher rate limits on very large runs. Not required — leave blank for normal use. Get one free at any of the open-data portals (e.g. data.nola.gov)."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional proxy. The government open-data portals are fetched directly and need no proxy — leave this off for the fastest runs. Enable Apify Proxy only if your network requires it.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}