Port Calls By Port

GET

port-calls-by-port

Port Calls By Port

curl --request GET \
  --url https://datadocked.com/api/vessels_operations/port-calls-by-port \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://datadocked.com/api/vessels_operations/port-calls-by-port', 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://datadocked.com/api/vessels_operations/port-calls-by-port",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://datadocked.com/api/vessels_operations/port-calls-by-port"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://datadocked.com/api/vessels_operations/port-calls-by-port")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "total": 123,
  "pages": 123,
  "page": 123,
  "list": [
    {
      "mmsi": "<string>",
      "name": "<string>",
      "imo": "<string>",
      "shipType": "<string>",
      "year": "<string>",
      "country": "<string>",
      "a2": "<string>",
      "gt": "<string>",
      "dw": "<string>",
      "sa": "<string>",
      "length": "<string>",
      "beam": "<string>",
      "etaUtc": "<string>",
      "destination": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Retrieve vessel traffic data for a specific port including arrivals, departures, expected vessels, and vessels currently in port.

Credits: 50 credits per request

Search Types

Use the search_type parameter to filter results:

Type	Description
`arrival`	Recently arrived vessels
`departure`	Recently departed vessels
`expected`	Vessels expected to arrive
`in_port`	Vessels currently in port

Port Codes

Use UN/LOCODE format for the port_call parameter:

Port	UN/LOCODE
Barcelona, Spain	ESBCN
Rotterdam, Netherlands	NLRTM
Singapore	SGSIN
Shanghai, China	CNSHA
Los Angeles, USA	USLAX

Pagination

Results are paginated. Use the page parameter (starting from 1) to navigate through results.

Optional Filtering

Use vessel_type to filter results by vessel category.

Response Data

All four search_type options return the same field set — a single parser handles the entire endpoint.

Field	Type	Description
`total`	integer	Total vessels matching criteria
`pages`	integer	Total pages available
`page`	integer	Current page number
`list`	array	Array of vessel objects

Each vessel in list:

Field	Type	Description
`mmsi`	string \| null	MMSI number
`name`	string \| null	Vessel name
`imo`	string \| null	IMO number
`shipType`	string \| null	Vessel type
`year`	string \| null	Year built
`country`	string \| null	Flag country
`a2`	string \| null	2-letter country code
`gt`	string \| null	Gross tonnage
`dw`	string \| null	Deadweight tonnage
`sa`	string \| null	Ship active status
`length`	string \| null	Length in whole metres
`beam`	string \| null	Beam in whole metres
`etaUtc`	string \| null	ETA in UTC
`destination`	string \| null	Next destination port

All values are strings or null. mmsi and imo are returned as strings — not numbers. length and beam are separate fields in whole metres (previously a combined sizes string).

Authorizations

x-api-key

string

header

required

Your personal API key found in your profile dashboard at https://datadocked.com/dashboard/my_keys

Query Parameters

port_call

string

required

The UN/LOCODE of the port you want to query (e.g., ESBCN for Barcelona).

search_type

enum<string>

required

The type of search to perform.

Available options:

arrival,

departure,

expected,

in_port

page

integer

required

Page number for pagination. Pagination starts with page number 1.

Required range: x >= 1

vessel_type

string

Filter results by vessel type.

Response

Successful response with port traffic data

total

integer

Total vessels matching criteria

pages

integer

Total pages available

page

integer

Current page number

list

object[]

Show child attributes

Port Calls By Port

curl --request GET \
  --url https://datadocked.com/api/vessels_operations/port-calls-by-port \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://datadocked.com/api/vessels_operations/port-calls-by-port', 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://datadocked.com/api/vessels_operations/port-calls-by-port",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://datadocked.com/api/vessels_operations/port-calls-by-port"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://datadocked.com/api/vessels_operations/port-calls-by-port")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "total": 123,
  "pages": 123,
  "page": 123,
  "list": [
    {
      "mmsi": "<string>",
      "name": "<string>",
      "imo": "<string>",
      "shipType": "<string>",
      "year": "<string>",
      "country": "<string>",
      "a2": "<string>",
      "gt": "<string>",
      "dw": "<string>",
      "sa": "<string>",
      "length": "<string>",
      "beam": "<string>",
      "etaUtc": "<string>",
      "destination": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Overview

Account

Vessel Operations

Port Operations

Search Types

Port Codes

Optional Filtering

Response Data

Authorizations

Query Parameters

Response

​Search Types

​Port Codes

​Pagination

​Optional Filtering

​Response Data

Authorizations

Query Parameters

Response

Search Types

Port Codes

Pagination

Optional Filtering

Response Data