Developer Portal
InsightsPurpleTRAC
MTIPodium
Other
Other
  • Weather
InsightsPurpleTRAC
MTIPodium
Other
Other
  • Weather
  1. Screening
  • Start Here
    • Overview
    • Getting started
    • Authentication
    • Testing
    • Errors & status codes
    • FAQ
  • General
    • Retrieve a list of vessels
    • Additional entity search
  • Screening
    • Screening a vessel
    • Watchlist checks
    • Additional checks
    • Movement history
    • Carbon rating
    • Submit a vessel for screening
      POST
    • Retrieve a list of transactions and their screening results
      GET
    • Ship & Flag Watchlist check
      GET
    • Company Watchlist check
      GET
    • Country Sanctions check
      GET
    • Ship movement history
      GET
    • Ship-to-Ship (STS) pairing screening
      GET
    • Company history check
      GET
    • P&I Club check
      GET
    • Vessel operational status
      GET
    • Flag history check
      GET
    • AIS positional discrepancy (spoofing) events
      GET
    • Periods of Non-Reporting
      GET
    • Carbon rating details
      GET
    • Get the PurpleTRAC Screening Report PDF
      GET
    • Submit a vessel for rescreening
      PUT
    • Archive a Screening
      PUT
  • Tracking
    • Voyage updates
    • Notification catalogue
    • Additional entities
    • Tracking a vessel
    • Enable a vessel for tracking
    • Remove additional entities from a tracked vessel
    • Add additional entities to a tracked vessel
    • List the additional entities on a transaction
    • Update voyage and tracking details
    • Get vessel positional data
    • Retrieve a list of vessel or bill of lading notifications
    • Get the PurpleTRAC Trade Report PDF
  • Bill of Lading
    • Carriers
    • Verification
    • Submit a Bill of Lading for screening
    • Get all BL Screening Results
    • Get a single BL screening result
    • Get the PurpleTRAC Bill of Lading Screening Report PDF
    • Enable tracking for a screened Bill of Lading
    • Get the PurpleTRAC Bill of Lading Tracking Report PDF
    • Disable tracking for a Bill of Lading
  • Containers
    • Screening
    • Carriers
    • Submit a Container for screening
    • Get all Container Screening Results
    • Archive Container
    • Get a single Container screening result
    • Get the Container report
  • Schemas
    • BLVGetAllResultsResponse
    • BLVScreeningResponse
    • BLVLastScreeningResult
    • BLVScreeningResultDetails
    • ContainerRegistrationBody
    • ContainerRegistrationResponse
    • ContainerGetAllResultsResponse
    • ContainerScreeningResponse
    • CarbonRatings
    • CarbonRating
    • CompanySanctions
    • CompanySanction
    • CountryChecks
    • CountryCheck
    • StsPairings
    • StsPairing
    • OtherAssociations
    • OtherAssociation
    • CompanyHistoryChecks
    • CompanyHistoryCheck
    • ShipStatuses
    • ShipStatus
    • FlagHistoryChecks
    • FlagHistoryCheck
    • PositionalDiscrepancies
    • PositionalDiscrepancy
    • DiscrepancyZone
    • DiscrepancyPort
    • NonReportingResponse
    • NonReporting
    • Notifications
    • Notification
    • BLVNotification
    • BLVPortFull
    • BLVPortFallback
    • PortCallHistory
    • PortCallHistoryItem
    • Positions
    • Position
    • PositionInfo
    • RegistrationResponse
    • ShipDetails
    • ShipSanctions
    • ShipSanction
    • VesselTrackingResponse
    • VesselTransactionsResponse
    • Transaction
    • TransactionPutBody
    • TransactionPutResponse
    • TransactionRescreenResponse
    • LastPosition
    • ScreeningNotification
    • ScreeningResult
    • UserDetails
    • UserProfile
    • Error
    • InvalidContainerNumberResponse
    • VesselRegistrationBody
    • VesselTrackingRequest
    • BLRegistrationBody
    • AdditionalEntitySearchResponse
    • AdditionalEntity
    • AdditionalEntitiesRequestSchema
    • TrackingAdditionalEntity
    • TrackingAdditionalEntitiesResponse
    • TrackingAdditionalEntityInput
    • TrackingAdditionalEntitiesPutBody
    • TrackingAdditionalEntitiesPutResponse
    • TrackingAdditionalEntitiesDeleteBody
    • RemovedAdditionalEntity
    • TrackingAdditionalEntitiesDeleteResponse
    • TrackingAdditionalEntityError
    • FeatureDisabledError
    • ObjectNotFoundError
    • TransactionValidationError
    • VoyageUpdateRequest
    • VoyageUpdateResponse
    • PTracMeta
    • PTracVessel
    • PTracVesselSearchResponse
    • DuplicateTransactionError
  1. Screening

Vessel Carbon Rating

Carbon rating reports a vessel's emissions efficiency alongside its compliance result. You ask for it when you register the vessel, and read it back from GET /carbonrating once the screening has finished.
Carbon rating is an addon
It is available to subscribing customers only. Contact your Pole Star representative to have it enabled on your account.

Ask for it at registration#

Carbon rating is part of the screening, not a separate call, so the vessel has to be registered with it switched on. Add carbon_rating to the POST /registration body.
Screening a Vessel covers the rest of registration and how to tell when the screening has completed.

Find the id#

Carbon rating results hang off their own screen result id. In the screen_results array returned by GET /transaction, find the object whose check is CARBON_RATING.
{
  "check": "CARBON_RATING",
  "creation_date": "2022-05-05T14:01:31Z",
  "id": 4261273,
  "resource_uri": "/api/v1/screenresult/4261273",
  "result_code": null,
  "status": "OK"
}

Retrieve the rating#

Pass that id as the screenresult parameter.
{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "aer_alignment": 1.0100000000000002,
            "annual_efficiency_ratio": 4.62,
            "annual_efficiency_ratio_unit": "AER [gCO₂ / dwt · n miles]",
            "breadth": 32.26,
            "dead_weight": 63242.0,
            "depth": 18.5,
            "id": 8035,
            "length": 199.9,
            "name": "BERLINDA",
            "peer_group_size": 1892,
            "percentile": 0.0,
            "poseidon_principles_aer_trajectory_value": 3.61,
            "rating": 30,
            "rating_date": "2023-04-15",
            "rating_median": 8.03,
            "rating_peer_group_def": "Bulk Carrier, Deadweight 63242 +- 10.0%",
            "reporting_year": 2021,
            "resource_uri": "/api/v1/carbonrating/8035",
            "screenresult": "/api/v1/screenresult/4261273",
            "severity": "WARNING",
            "ship_type_level4": "Bulk Carrier",
            "source_method": "Matching to sister ships",
            "source_name": "Derived from sibling vessels in the EU MRV",
            "transport_work_emission_factor": 7.64,
            "transport_work_emission_factor_unit": "Annual average CO₂ emissions per transport work (mass) [g CO₂ / m tonnes · n miles]"
        }
    ]
}

What the response tells you#

The headline figures are annual_efficiency_ratio, the vessel's AER for the reporting_year, and severity, the band PurpleTRAC puts that figure in. Severity bands are set by your account configuration, so the same AER can read OK on one account and WARNING on another.
The rest gives you the context to defend the number:
rating_peer_group_def and peer_group_size say which vessels the rating was compared against, here 1,892 bulk carriers within 10% of the same deadweight. rating_median and percentile place the vessel inside that group.
poseidon_principles_aer_trajectory_value is the Poseidon Principles trajectory for the vessel, and aer_alignment its position against it.
source_name and source_method say where the figure came from. A vessel that reports to the EU MRV directly reads differently from one whose figure is derived from sister ships, and this example is the second kind.
Dimensions travel with the record too: length, breadth, depth, dead_weight and ship_type_level4.

Related#

Screening Vessels
Registration, the transaction id, and reading screen_results.
Getting Started
Which addons your account configuration gates, and what a 403 means.
Additional Checks
The other detailed checks a screening produces.
Modified at 2026-10-01 09:44:12
Previous
Movement history
Next
Submit a vessel for screening
Built with