{ "openapi": "3.0.1", "info": { "title": "YachtWorld Scraper", "description": "Scrape YachtWorld - the world's largest yacht & boat marketplace. Search boats for sale with make, model, length, price and year filters, browse by make, fetch full listing details with specifications, engines, broker info and images.", "version": "1.0", "x-build-id": "RpI4fxumEu5k0nQya" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~yachtworld-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-yachtworld-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~yachtworld-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-yachtworld-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~yachtworld-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-yachtworld-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", "browseByMake", "byUrl" ], "type": "string", "description": "What to fetch.", "default": "search" }, "q": { "title": "Search query (mode=search)", "type": "string", "description": "Free-text keyword: make, model or type, e.g. `bayliner`, `beneteau oceanis`, `sail cruiser`.", "default": "bayliner" }, "make": { "title": "Make (mode=search)", "type": "string", "description": "Constrain results to a boat manufacturer, e.g. `Bayliner`, `Beneteau`, `Sea Ray`." }, "model": { "title": "Model (mode=search)", "type": "string", "description": "Constrain results to a specific model name, e.g. `5788`, `Oceanis 46.1`." }, "browseByMake": { "title": "Browse make (mode=browseByMake)", "type": "string", "description": "Manufacturer slug to browse all of its listings, e.g. `bayliner`, `beneteau`, `sea-ray`.", "default": "bayliner" }, "urls": { "title": "URLs (mode=byUrl)", "type": "array", "description": "YachtWorld listing (boat) or broker page URLs.", "default": [], "items": { "type": "string" } }, "boatType": { "title": "Boat type (mode=search)", "enum": [ "", "power", "sail", "unpowered" ], "type": "string", "description": "Filter by top-level boat category." }, "condition": { "title": "Condition (mode=search)", "enum": [ "", "new", "used" ], "type": "string", "description": "Filter by listing condition." }, "fuelType": { "title": "Fuel type (mode=search)", "enum": [ "", "diesel", "electric", "petrol", "other" ], "type": "string", "description": "Filter by engine fuel type (verified YachtWorld facet values). (mode=search)" }, "hullMaterial": { "title": "Hull material (mode=search)", "enum": [ "", "aluminum", "composite", "ferrocement", "fiberglass", "hypalon", "other", "pvc", "steel", "wood" ], "type": "string", "description": "Filter by hull material (verified YachtWorld facet values). (mode=search)" }, "hullShape": { "title": "Hull shape (mode=search)", "enum": [ "", "catamaran", "deep-vee", "modified-vee", "monohull" ], "type": "string", "description": "Filter by hull shape (verified YachtWorld facet values). (mode=search)" }, "minLength": { "title": "Length (min, ft)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Only boats at least this long (feet)." }, "maxLength": { "title": "Length (max, ft)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Only boats no longer than this (feet)." }, "minPrice": { "title": "Price (min, USD)", "minimum": 0, "maximum": 200000000, "type": "integer", "description": "Only boats priced at least this amount (USD)." }, "maxPrice": { "title": "Price (max, USD)", "minimum": 0, "maximum": 200000000, "type": "integer", "description": "Only boats priced at most this amount (USD)." }, "minYear": { "title": "Year (min)", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Only boats built in or after this year." }, "maxYear": { "title": "Year (max)", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Only boats built in or before this year." }, "country": { "title": "Country (mode=search)", "enum": [ "", "US", "CA", "GB", "AU", "NZ", "FR", "DE", "IT", "ES", "PT", "NL", "BE", "NO", "SE", "DK", "FI", "GR", "HR", "TR", "AE", "SA", "QA", "BH", "OM", "KW", "SG", "MY", "TH", "PH", "ID", "CN", "HK", "TW", "JP", "KR", "IN", "PK", "MX", "BR", "AR", "CL", "CO", "PE", "PA", "CR", "DO", "JM", "BS", "TC", "KY", "VG", "AN", "ZA", "EG", "MA", "TN", "KE", "NG", "GH", "IL", "CY", "MT", "MC", "RU", "UA", "PL", "CZ", "HU", "RO", "BG", "IS", "IE", "CH", "AT", "LU", "LI" ], "type": "string", "description": "Filter by listing country (ISO 3166-1 alpha-2)." }, "sellerType": { "title": "Seller type (mode=search)", "enum": [ "", "dealer", "owner" ], "type": "string", "description": "Filter by who is selling." }, "sortBy": { "title": "Sort (mode=search)", "enum": [ "recommended", "created-desc", "created-asc", "price-desc", "price-asc", "year-desc", "year-asc" ], "type": "string", "description": "Result ordering.", "default": "recommended" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap on emitted records.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Used automatically if YachtWorld's Cloudflare protection blocks the datacenter IP (403/429). Leave on the free Apify 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 } } }, "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 } } } } } } } } } }