Embed voyage
optimization
in any product.

# 1. Verify your key
curl https://api.vesselfront.com/v1/organization \
  -H "X-API-Key: vf_live_your_key_here"

# 2. Create a vessel profile
curl -X POST https://api.vesselfront.com/v1/vessel \
  -H "X-API-Key: vf_live_your_key_here" \
  -d '{ "name":"MV Atlantic Star", "dwt":75000, "loa":229, "lbp":220,
        "breadth":32.2, "depth":20.1, "draftDesign":14.5,
        "serviceSpeed":14.5, "draftScant":15.0, "pitch":5.2,
        "dateConstructed":"2015-06-01" }'

# 3. Optimize a route
curl -X POST https://api.vesselfront.com/v1/charting \
  -H "X-API-Key: vf_live_your_key_here" \
  -d '{ "vesselId":"<vessel-id-from-step-2>",
        "portFromName":"AABENRAA", "portToName":"AAHEIM",
        "latFrom":55.03, "lngFrom":9.46,
        "latTo":62.06, "lngTo":5.51,
        "startDate":"2026-06-01T00:00:00.000Z",
        "speedRangeMin":11, "speedRangeMax":13,
        "draft":14, "trim":2, "rpm":55,
        "dwt":68439, "lbp":220, "pitch":5.435,
        "optimizationType":"1", "routeType":"1" }'

import requests

BASE = "https://api.vesselfront.com/v1"
HEADERS = {"X-API-Key": "vf_live_your_key_here"}

# 1. Verify your key
org = requests.get(f"{BASE}/organization", headers=HEADERS).json()
print(org["name"])

# 2. Create a vessel profile
vessel = requests.post(f"{BASE}/vessel", headers=HEADERS, json={
    "name": "MV Atlantic Star", "dwt": 75000,
    "loa": 229, "lbp": 220, "breadth": 32.2,
    "depth": 20.1, "draftDesign": 14.5,
    "serviceSpeed": 14.5, "draftScant": 15.0,
    "pitch": 5.2, "dateConstructed": "2015-06-01",
}).json()

# 3. Optimize a route
charting = requests.post(f"{BASE}/charting", headers=HEADERS, json={
    "vesselId":       vessel["id"],
    "portFromName":   "AABENRAA",
    "portToName":     "AAHEIM",
    "latFrom": 55.03, "lngFrom": 9.46,
    "latTo":   62.06, "lngTo":   5.51,
    "startDate":      "2026-06-01T00:00:00.000Z",
    "speedRangeMin":  11, "speedRangeMax": 13,
    "draft": 14, "trim": 2, "rpm": 55,
    "dwt": 68439, "lbp": 220, "pitch": 5.435,
    "optimizationType": "1", "routeType": "1",
}).json()
print(charting["id"])

const BASE = "https://api.vesselfront.com/v1";
const HEADERS = { "X-API-Key": "vf_live_your_key_here",
                  "Content-Type": "application/json" };
const api = (path, body) => fetch(BASE + path, {
  method: body ? "POST" : "GET",
  headers: HEADERS,
  body: body ? JSON.stringify(body) : undefined,
}).then(r => r.json());

// 1. Verify your key
const org = await api("/organization");
console.log(org.name);

// 2. Create a vessel profile
const vessel = await api("/vessel", {
  name: "MV Atlantic Star", dwt: 75000,
  loa: 229, lbp: 220, breadth: 32.2,
  depth: 20.1, draftDesign: 14.5,
  serviceSpeed: 14.5, draftScant: 15.0,
  pitch: 5.2, dateConstructed: "2015-06-01",
});

// 3. Optimize a route
const charting = await api("/charting", {
  vesselId: vessel.id,
  portFromName: "AABENRAA", portToName: "AAHEIM",
  latFrom: 55.03, lngFrom: 9.46,
  latTo:   62.06, lngTo:   5.51,
  startDate: "2026-06-01T00:00:00.000Z",
  speedRangeMin: 11, speedRangeMax: 13,
  draft: 14, trim: 2, rpm: 55,
  dwt: 68439, lbp: 220, pitch: 5.435,
  optimizationType: "1", routeType: "1",
});
console.log(charting.id);