{ "openapi": "3.0.1", "info": { "title": "Choice Hotels Scraper — rates, ratings & amenities", "description": "Scrape Choice Hotels (choicehotels.com) — hotel name, brand, address, coordinates, star rating, review count, amenities, images, and nightly rates including the member price and discount. One search URL returns every hotel in the area. Residential proxy handled. JSON or CSV output.", "version": "0.0", "x-build-id": "oShuAu9KQXuJGi8RM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~choicehotels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-choicehotels-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/memo23~choicehotels-scraper/runs": { "post": { "operationId": "runs-sync-memo23-choicehotels-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/memo23~choicehotels-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-choicehotels-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": { "startUrls": { "title": "Choice Hotels search URLs", "type": "array", "description": "Full choicehotels.com search-results URLs. One request returns all hotels in that city/brand search.", "items": { "type": "string" } }, "locations": { "title": "Locations — one city per line", "type": "array", "description": "Type one location per line as `City, State` — e.g. `Los Angeles, California` or `Austin, TX`. The state can be a full name or a 2-letter code. To limit a line to one brand, add it after the state: `Miami, Florida, Comfort Inn`. Each line is turned into a Choice Hotels city search that returns every hotel in that area.", "items": { "type": "string" } }, "brands": { "title": "Brands", "type": "array", "description": "Keep only these Choice brands. Leave empty for all brands.", "items": { "type": "string", "enum": [ "Comfort Inn", "Comfort Suites", "Quality Inn", "Sleep Inn", "Clarion", "Clarion Pointe", "Cambria", "Ascend Collection", "MainStay Suites", "WoodSpring Suites", "Suburban Studios", "Everhome Suites", "Econo Lodge", "Rodeway Inn", "Country Inn & Suites" ] } }, "amenities": { "title": "Amenities (must have ALL)", "type": "array", "description": "Keep only hotels that have every amenity keyword listed, e.g. `pool`, `free breakfast`, `pet`, `fitness`, `ev charging`, `wifi`. Matched against each hotel's amenity list (case-insensitive).", "items": { "type": "string" } }, "petFriendly": { "title": "Pet-friendly only", "type": "boolean", "description": "Keep only hotels that explicitly allow pets.", "default": false }, "minRating": { "title": "Minimum guest rating (0–5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Keep only hotels with a guest rating at or above this value. 0 = no minimum.", "default": 0 }, "minReviews": { "title": "Minimum number of reviews", "minimum": 0, "type": "integer", "description": "Keep only hotels with at least this many guest reviews (filters out new / sparsely-rated hotels). 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum nightly rate", "minimum": 0, "type": "integer", "description": "Keep only hotels whose starting nightly rate (after taxes/fees) is at or below this amount. 0 = no maximum.", "default": 0 }, "maxItems": { "title": "Maximum hotels to scrape", "minimum": 1, "type": "integer", "description": "Hard cap on the number of hotels collected. A single city search page can return 40+ hotels; use this to limit billing.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "type": "integer", "description": "Parallel search pages fetched at once. Keep this low (default 3) — Choice Hotels' bot protection penalizes bursts.", "default": 3 }, "minConcurrency": { "title": "Min concurrency", "minimum": 1, "type": "integer", "description": "Minimum number of pages processed in parallel.", "default": 1 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "type": "integer", "description": "Number of retries before a failed request is given up.", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Choice Hotels uses Akamai bot protection, so a residential proxy is strongly recommended (and the default). The actor rotates the IP automatically when it detects a challenge.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }