Skip to content

Python - Routes

The API Data Explorer tool is useful for picking elements from the JSON dictionary that the API returns. The endpoint used is the following: /v1.0/routes/{route_uuid}/?release-date={}/.

jsonc
{
  "errors": [],
  "data": {
    "uuid": "123-asdf-1249-249092b23",
    "name": "NWS to Gate (via Suez)",
    "loadPortUuid": "ab-124i-aslkn-1234",
    "dischargePortUuid": "ed-1239-qwlekse",
    "via": "suez",
    "congestionDays": 0,
    "assumptions": [
      {
        "type": "load-port",
        "value": "NWS",
        "unit": null
      },
      {
        "type": "discharge-port",
        "value": "Gate",
        "unit": null
      },
      {
        "type": "distance",
        "value": "9,555",
        "unit": "NM"
      },
      {
        "type": "round-trip-duration",
        "value": "55",
        "unit": "days"
      },
      {
        "type": "flex-days",
        "value": "4",
        "unit": "days"
      },
      {
        "type": "port-days",
        "value": "2",
        "unit": "days"
      },
      {
        "type": "congestion-days",
        "value": "0",
        "unit": "days"
      },
      {
        "type": "canal-days",
        "value": "2",
        "unit": "days"
      },
      {
        "type": "discharge-volume",
        "value": "3,456,118",
        "unit": "MMBtu"
      },
      {
        "type": "discharge-volume-174",
        "value": "3,780,827",
        "unit": "MMBtu"
      },
      {
        "type": "lng-freight-rate-source",
        "value": "Spark25FFA",
        "unit": null
      },
      {
        "type": "canal-cost-discount-percentage",
        "value": "0",
        "unit": null
      },
      {
        "type": "canal-cost-discount-percentage-174",
        "value": "0",
        "unit": null
      },
      {
        "type": "port-and-canal-cost-source",
        "value": "GAC",
        "unit": null
      },
      {
        "type": "vessel-size",
        "value": "160,000",
        "unit": "m3"
      },
      {
        "type": "vessel-size-174",
        "value": "174,000",
        "unit": "m3"
      },
      {
        "type": "vessel-speed",
        "value": "17",
        "unit": "knots"
      },
      {
        "type": "vessel-technology",
        "value": "TFDE",
        "unit": null
      },
      {
        "type": "vessel-technology-174",
        "value": "2 stroke",
        "unit": null
      },
      {
        "type": "fuel",
        "value": "LNG boil-off",
        "unit": null
      },
      {
        "type": "boil-off-rate",
        "value": "0.10%",
        "unit": null
      },
      {
        "type": "boil-off-rate-174",
        "value": "0.085%",
        "unit": null
      },
      {
        "type": "lng-price-source",
        "value": "ICE JKM",
        "unit": null
      },
      {
        "type": "lng-conversion",
        "value": "23",
        "unit": null
      },
      {
        "type": "discharge-port-is-part-of-eu",
        "value": "yes",
        "unit": null
      },
      {
        "type": "load-port-is-part-of-eu",
        "value": "no",
        "unit": null
      },
      {
        "type": "days-in-eu-port",
        "value": "1",
        "unit": null
      },
      {
        "type": "days-in-non-eu-port",
        "value": "1",
        "unit": null
      }
    ],
    "dataPoints": [
      {
        "deliveryPeriod": {
          "type": "spot",
          "startAt": "2024-08-27",
          "endAt": "2024-09-26",
          "name": "Spot (Physical)"
        },
        "costInUsdPerDay": {
          "total": "9120206",
          "fuel": "1362005",
          "hire": "4071230",
          "port": "201202",
          "canal": "1909201",
          "carbon": "112446"
        },
        "costsInUsd": {
          "total": "9524506",
          "fuel": "2364507",
          "hire": "4774550",
          "port": "451302",
          "canal": "4563201",
          "carbon": "457446"
        },
        "costsInUsdPerMmbtu": {
          "total": "2.00",
          "fuel": "0.01",
          "hire": "1.03",
          "port": "0.05",
          "canal": "0.12",
          "carbon": "0.56"
        }
      }
      //-----------**...**-------------
    ]
  }
}

Note

----**...**---- denotes repetition of the above dictionary

▲ prices and dates are given for sample purposes only

For simplicity, the JSON dictionary is denoted as response_json.

Indexation

Route UUID:

response_json["data"]["uuid"]

Via Point:

response_json["data"]["via"]

Load Port Name:

response_json["data"]["assumptions"][0]["value"]

Discharge Port Name:

response_json["data"]["assumptions"][1]["value"]

Delivery Period Start:

response_json["data"]["dataPoints"][0]["deliveryPeriod"]["startAt"]

Delivery Period End:

response_json["data"]["dataPoints"][0]["deliveryPeriod"]["endAt"]

Discharge Volume (174 2-Stroke):

response_json["data"]["assumptions"][9]["value"]

Hire Cost USD/MMBtu:

response_json["data"]["dataPoints"][0]["costsInUsdPerMmbtu"]["hire"]

Fuel Cost USD/MMBtu:

response_json["data"]["dataPoints"][0]["costsInUsdPerMmbtu"]["fuel"]

Total Cost USD/MMBtu:

response_json["data"]["dataPoints"][0]["costsInUsdPerMmbtu"]["total"]

The JSON dictionary is the result of a successful request to the Route API endpoint using the Route UUID as the unique identifier for the NWS to Gate (via Suez) route, for the 12th of August 2024. The Load Port, Discharge Port and Via Point all have their respective UUIDs, and can be called separately to learn more information about them. The discharge volume, vessel size, and boil-off rate are assumptions used for voyage cost calculation; in this case the default vessel used is the 174 2-stroke, although the 160 TFDE vessel is also available at this endpoint. The Total Cost (USD/Day and USD/MMBtu), Hire and Fuel Cost are one of the costs available for the specific Delivery Period.