{ "openapi": "3.0.1", "info": { "title": "VesselFinder Scraper — Ships, IMO, MMSI, Destination & ETA", "description": "Scrape the VesselFinder ship database by type, flag, year, size or name, or look up IMO/MMSI numbers: vessel name, IMO, MMSI, call sign, flag, type, year built, GT, DWT, length, beam, destination, ETA, draught, navigation status and last position area. No login.", "version": "0.1", "x-build-id": "S9TidfjKTll6em2rI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~vesselfinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-vesselfinder-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/yugenox~vesselfinder-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-vesselfinder-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/yugenox~vesselfinder-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-vesselfinder-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": { "shipTypes": { "title": "🚢 Ship types", "type": "array", "description": "Search VesselFinder ship database by type, e.g. Container Ship, Bulk carrier, Crude Oil Tanker. \"All …\" entries cover a whole group. Each type is searched separately (and combined with each flag).", "items": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "301", "302", "303", "304", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "601", "602", "603", "604", "605", "606", "607", "608", "609" ], "enumTitles": [ "Other type/ Auxiliary", "Unknown", "Tugs", "All Passenger/Cruise Ships", "All Cargo Vessels", "Fishing ships", "All Tankers", "Military", "Yachts/Sailing Vessels", "Cruise Ship", "Passenger/Cargo Ship", "Passenger/Ro-Ro Ship", "Passenger Ship", "Bulk carrier", "General Cargo", "Container Ship", "Reefer", "Ro-Ro", "Vehicles Carrier", "Cement Carrier", "Wood Chips Carrier", "Urea Carrier", "Aggregates Carrier", "Limestone Carrier", "Landing Craft", "Livestock Carrier", "Heavy Load Carrier", "Crude Oil Tanker", "Oil Products Tanker", "Chemical/Oil Tanker", "LNG Tanker", "LPG Tanker", "Asphalt/Bitumen", "Bunkering Tanker", "FSO/FPSO", "Other Tanker" ] } }, "flags": { "title": "🏳️ Flags", "type": "array", "description": "Flag states (country of registration), e.g. Panama, Liberia, Marshall Islands, Singapore. Each flag is searched separately.", "items": { "type": "string", "enum": [ "XD", "AF", "AX", "XC", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "XE", "AU", "AT", "AZ", "XA", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CI", "HR", "XF", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "KP", "CD", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FO", "FK", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GF", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "XG", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "MP", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "XB", "PR", "QA", "RE", "RO", "RU", "RW", "GS", "SH", "MF", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "SS", "ES", "LK", "KN", "LC", "XI", "PM", "VC", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "XH", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "ZZ", "UY", "UM", "VI", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW" ], "enumTitles": [ "Adelie Land", "Afghanistan", "Aland Islands", "Alaska", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua & Barbuda", "Argentina", "Armenia", "Aruba", "Ascension Island", "Australia", "Austria", "Azerbaijan", "Azores", "Bahamas", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire,St Eustatius & Saba", "Bosnia & Herzegovina", "Botswana", "Brazil", "British Indian Ocean Ter.", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central Africa Rep (CAR)", "Chad", "Chile", "China", "Christmas Island", "Cocos Islands", "Colombia", "Comoros", "Congo", "Cook Islands", "Costa Rica", "Cote d'Ivoire", "Croatia", "Crozet Archipelago", "Cuba", "Curacao", "Cyprus", "Czech Rep", "Denmark", "Djibouti", "Dominica", "Dominican Rep", "DPR Korea", "DR Congo", "East Timor", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Faeroe Islands", "Falkland Islands", "Fiji", "Finland", "France", "French Polynesia", "Gabon", "Gambia", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guiana", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Isl & McDonald Isls", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kerguelen Islands", "Kiribati", "Korea", "Kuwait", "Kyrgyz Rep", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao", "Macedonia", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "N. Mariana Isl", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Norway", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn Island", "Poland", "Portugal", "Portugal (Madeira)", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russia", "Rwanda", "S.Georgia & S.Sandwich Isls", "Saint Helena", "Saint Martin (FR)", "Samoa", "San Marino", "Sao Tome & Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (NL)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Sudan", "Spain", "Sri Lanka", "St Kitts & Nevis", "St Lucia", "St Paul & Amsterdam Isl", "St Pierre & Miquelon", "St Vincent & Grenadines", "Sudan", "Suriname", "Svalbard & Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syria", "Tahiti", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Togolese Rep", "Tokelau", "Tonga", "Trinidad & Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks & Caicos Isl", "Tuvalu", "Uganda", "Ukraine", "United Arab Emirates (UAE)", "United Kingdom (UK)", "United States (USA)", "Unknown", "Uruguay", "US Minor Outlying Isls", "US Virgin Islands", "Uzbekistan", "Vanuatu", "Vatican", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ] } }, "vessels": { "title": "🔢 IMO / MMSI numbers or ship names", "type": "array", "description": "Look up specific vessels: IMO numbers (7 digits, e.g. 9342516), MMSI numbers (9 digits, e.g. 565747000) or VesselFinder vessel URLs — one vessel page each. Anything else is searched as a ship name (prefix match: \"MAERSK\" finds every MAERSK …).", "items": { "type": "string" } }, "names": { "title": "🔎 Ship name search", "type": "array", "description": "Ship names or the start of a name, e.g. \"EVER\", \"MSC\", \"CMA CGM\" (at least 2 characters). Combined with the ship types, flags and filters below.", "items": { "type": "string" } }, "maxItems": { "title": "Max vessels", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of vessels for the whole run, shared fairly between your searches. 0 = everything (VesselFinder shows up to a few thousand vessels per search; split big searches by flag or type).", "default": 100 }, "includeDetails": { "title": "Include vessel details", "type": "boolean", "description": "Also open each vessel page for the MMSI, call sign, destination, ETA, current draught, navigation status, last position (area, rounded coordinates, course, speed) and name history. One extra request per vessel. Turn off for a fast list of name, IMO, type, flag, year, GT, DWT and size.", "default": true }, "minYear": { "title": "Built from (year)", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Only vessels built in or after this year." }, "maxYear": { "title": "Built until (year)", "minimum": 1800, "maximum": 2100, "type": "integer", "description": "Only vessels built in or before this year." }, "minLength": { "title": "Min length (m)", "minimum": 0, "maximum": 9999, "type": "integer", "description": "Only vessels at least this long (length overall, metres)." }, "maxLength": { "title": "Max length (m)", "minimum": 0, "maximum": 9999, "type": "integer", "description": "Only vessels at most this long (metres)." }, "minGT": { "title": "Min gross tonnage", "minimum": 0, "maximum": 999999, "type": "integer", "description": "Only vessels with at least this gross tonnage." }, "maxGT": { "title": "Max gross tonnage", "minimum": 0, "maximum": 999999, "type": "integer", "description": "Only vessels with at most this gross tonnage." }, "minDWT": { "title": "Min deadweight (t)", "minimum": 0, "maximum": 999999, "type": "integer", "description": "Only vessels with at least this deadweight (tonnes)." }, "maxDWT": { "title": "Max deadweight (t)", "minimum": 0, "maximum": 999999, "type": "integer", "description": "Only vessels with at most this deadweight (tonnes)." }, "includeOutOfService": { "title": "Include ships not in service", "type": "boolean", "description": "Also list ships VesselFinder marks as not in service (scrapped, laid up, lost). Off = ships in service only, like the website.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "default", "built", "gt", "dwt", "size" ], "type": "string", "description": "Order of search results. Default: largest gross tonnage first.", "default": "default" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Descending = newest / biggest first.", "default": "desc" }, "startUrls": { "title": "🔗 VesselFinder URLs", "type": "array", "description": "Optional: VesselFinder vessel list URLs (vesselfinder.com/vessels?… — the filters in the URL are kept) or vessel URLs (vesselfinder.com/vessels/details/).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If VesselFinder refuses datacenter IPs for a while, the run switches to residential proxies when your account has them.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }