Spire Maritime data contract | PatchOps Knowledge

Provenance

PublisherSpire Maritime

API basehttps://api.sml.kpler.com/graphql

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (Bearer token)

Methods (5)

getVessels

read

Get live vessel positions and data by IMO/MMSI/type/flag/bbox (Spire Maritime).

Input schema

{
  "type": "object",
  "properties": {
    "imo": {
      "type": "number"
    },
    "mmsi": {
      "type": "number"
    },
    "bbox": {
      "type": "object",
      "properties": {
        "latMin": {
          "type": "number"
        },
        "lonMin": {
          "type": "number"
        },
        "latMax": {
          "type": "number"
        },
        "lonMax": {
          "type": "number"
        }
      },
      "required": [
        "latMin",
        "lonMin",
        "latMax",
        "lonMax"
      ],
      "additionalProperties": false
    },
    "shipType": {
      "type": "string"
    },
    "flag": {
      "type": "string"
    },
    "first": {
      "type": "number"
    },
    "after": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

getPortEventsByVessel

read

Get a vessel port events by IMO/MMSI and date range.

Input schema

{
  "type": "object",
  "properties": {
    "imo": {
      "type": "number"
    },
    "mmsi": {
      "type": "number"
    },
    "startDate": {
      "type": "string"
    },
    "endDate": {
      "type": "string"
    },
    "first": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getPortEventsByLocation

read

Get port events at a port or location by date.

Input schema

{
  "type": "object",
  "properties": {
    "portId": {
      "type": "string"
    },
    "unlocode": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "endDate": {
      "type": "string"
    },
    "shipType": {
      "type": "string"
    },
    "first": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

getPort

read

Get a port record by id or UNLOCODE.

Input schema

{
  "type": "object",
  "properties": {
    "portId": {
      "type": "string"
    },
    "unlocode": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

matchedPort

unknown

Fuzzy-match ports by a name or query string.

Entitiesport

Input schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "first": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "query"
  ]
}