Ships
This resource allows you to fetch information about vessels.

This API allows you to fetch information about vessels in Octopi. It returns the basic info about the vessel. If the vessel recently completed a voyage, then it also returns information about that last voyage.

Supported Formats

json
>>>

GET /api/v1/vessels/:name

Returns information about the vessel and the last voyage (if present)

Supported Formats

json

Errors

Code Description
404 Not found.
500 Server crashed.

Examples

curl "https://app.octopi.co/api/v1/vessels/ADD VESSEL NAME HERE.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

  {
   "vessel" : {
      "gross_tonnage" : 9957,
      "call_sign" : "6YSO4",
      "imo_number" : "9403451",
      "length_overall" : "148m × 23.25m",
      "actions" : {
         "show" : {
            "method" : "GET",
            "url" : "https://app.octopi.co/api/v1/vessels/CFS%20Paceno.json"
         }
      },
      "name" : "CFS Paceno"
   }
}

Params

Param name Description
name
optional

Validations:

  • Must be a String