DAdatalastic
Location Traffic

All vessels currently within an area

Changed on

Scan a circular area for all vessels currently inside the radius.

The centre can be static (lat + lon, or a port by port_uuid / port_unlocode) or dynamic, following a vessel by uuid, mmsi, or imo. Pass exactly one centre. The full result set is returned in a single response and data.total gives the record count.

Credit cost: 1 per vessel found, capped at 500 credits per request.

get/api/v0/vessel_inradius

Request

Query parameters

latnumber float

Centre latitude. Use with lon.

lonnumber float

Centre longitude. Use with lat.

port_uuidstring uuid

Port UUID as the centre (alternative to lat/lon).

port_unlocodestring

Port UN/LOCODE as the centre (alternative to lat/lon).

uuidstring uuid

Vessel UUID as a dynamic centre. The scan follows the vessel's current position.

mmsistring

Vessel MMSI as a dynamic centre.

imostring

Vessel IMO as a dynamic centre.

radiusnumber float required

Search radius in nautical miles. Maximum 50.

typestring

Filter by vessel type (e.g. Cargo, Tanker).

type_specificstring

Filter by vessel subtype (e.g. Container Ship).

excludestring

Exclude certain vessel types from the result.

_empty_boolean

Include or exclude vessels with a null type.

nav_statusinteger

Filter by AIS navigational status code.

Response

Vessels found within the area.

Example response

{
  "data": [
    {
      "uuid": "b8625b67-7142-cfd1-7b85-595cebfe4191",
      "name": "MAERSK CHENNAI",
      "mmsi": "566093000",
      "imo": "9525338",
      "country_iso": "SG",
      "country_name": "Singapore",
      "type": "Cargo - Hazard A (Major)",
      "type_specific": "Container Ship",
      "lat": 6.303473,
      "lon": 3.201678,
      "speed": 14.2,
      "course": 326,
      "heading": 226,
      "navigational_status": "Under way using engine",
      "destination": "ROTTERDAM",
      "last_position_epoch": 1624127400,
      "last_position_UTC": "2021-06-20T08:30:00Z",
      "area": "North Sea"
    }
  ],
  "meta": {
    "duration": 0.012,
    "endpoint": "/api/v0/vessel",
    "success": true,
    "next": "00e32b7a-4067-d6b2-8d73-2bdda4fe72bb"
  }
}

Changes

  • a29cf323d1c3Revision changes
    • breaking

      the query request parameter radius became required

    • warning

      for the query request parameter radius, the max was set to 50.00

    • warning

      deleted the query request parameter api-key

    • info

      added the new optional query request parameter _empty_

    • info

      added the new optional query request parameter exclude

    • info

      added the new optional query request parameter imo

    • info

      added the new optional query request parameter mmsi

    • info

      added the new optional query request parameter nav_status

    • info

      added the new optional query request parameter port_uuid

    • info

      added the new optional query request parameter uuid

    • info

      for the query request parameter radius, the type was generalized from integer to number, and format from no format to float

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status