All Collections
API
Vessels Summary API
Vessels Summary API

Access vessel information from RightShip

Updated over a week ago

The Vessels API allows access to the latest safety and sustainability information for vessels.

What we offer

With the Vessel API you can:

  • retrieve the latest:

    • Safety Scores

    • GHG ratings

    • RightShip inspection statuses

    • Applicable restrictions

  • retrieve a list of vessels that have been modified after a specified date (for incremental load)

Usage

To use the Vessel API, you must have an account and obtain an Access Token by authenticating. All requests must be formatted as JSON and contain the following headers:

Name

Value

Authorization

Bearer <access-token>

Content-Type

application/json

Request Vessel Information

To request information for specific vessels, make a POST request to /vessel/v2/info with an array of IMO numbers in the body.

Example

Response sample:

Branding Guidelines

If you intend to show the Safety Score, GHG Rating or RightShip Inspection status to end-users within your own application, we ask that you adhere to the following guidelines:

Safety Score

Please find all branding, icons and imagery here: https://brand.rightship.com/product-branding/safety-score

  • If the score is -1, show N/A instead of the value

  • If the score is 0, show 0/5 plus an error icon with a tooltip of "No safety score"

  • Else, show the score out of 5 (e.g. 4/5)

  • Additionally, if the score is indicative then show a warning icon with a tooltip of "Indicative generated safety score"

Note: it is recommended to show the score date to the user for clarity.

GHG Rating

Please find all branding, icons and imagery here: https://brand.rightship.com/product-branding/ghg-rating

  • If the rating is U, show N/A instead of the value

  • If the plus flag is true, show the rating as is with a + symbol (e.g. A+) using the GHG plus icon and the appropriate icon and font colours (see table below).

  • Else, show the rating as is (e.g. A) using the GHG icon and the appropriate fill and font colours (see table below).

  • Additionally, show either Unverified or Verified based on the verified flag after the rating

Rating

Icon Colour

Font Colour

A

#00763B

#FFF

B

#AED36B

#001728

C

#FFDD15

#001728

D

#FFAA1C

#001728

E

#D71920

#001728

Note: it is recommended to show the rating date to the user for clarity.

RightShip Inspection

Please find all branding, icons and imagery here: https://brand.rightship.com/product-branding/vessel-inspections

  • If the inspection is Acceptable, show the badge icon with the colour #008561 and a tooltip of "This vessel has a valid RightShip inspection until <date>."

  • If the inspection is Acceptable but will expire within 60 days, show the badge icon with the colour #c78800 and a tooltip of "This vessel's RightShip inspection is valid for <remaining days> more days."

  • If the inspection is either Unacceptable or has Expired, show the badge icon with the colour #e61e2f and a tooltip of "This vessel requires a valid RightShip inspection."

Model Definition

The Vessels API will respond with a model containing the following data points.

Safety Score

Property

Value

Notes

safetyScore

-1

Vessel not rated

0

Vessel sanctioned

1-5

Vessel score

date

<UTC value>

When the score was calculated

indicativeScore

<true/false>

Whether the score is indicative

part of additionalData

docSafetyScore

1-5


part of additionalData

GHG Rating

Property

Value

Notes

rating

U

Vessel not rated

A-E

Vessel rating

ratingDate

<UTC value>

When the GHG rating was calculated

evdi

<float value>

The vessel EVDI at the time of the rating

part of additionalData

verified

<true/false>

Whether the GHG rating has been verified

part of additionalData

plus

Whether energy-saving equipment is installed

part of additionalData

eexi

<float value>

Attained EEXI

part of additionalData

ratingInput

<EVDI OR EEXI>

Latest amongst verified EVDI or EEXI that participates in GHG rating as SCI Input

part of additionalData

eexiStatus

<Not Required or Not Submitted or Submitted>

EEXI Submission status.

part of additionalData

RightShip Inspection

Property

Value

Description

required

<true/false>

Whether the vessel requires an inspection

lastInspectionOutcome

Acceptable

Unacceptable

Expired

lastInspectionValidity

<date value>

When the inspection will expire

Restrictions

Property

Value

Description

listName

<string>

Name of the list the restriction is from

listType

Vessel

Restriction is directly applied to the vessel

Company

Restriction is indirectly applied via a related company

name

<string value>

Name of the restricted vessel or company

imo

<string value>

IMO Ship Number of the restricted vessel (if applicable)

owCode

<string value>

IMO Company Number of the restricted company (if applicable)

comment

<string value>

A comment or reason relating to the restriction

effectiveFrom

<date value>

When the restriction began

effectiveTo

<date value>

When the restriction ended or will end

9999-01-01 indicates the restriction is indefinite

Miscellaneous Properties

Property

Value

Description

restrictedByRightShip

<true/false>

Whether the vessel has been restricted for vetting by RightShip

platformLink

<URL value>

A direct link to the vessel page on the RightShip Platform

Did this answer your question?