Skip to main content
POST
/
api
/
vesselfinder
/
ports
/
search
/vesselfinder/ports/search
curl --request POST \
  --url https://api.anysite.io/api/vesselfinder/ports/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300
}
'
import requests

url = "https://api.anysite.io/api/vesselfinder/ports/search"

payload = {
"count": 2,
"timeout": 300
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({count: 2, timeout: 300})
};

fetch('https://api.anysite.io/api/vesselfinder/ports/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/vesselfinder/ports/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'count' => 2,
'timeout' => 300
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.anysite.io/api/vesselfinder/ports/search"

payload := strings.NewReader("{\n \"count\": 2,\n \"timeout\": 300\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/vesselfinder/ports/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 2,\n \"timeout\": 300\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.anysite.io/api/vesselfinder/ports/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"count\": 2,\n \"timeout\": 300\n}"

response = http.request(request)
puts response.read_body
[
  {
    "locode": "<string>",
    "name": "<string>",
    "url": "<string>",
    "@type": "VesselFinderPortSearchResult",
    "country": "<string>",
    "country_code": "<string>"
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
country
enum<string> | null
Available options:
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,
DPR Korea,
DR Congo,
Denmark,
Djibouti,
Dominica,
Dominican Rep,
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,
US Minor Outlying Isls,
US Virgin Islands,
Uganda,
Ukraine,
United Arab Emirates (UAE),
United Kingdom (UK),
United States (USA),
Unknown,
Uruguay,
Uzbekistan,
Vanuatu,
Vatican,
Venezuela,
Vietnam,
Wallis and Futuna,
Western Sahara,
Yemen,
Zambia,
Zimbabwe

Response

Successful Response

locode
string
required
name
string
required
url
string
required
@type
string
default:VesselFinderPortSearchResult
country
string | null
country_code
string | null