VesselFinder data contract | PatchOps Knowledge

Provenance

PublisherVesselFinder

API basehttps://api.vesselfinder.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (API key)

Methods (7)

getVessels

read

Get vessel master and position data by IMO/MMSI/name (VesselFinder).

Input schema

{
  "type": "object",
  "properties": {
    "imo": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "mmsi": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "shipname": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getVesselsList

read

List vessels by type or bounding box (AIS).

Input schema

{
  "type": "object",
  "properties": {
    "imo": {
      "type": "string"
    },
    "mmsi": {
      "type": "string"
    },
    "shiptype": {
      "type": "string"
    },
    "bbox": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "additionalProperties": false
}

getLiveData

read

Get live AIS vessel positions by type, flag, or bbox (VesselFinder).

Input schema

{
  "type": "object",
  "properties": {
    "bbox": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "shiptype": {
      "type": "string"
    },
    "flag": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getPortCalls

read

Get vessel port calls (arrivals and departures).

Input schema

{
  "type": "object",
  "properties": {
    "imo": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "mmsi": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "port_id": {
      "type": "string"
    },
    "fromdate": {
      "type": "string"
    },
    "todate": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getExpectedArrivals

read

Get expected vessel arrivals at a port.

Input schema

{
  "type": "object",
  "properties": {
    "port_id": {
      "type": "string"
    },
    "shiptype": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getMasterData

read

Get vessel master particulars by IMO.

Input schema

{
  "type": "object",
  "properties": {
    "imo": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "imo"
  ]
}

getDistance

read

Get sea distance/route between two ports.

Input schema

{
  "type": "object",
  "properties": {
    "fromport": {
      "type": "string"
    },
    "toport": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "fromport",
    "toport"
  ]
}