{ "openapi": "3.0.1", "info": { "title": "Airbnb License Check, US & Canada Short-Term Rental Licenses", "description": "Check Airbnb listings against the official short-term rental register: active, expired, unknown or no license shown (Austin, Denver, Seattle, Toronto, Vancouver, Quebec). Plus the STR registers of 10 US cities and 3 Canadian ones: status, expiry, address, holder, phone and email where published", "version": "1.0", "x-build-id": "vjhc51BldB2LZqJ0j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wellbuilt_zythem~airbnb-license-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wellbuilt_zythem-airbnb-license-check", "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/wellbuilt_zythem~airbnb-license-check/runs": { "post": { "operationId": "runs-sync-wellbuilt_zythem-airbnb-license-check", "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/wellbuilt_zythem~airbnb-license-check/run-sync": { "post": { "operationId": "run-sync-wellbuilt_zythem-airbnb-license-check", "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": "One per line: austin, denver, seattle, toronto, vancouver, quebec (these six support the Airbnb check), nashville, new_orleans, louisville, atlanta, orlando, chicago, sacramento. Empty for all thirteen.", "items": { "type": "string" } }, "checkAirbnb": { "title": "Check Airbnb listings against the register", "type": "boolean", "description": "Reads the Airbnb search pages and each listing page, takes the license number the listing shows and looks it up in the register: active, expired, not in the register, or no license shown. Works in Austin and Denver (5 of 6 listings show the number, measured), Toronto (every home), Vancouver (6 of 8), Quebec (8 of 8, checked on Mont-Tremblant listings) and Seattle (1 of 6); other cities are skipped with a note.", "default": false }, "airbnbPages": { "title": "Airbnb pages per city", "minimum": 1, "maximum": 10, "type": "integer", "description": "Search pages to read when checking Airbnb (about 18 listings each, 30 on the first). 1 to 10.", "default": 2 }, "issuedWithinDays": { "title": "Licenses issued in the last N days", "minimum": 1, "type": "integer", "description": "Default 30. Seattle, Austin, Sacramento and Atlanta publish no issue date, so they always return their full register (up to \"Max per city\").", "default": 30 }, "issuedFrom": { "title": "Issued from", "type": "string", "description": "Date like 2026-09-01. Overrides the N days." }, "issuedTo": { "title": "Issued to", "type": "string", "description": "Date like 2026-09-30. Empty: today." }, "allLicenses": { "title": "Every license, not only recent ones", "type": "boolean", "description": "Ignore the dates and export the whole register of each city (up to \"Max per city\").", "default": false }, "onlyWithContact": { "title": "Only licenses with a phone or email", "type": "boolean", "description": "New Orleans publishes contact on 54 % of licenses, Quebec 94 %, Orlando 97 %, Louisville 99 %, Atlanta and Sacramento 100 %; the other places none.", "default": false }, "maxPerCity": { "title": "Max licenses per city", "minimum": 1, "type": "integer", "description": "License rows to deliver per city. The Airbnb check always compares against the whole register, whatever this says.", "default": 1000 }, "socrataAppToken": { "title": "Socrata app token", "type": "string", "description": "Optional. Gives the run its own quota on the Socrata portals (New Orleans, Denver, Orlando, Chicago, Seattle, Austin)." }, "proxyConfiguration": { "title": "Proxy for Airbnb", "type": "object", "description": "Only used by the Airbnb check. City registers need no proxy.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }