API Documentation
Welcome to the DataDocked API!
The DataDocked API provides detailed information about vessels by utilizing their IMO or MMSI numbers. This guide will help you get started quickly and effectively, with examples in various programming languages.
Getting Started
Step 1: Register
Create an account on our platform at datadocked.com.
Step 2: Verify Your Email
Activate your account by clicking the verification link sent to your registered email.
Step 3: Generate Your API Key
Log in to your account, navigate to your profile dashboard, and generate your unique API key.
Making Requests
Endpoint
GET http://datadocked.com/api/get-vessel-info
Required Parameters:
api_key (required):
Your personal API key, found in your profile dashboard
imo_or_mmsi (required):
The IMO or MMSI number of the vessel you want to query.
Example Request:
http://datadocked.com/api/get-vessel-info?api_key=YOUR_API_KEY&imo_or_mmsi=VESSEL_IMO_OR_MMSI_NUMBER
Response Format
The API responds with a JSON object containing detailed vessel information:
Sample JSON Response:
{
"detail": {
"vessel_info": {
"name": "MSC AMELIA",
"mmsi": "636020543",
"imo": "9896995",
"country_iso": "LR",
"country": "Liberia",
"ship_type": "Cargo vessels",
"type_specific": "Container Ship",
"navigational_status": "Under way",
"callsign": "D5ZR4",
"gross_tonnage": "228786",
"length": "400 m",
"beam": "61 m",
"year_of_built": "2021",
"current_draught": "12.6 m",
"deadweight": "255288",
"latitude": "-22.76091",
"longitude": "12.65094",
"destination": "Singapore",
"last_port": "Ashdod, Israel"
}
}
}Common Responses:
200 OK:
The request was successful, and vessel details are returned
404 Not Found:
The vessel information could not be found
Code Examples
import requests
import json
api_key = 'YOUR_API_KEY'
imo_or_mmsi = 'VESSEL_IMO_OR_MMSI_NUMBER'
url = f"http://datadocked.com/api/get-vessel-info?api_key={api_key}&imo_or_mmsi={imo_or_mmsi}"
response = requests.get(url)
if response.status_code == 200:
print(response.json())
else:
print(f"Error: {response.status_code}, {response.text}")Support
If you need help or have any questions, please don't hesitate to contact us at support@datadocked.com.
