{ "openapi": "3.0.1", "info": { "title": "FlipKey Listings Scraper", "description": "🔑 Scrape Property Listings from flipkey.com ✈️\nAccess comprehensive insights about property descriptions, photos, room details, amenities, nearby places, ratings, booking quotes, and a wealth of other valuable information. Export your results in a wide range of formats with just a few clicks!!", "version": "1.0", "x-build-id": "FuenCmaduBmHYQjdA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gabrielm~flipkey-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gabrielm-flipkey-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/gabrielm~flipkey-scraper/runs": { "post": { "operationId": "runs-sync-gabrielm-flipkey-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/gabrielm~flipkey-scraper/run-sync": { "post": { "operationId": "run-sync-gabrielm-flipkey-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": [ "location" ], "properties": { "location": { "title": "🌎 Location", "type": "string", "description": "Location name", "default": "New York City" }, "check_in": { "title": "🗓️ Check-in", "type": "string", "description": "Date of check-in" }, "check_out": { "title": "🗓️ Check-out", "type": "string", "description": "Date of check-out" }, "num_adults": { "title": "👫 Number of adults", "minimum": 1, "maximum": 15, "type": "integer", "description": "Number of adults to book (1-15)", "default": 2 }, "num_children": { "title": "🧒 Number of children", "minimum": 0, "maximum": 14, "type": "integer", "description": "Number of children to book (0-14)", "default": 0 }, "min_bedrooms": { "title": "🛏️ Minimum number of bedrooms", "minimum": 1, "maximum": 6, "type": "integer", "description": "Minimum allowed number of bedrooms (1-6)" }, "min_bathrooms": { "title": "🛁 Minimum number of bathrooms", "minimum": 1, "maximum": 6, "type": "integer", "description": "Minimum allowed number of bathrooms (1-6)" }, "max_budget": { "title": "💵 Maximum price to pay", "minimum": 1, "type": "integer", "description": "Maximum price to pay for the whole stay" }, "inc_additional_information": { "title": "✍ Include additional information", "type": "boolean", "description": "Listing description, room details, amenities, ratings, etc.", "default": false }, "inc_booking_quote": { "title": "💳 Include booking quote", "type": "boolean", "description": "Accurate price per night, booking & owner fees, deposit amounts and exact total", "default": false }, "inc_nearby_places": { "title": "📍 Include nearby places", "type": "boolean", "description": "Categorized nearby landmarks such as restaurants and attractions", "default": false }, "rental_type_apartment": { "title": "Apartment", "type": "boolean", "description": "", "default": false }, "rental_type_villa": { "title": "Villa", "type": "boolean", "description": "", "default": false }, "rental_type_cottage": { "title": "Cottage", "type": "boolean", "description": "", "default": false }, "rental_type_house": { "title": "House", "type": "boolean", "description": "", "default": false }, "rental_type_penthouse": { "title": "Penthouse", "type": "boolean", "description": "", "default": false }, "rental_type_chalet": { "title": "Chalet", "type": "boolean", "description": "", "default": false }, "rental_type_lodge": { "title": "Lodge", "type": "boolean", "description": "", "default": false }, "rental_type_manor_house": { "title": "Manor House", "type": "boolean", "description": "", "default": false }, "rental_type_bungalow": { "title": "Bungalow", "type": "boolean", "description": "", "default": false }, "rental_type_barn": { "title": "Barn", "type": "boolean", "description": "", "default": false }, "rental_type_castle": { "title": "Castle", "type": "boolean", "description": "", "default": false }, "rental_type_townhouse": { "title": "Townhouse", "type": "boolean", "description": "", "default": false }, "rental_type_camper_van": { "title": "Camper van", "type": "boolean", "description": "", "default": false }, "rental_type_farmhouse": { "title": "Farmhouse", "type": "boolean", "description": "", "default": false }, "rental_type_studio": { "title": "Studio", "type": "boolean", "description": "", "default": false }, "rental_type_yacht": { "title": "Yacht", "type": "boolean", "description": "", "default": false }, "rental_type_narrowboat": { "title": "Narrowboat", "type": "boolean", "description": "", "default": false }, "rental_type_gite": { "title": "Gite", "type": "boolean", "description": "", "default": false }, "rental_type_houseboat": { "title": "Houseboat", "type": "boolean", "description": "", "default": false }, "rental_type_yurt": { "title": "Yurt", "type": "boolean", "description": "", "default": false }, "rental_type_trullo": { "title": "Trullo", "type": "boolean", "description": "", "default": false }, "rental_type_windmill": { "title": "Windmill", "type": "boolean", "description": "", "default": false }, "rental_type_chateau": { "title": "Chateau", "type": "boolean", "description": "", "default": false }, "rental_type_boathouse": { "title": "Boathouse", "type": "boolean", "description": "", "default": false }, "rental_type_finca": { "title": "Finca", "type": "boolean", "description": "", "default": false }, "rental_type_condo": { "title": "Condo", "type": "boolean", "description": "", "default": false }, "rental_type_lighthouse": { "title": "Lighthouse", "type": "boolean", "description": "", "default": false }, "rental_type_watermill": { "title": "Watermill", "type": "boolean", "description": "", "default": false }, "rental_type_fort": { "title": "Fort", "type": "boolean", "description": "", "default": false }, "rental_type_tower": { "title": "Tower", "type": "boolean", "description": "", "default": false }, "rental_type_room": { "title": "Private room", "type": "boolean", "description": "", "default": false }, "rental_type_tented_camp": { "title": "Tented camp", "type": "boolean", "description": "", "default": false }, "rental_type_b_and_b": { "title": "B&B", "type": "boolean", "description": "", "default": false }, "rental_type_converted_chapel": { "title": "Converted Chapel", "type": "boolean", "description": "", "default": false }, "rental_type_beach_hut": { "title": "Beach hut", "type": "boolean", "description": "", "default": false }, "rental_type_ski_chalet": { "title": "Ski Chalet", "type": "boolean", "description": "", "default": false }, "rental_type_tipi_teepee": { "title": "Tipi/Teepee", "type": "boolean", "description": "", "default": false }, "rental_type_hotel_apartment": { "title": "Hotel apartment", "type": "boolean", "description": "", "default": false }, "rental_type_tree_house": { "title": "Tree House", "type": "boolean", "description": "", "default": false }, "rental_type_guest_house": { "title": "Guest house", "type": "boolean", "description": "", "default": false }, "rental_type_caravan_mobile_home": { "title": "Caravan/Mobile Home", "type": "boolean", "description": "", "default": false }, "rental_type_log_cabin": { "title": "Log cabin", "type": "boolean", "description": "", "default": false }, "rental_type_cave_house": { "title": "Cave house", "type": "boolean", "description": "", "default": false }, "rental_type_shepherds_hut": { "title": "Shepherds Hut", "type": "boolean", "description": "", "default": false }, "rental_type_riad": { "title": "Riad", "type": "boolean", "description": "", "default": false }, "amenity_wifi": { "title": "Wireless Internet", "type": "boolean", "description": "", "default": false }, "amenity_air_con": { "title": "Air conditioning", "type": "boolean", "description": "", "default": false }, "amenity_pool": { "title": "Swimming pool", "type": "boolean", "description": "", "default": false }, "amenity_private_pool": { "title": "Private pool", "type": "boolean", "description": "", "default": false }, "amenity_heated_pool": { "title": "Heated pool", "type": "boolean", "description": "", "default": false }, "amenity_indoor_pool": { "title": "Private indoor pool", "type": "boolean", "description": "", "default": false }, "amenity_balcony_terrace": { "title": "Balcony or terrace", "type": "boolean", "description": "", "default": false }, "amenity_washing_machine": { "title": "Washing machine", "type": "boolean", "description": "", "default": false }, "amenity_jacuzzi": { "title": "Jacuzzi or hot tub", "type": "boolean", "description": "", "default": false }, "amenity_garden": { "title": "Garden", "type": "boolean", "description": "", "default": false }, "amenity_internet_access": { "title": "Internet access", "type": "boolean", "description": "", "default": false }, "amenity_dvd": { "title": "DVD player", "type": "boolean", "description": "", "default": false }, "amenity_bbq": { "title": "Grill", "type": "boolean", "description": "", "default": false }, "amenity_fireplace": { "title": "Fireplace", "type": "boolean", "description": "", "default": false }, "amenity_cot": { "title": "Cot available", "type": "boolean", "description": "", "default": false }, "amenity_sauna": { "title": "Sauna", "type": "boolean", "description": "", "default": false }, "amenity_highchair": { "title": "High chair", "type": "boolean", "description": "", "default": false }, "amenity_seaview": { "title": "Sea view", "type": "boolean", "description": "", "default": false }, "amenity_safe": { "title": "Safe", "type": "boolean", "description": "", "default": false }, "amenity_dish_washer": { "title": "Dishwasher", "type": "boolean", "description": "", "default": false }, "amenity_child_pool": { "title": "Children's pool", "type": "boolean", "description": "", "default": false }, "amenity_communal_pool": { "title": "Shared outdoor pool (unheated)", "type": "boolean", "description": "", "default": false }, "amenity_outdoor_heated_pool": { "title": "Private outdoor pool (heated)", "type": "boolean", "description": "", "default": false }, "amenity_outdoor_pool": { "title": "Private outdoor pool (unheated)", "type": "boolean", "description": "", "default": false }, "amenity_communal_heated_pool": { "title": "Shared outdoor pool (heated)", "type": "boolean", "description": "", "default": false }, "amenity_cribs": { "title": "Cribs", "type": "boolean", "description": "", "default": false }, "amenity_ceiling_fans": { "title": "Ceiling Fans", "type": "boolean", "description": "", "default": false }, "amenity_gamesroom": { "title": "Games room", "type": "boolean", "description": "", "default": false }, "amenity_clothes_dryer": { "title": "Clothes dryer", "type": "boolean", "description": "", "default": false }, "amenity_communal_indoor_pool": { "title": "Shared indoor pool", "type": "boolean", "description": "", "default": false }, "amenity_trampoline": { "title": "Trampoline", "type": "boolean", "description": "", "default": false }, "amenity_pingpong": { "title": "Table tennis", "type": "boolean", "description": "", "default": false }, "amenity_snooker": { "title": "Pool or snooker table", "type": "boolean", "description": "", "default": false }, "amenity_fax": { "title": "Fax machine", "type": "boolean", "description": "", "default": false }, "amenity_video": { "title": "Video player", "type": "boolean", "description": "", "default": false }, "amenity_boat": { "title": "Boat available", "type": "boolean", "description": "", "default": false }, "amenity_staff": { "title": "Staffed property", "type": "boolean", "description": "", "default": false }, "amenity_private_fish": { "title": "Private fishing lake or river", "type": "boolean", "description": "", "default": false }, "amenity_swings": { "title": "Swing set or jungle gym", "type": "boolean", "description": "", "default": false }, "amenity_climbing_frame": { "title": "Climbing frame", "type": "boolean", "description": "", "default": false }, "amenity_bicycles_available": { "title": "Bicycles available", "type": "boolean", "description": "", "default": false }, "amenity_towels_provided": { "title": "Towels provided", "type": "boolean", "description": "", "default": false }, "amenity_linen_provided": { "title": "Linen provided", "type": "boolean", "description": "", "default": false }, "amenity_microwave": { "title": "Microwave", "type": "boolean", "description": "", "default": false }, "amenity_freezer": { "title": "Freezer", "type": "boolean", "description": "", "default": false }, "amenity_housekeeping_included": { "title": "Housekeeping Included", "type": "boolean", "description": "", "default": false }, "amenity_tennis": { "title": "Private tennis court", "type": "boolean", "description": "", "default": false }, "suitability_pets_all": { "title": "Pets allowed", "type": "boolean", "description": "", "default": false }, "suitability_parking_space": { "title": "Parking", "type": "boolean", "description": "", "default": false }, "suitability_no_car": { "title": "Car not required", "type": "boolean", "description": "", "default": false }, "suitability_children_under5": { "title": "Children under 5", "type": "boolean", "description": "", "default": false }, "suitability_smoking": { "title": "Smoking allowed", "type": "boolean", "description": "", "default": false }, "suitability_nonsmoking": { "title": "Non-Smoking property", "type": "boolean", "description": "", "default": false }, "suitability_liftaccess": { "title": "Elevator access", "type": "boolean", "description": "", "default": false }, "suitability_wheelchair_adapted": { "title": "Wheelchair adapted", "type": "boolean", "description": "", "default": false }, "suitability_wheelchair_access": { "title": "Wheelchair accessible", "type": "boolean", "description": "", "default": false }, "activity_beach_or_lakeside": { "title": "Beach or lakeside relaxation", "type": "boolean", "description": "", "default": false }, "activity_city_centre": { "title": "City breaks", "type": "boolean", "description": "", "default": false }, "activity_rambling": { "title": "Walking trips", "type": "boolean", "description": "", "default": false }, "activity_tennis": { "title": "Tennis in town", "type": "boolean", "description": "", "default": false }, "activity_watersports": { "title": "Water sports", "type": "boolean", "description": "", "default": false }, "activity_horse_riding": { "title": "Horse riding", "type": "boolean", "description": "", "default": false }, "activity_fishing": { "title": "Fishing", "type": "boolean", "description": "", "default": false }, "activity_cycling": { "title": "Cycling trips", "type": "boolean", "description": "", "default": false }, "activity_golf_near": { "title": "Golf course on site or within 15 min walk", "type": "boolean", "description": "", "default": false }, "activity_mountain_views": { "title": "Mountain Views", "type": "boolean", "description": "", "default": false }, "activity_golf_far": { "title": "Golf within 30mins drive", "type": "boolean", "description": "", "default": false }, "activity_waterfront": { "title": "Waterfront", "type": "boolean", "description": "", "default": false }, "activity_ski": { "title": "Skiing - property near ski resort", "type": "boolean", "description": "", "default": false }, "activity_nightlife": { "title": "Nightlife", "type": "boolean", "description": "", "default": false }, "activity_lake": { "title": "Lakefront", "type": "boolean", "description": "", "default": false }, "adv_max_listings": { "title": "🛑 Maximum number of listings", "minimum": 0, "type": "integer", "description": "Limits the number of retrieved listings\n(zero = no limit)", "default": 50 }, "adv_request_timeout": { "title": "⏱️ Request timeout", "minimum": 1, "type": "integer", "description": "Individual request timeout, in seconds", "default": 30 }, "adv_request_retries": { "title": "🔄 Request retries", "minimum": 0, "maximum": 9, "type": "integer", "description": "How many times to retry a request if it fails\n(0-9, zero = never)", "default": 3 }, "adv_request_cooldown": { "title": "🔥 Request cooldown", "minimum": 0, "maximum": 10, "type": "integer", "description": "Interval before retrying a failed request,\nin seconds (0-10, zero = immediate)", "default": 1 }, "adv_proxy_usage": { "title": "🕵🏻 Proxy usage", "type": "object", "description": "Proxies used to anonymize your requests\n(⚠️ using none is discouraged ⚠️)" }, "adv_dataset_optimization": { "title": "🗜️ Dataset optimization", "type": "boolean", "description": "Simplifies elements for a better layout\n(⚠️ best for spreadsheet-like view ⚠️)", "default": true }, "adv_show_warnings": { "title": "💬 Show warnings", "type": "boolean", "description": "Includes non-critical messages in the log\n(⚠️ for advanced users ⚠️)", "default": 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 } } } } } } } } } }