{ "openapi": "3.0.1", "info": { "title": "CozyCozy Scraper", "description": "Scrape lodging listings from CozyCozy's public catalog pages - hotels, vacation rentals, hostels, apartments, and more, across 13 English-language markets, with price, rating, review count, geo-coordinates, and address.", "version": "1.0", "x-build-id": "HvWxrLPUWEnQCw0Es" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~cozycozy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-cozycozy-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/crawlerbros~cozycozy-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-cozycozy-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/crawlerbros~cozycozy-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-cozycozy-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "byLocation", "byUrl" ], "type": "string", "description": "What to fetch.", "default": "byLocation" }, "locations": { "title": "Locations (mode=byLocation)", "type": "array", "description": "City or country names to search, e.g. `Paris`, `New York`, `Tokyo`, `Germany`. One catalog page is fetched per location.", "default": [ "Paris" ], "items": { "type": "string" } }, "accommodationType": { "title": "Accommodation type (mode=byLocation)", "enum": [ "hotels", "vacation-rentals", "apartments", "serviced-apartments", "villa-rentals", "resorts", "motels", "cabins", "hostels", "short-term-rentals", "bed-and-breakfast", "cottages", "lodges", "lodging", "holiday-parks", "chalet", "unique-stays" ], "type": "string", "description": "Type of lodging to browse for each location.", "default": "hotels" }, "market": { "title": "Market / country site (mode=byLocation)", "enum": [ "us", "gb", "ca", "au", "ie", "nz", "za", "en-sg", "en-hk", "en-in", "en-ph", "en-ae", "en-id" ], "type": "string", "description": "Which localized CozyCozy site to browse (affects currency and result ranking). Only English-language markets are supported.", "default": "us" }, "startUrls": { "title": "CozyCozy catalog URLs (mode=byUrl)", "type": "array", "description": "Direct CozyCozy catalog page URLs, e.g. `https://www.cozycozy.com/us/paris-hotels`. Enter one URL per row in the Console (it wraps each into `{\"url\": \"...\"}` automatically); via the API, send an array of `{\"url\": \"...\"}` objects.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "minRating": { "title": "Minimum rating (0-10)", "minimum": 0, "maximum": 10, "type": "number", "description": "Drop listings with a review score below this value (CozyCozy uses a 0-10 scale). Listings with no rating shown still pass through." }, "minStarRating": { "title": "Minimum official star rating (0-5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Drop listings whose official star rating (e.g. a \"4-star hotel\") is below this value. Distinct from `minRating`, which is the guest review score. Listings with no official star rating shown still pass through." }, "maxPricePerNight": { "title": "Max price per night", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Drop listings whose \"from\" price per night is above this value, in the market's local currency." }, "minReviews": { "title": "Minimum review count", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop listings with fewer reviews than this." }, "strictTypeMatch": { "title": "Strict accommodation-type match", "type": "boolean", "description": "When a city has no listings of the requested type, CozyCozy shows other nearby options instead. Enable this to drop those off-type fallback listings and keep only ones matching the requested type.", "default": false }, "containsKeyword": { "title": "Contains keyword", "type": "string", "description": "Only keep listings whose title or description contains this text (case-insensitive)." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted records across all locations/URLs. Each catalog page typically yields up to ~40 listings.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. CozyCozy's catalog pages load fine from a direct connection; the actor tries direct first and only engages this free Apify datacenter proxy as a fallback if a page gets blocked or rate-limited.", "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 } } }, "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 } } } } } } } } } }