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

url = "https://api.anysite.io/api/vesselfinder/vessels"

payload = {
"vessel": "<string>",
"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({vessel: '<string>', timeout: 300})
};

fetch('https://api.anysite.io/api/vesselfinder/vessels', 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/vessels",
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([
'vessel' => '<string>',
'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/vessels"

payload := strings.NewReader("{\n \"vessel\": \"<string>\",\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/vessels")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vessel\": \"<string>\",\n \"timeout\": 300\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"vessel\": \"<string>\",\n \"timeout\": 300\n}"

response = http.request(request)
puts response.read_body
[
  {
    "name": "<string>",
    "url": "<string>",
    "@type": "VesselFinderVessel",
    "imo": 123,
    "mmsi": 123,
    "ship_type": "<string>",
    "ais_type": "<string>",
    "flag": "<string>",
    "flag_code": "<string>",
    "callsign": "<string>",
    "year_built": 123,
    "length_overall": 123,
    "beam": 123,
    "gross_tonnage": 123,
    "deadweight": 123,
    "draught_max": 123,
    "image": "<string>",
    "destination": "<string>",
    "destination_locode": "<string>",
    "eta": 123,
    "course": 123,
    "speed": 123,
    "draught": 123,
    "navigation_status": "<string>",
    "position_received_at": 123,
    "last_port": "<string>",
    "last_port_locode": "<string>",
    "last_port_departure_at": 123,
    "history": []
  }
]
{
"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
vessel
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

name
string
required
url
string
required
@type
string
default:VesselFinderVessel
imo
integer | null
mmsi
integer | null
ship_type
string | null
ais_type
string | null
flag
string | null
flag_code
string | null
callsign
string | null
year_built
integer | null
length_overall
number | null
beam
number | null
gross_tonnage
integer | null
deadweight
integer | null
draught_max
number | null
image
string | null
destination
string | null
destination_locode
string | null
eta
integer | null
course
number | null
speed
number | null
draught
number | null
navigation_status
string | null
position_received_at
integer | null
last_port
string | null
last_port_locode
string | null
last_port_departure_at
integer | null
history
object[]