{ "openapi": "3.0.1", "info": { "title": "Headout Scraper", "description": "Scrape Headout - the global marketplace for tours, attractions, shows, day trips and water activities. Search by keyword, browse by city or category, fetch by URL, and get full experience details: prices, ratings, reviews, meeting points, highlights, inclusions and images.", "version": "1.0", "x-build-id": "eNy5iLyWpJexcOamj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~headout-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-headout-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~headout-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-headout-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~headout-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-headout-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": [ "search", "browseByCity", "browseByCategory", "byUrl" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text keyword, e.g. `eiffel tower`, `museum`, `hop on hop off` (mode=search).", "default": "eiffel tower" }, "city": { "title": "City", "enum": [ "DUBAI", "LONDON", "NEW_YORK", "PARIS", "BARCELONA", "SINGAPORE", "ROME", "ISTANBUL", "LAS_VEGAS", "BERLIN", "AMSTERDAM", "BANGKOK", "TOKYO", "SYDNEY", "MEXICO_CITY", "RIO_DE_JANEIRO", "LISBON", "PRAGUE", "VENICE", "OSAKA" ], "type": "string", "description": "City to browse or constrain the search to. Curated list of top Headout markets.", "default": "PARIS" }, "category": { "title": "Category", "enum": [ "attractions", "tours", "transportation", "travelServices", "cruises", "foodDrink", "shows", "adventure", "aerialSightseeing", "waterSports", "natureWildlife", "wellness", "classes", "specials", "sports" ], "type": "string", "description": "Top-level category to browse (mode=browseByCategory)." }, "experienceUrls": { "title": "Experience URLs (mode=byUrl)", "type": "array", "description": "Headout experience page URLs, e.g. `https://www.headout.com/paris-museums/eiffel-tower-tickets-e-23604/`. Bare experience IDs are also accepted.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price per person", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop experiences priced below this (in the selected currency)." }, "maxPrice": { "title": "Max price per person", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop experiences priced above this (in the selected currency)." }, "minRating": { "title": "Min rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Drop experiences rated below this (1-5)." }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AED", "INR", "SGD", "JPY", "AUD", "CAD", "HKD", "SEK", "NOK", "DKK", "PLN", "TRY", "MXN", "BRL", "ZAR", "KRW", "CHF" ], "type": "string", "description": "ISO 4217 currency code for all prices.", "default": "USD" }, "language": { "title": "Language", "enum": [ "en", "es", "fr", "de", "it", "pt", "nl", "pl", "ko", "ja", "zh-hans", "da", "no", "ro", "ru", "sv", "tr" ], "type": "string", "description": "Localization language for titles, summaries and reviews.", "default": "en" }, "sortType": { "title": "Sort by", "enum": [ "POPULARITY", "TRENDING", "RECOMMENDED" ], "type": "string", "description": "Listing order for browse modes.", "default": "POPULARITY" }, "sortOrder": { "title": "Sort order", "enum": [ "ASC", "DESC" ], "type": "string", "description": "Listing direction for browse modes (mode=browseByCity, mode=browseByCategory).", "default": "ASC" }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also emit per-experience review records (capped by maxItems).", "default": false }, "reviewsPerExperience": { "title": "Reviews per experience", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum review records to fetch per experience when `includeReviews` is on.", "default": 10 }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy (lazily used only if direct access is blocked)." } } }, "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 } } } } } } } } } }