Basic search - search any vessel by a keyword

Example basic vessel search by free-form keyword such as MMSI, IMO, callsign or shipname, returning ranked paginated results.

This endpoint searches for a vessel given a free form query. The query will be matched against any identifiers for the vessel, and a paginated, ranked results list will be returned. It allows you to perform a basic search of a vessel by sending some identifier, for example: MMSI, IMO, CALL SIGN, Shipname, etc.

Query parameters

Parameter	Value	Description
`query`	`368045130`	Free-form search term (MMSI, IMO, callsign, shipname, etc.)
`datasets[0]`	`public-global-vessel-identity:latest`	Vessel identity dataset
`includes[0]`	`MATCH_CRITERIA`	Include match criteria in the response
`includes[1]`	`OWNERSHIP`	Include ownership info in the response
`includes[2]`	`AUTHORIZATIONS`	Include authorizations info in the response

Request

# Make sure to replace [TOKEN] with your API Access Token.
curl --location --request GET 'https://gateway.api.globalfishingwatch.org/v3/vessels/search?query=368045130&datasets[0]=public-global-vessel-identity:latest&includes[0]=MATCH_CRITERIA&includes[1]=OWNERSHIP&includes[2]=AUTHORIZATIONS' \
  -H "Authorization: Bearer [TOKEN]"

result = await gfw_client.vessels.search_vessels(
    query="368045130",
    datasets=["public-global-vessel-identity:latest"],
    includes=["MATCH_CRITERIA", "OWNERSHIP", "AUTHORIZATIONS"],
)

gfw_vessel_info(
  query = "368045130",
  search_type = "search",
  includes = c("MATCH_CRITERIA", "OWNERSHIP", "AUTHORIZATIONS")
)

// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
  'https://gateway.api.globalfishingwatch.org/v3/vessels/search?query=368045130&datasets[0]=public-global-vessel-identity:latest&includes[0]=MATCH_CRITERIA&includes[1]=OWNERSHIP&includes[2]=AUTHORIZATIONS',
  { headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()

Response

{
  "limit": 30,
  "since": null,
  "total": 1,
  "entries": [
    {
      "dataset": "public-global-vessel-identity:v3.0",
      "registryInfoTotalRecords": 1,
      "registryInfo": [
        {
          "id": "db2d2e9437254280b9ccc8c59e8c8ccb",
          "sourceCode": ["IMO", "USA"],
          "ssvid": "368045130",
          "flag": "USA",
          "shipname": "MISS FREYA",
          "nShipname": "MISSFREYA",
          "callsign": "WDK3424",
          "imo": "8969513",
          "latestVesselInfo": true,
          "transmissionDateFrom": "2019-02-01T19:28:14Z",
          "transmissionDateTo": "2023-07-31T08:10:29Z",
          "geartype": ["FISHING"],
          "lengthM": null,
          "tonnageGt": 171,
          "vesselInfoReference": "4e4b5501-c2cf-4384-8051-c3affacb0229"
        }
      ],
      "registryOwners": [],
      "registryAuthorizations": [],
      "combinedSourcesInfo": [
        {
          "vesselId": "126221ace-e3b5-f4ed-6150-394809737c55",
          "geartypes": [
            {
              "name": "SET_LONGLINES",
              "source": "COMBINATION_OF_REGISTRY_AND_AIS_INFERRED_NN_INFO",
              "yearFrom": 2019,
              "yearTo": 2022
            }
          ],
          "shiptypes": [
            {
              "name": "FISHING",
              "source": "COMBINATION_OF_REGISTRY_AND_AIS_INFERRED_NN_INFO",
              "yearFrom": 2019,
              "yearTo": 2022
            }
          ]
        },
        {
          "vesselId": "3312b30d6-65b6-1bdb-6a78-3f5eb3977e58",
          "geartypes": [
            {
              "name": "SET_LONGLINES",
              "source": "COMBINATION_OF_REGISTRY_AND_AIS_INFERRED_NN_INFO",
              "yearFrom": 2019,
              "yearTo": 2023
            }
          ],
          "shiptypes": [
            {
              "name": "FISHING",
              "source": "COMBINATION_OF_REGISTRY_AND_AIS_INFERRED_NN_INFO",
              "yearFrom": 2019,
              "yearTo": 2023
            }
          ]
        }
      ],
      "selfReportedInfo": [
        {
          "id": "3312b30d6-65b6-1bdb-6a78-3f5eb3977e58",
          "ssvid": "368045130",
          "shipname": "MISS FREYA",
          "nShipname": "MISSFREYA",
          "flag": "USA",
          "callsign": "WDK3424",
          "imo": null,
          "messagesCounter": 90158,
          "positionsCounter": 15799,
          "sourceCode": ["AIS"],
          "matchFields": "SEVERAL_FIELDS",
          "transmissionDateFrom": "2019-04-06T13:12:43Z",
          "transmissionDateTo": "2023-10-21T09:32:55Z"
        },
        {
          "id": "126221ace-e3b5-f4ed-6150-394809737c55",
          "ssvid": "368045130",
          "shipname": "MISS FREYA",
          "nShipname": "MISSFREYA",
          "flag": "USA",
          "callsign": null,
          "imo": null,
          "messagesCounter": 12483,
          "positionsCounter": 2066,
          "sourceCode": ["AIS"],
          "matchFields": "SEVERAL_FIELDS",
          "transmissionDateFrom": "2019-02-01T19:24:59Z",
          "transmissionDateTo": "2022-07-17T11:48:43.52Z"
        }
      ],
      "matchCriteria": [
        {
          "reference": "3312b30d6-65b6-1bdb-6a78-3f5eb3977e58",
          "property": "selfReportedInfo.id",
          "source": "selfReportedInfo",
          "matches": [
            {
              "property": "selfReportedInfo.ssvid",
              "value": "368045130"
            }
          ],
          "period": {
            "dateFrom": "2019-04-06T13:12:43Z",
            "dateTo": "2023-10-21T09:32:55Z"
          },
          "latestVesselInfo": true
        },
        {
          "reference": "126221ace-e3b5-f4ed-6150-394809737c55",
          "property": "selfReportedInfo.id",
          "source": "selfReportedInfo",
          "matches": [
            {
              "property": "selfReportedInfo.ssvid",
              "value": "368045130"
            }
          ],
          "period": {
            "dateFrom": "2019-02-01T19:24:59Z",
            "dateTo": "2022-07-17T11:48:43.52Z"
          },
          "latestVesselInfo": true
        },
        {
          "reference": "4e4b5501-c2cf-4384-8051-c3affacb0229",
          "property": "registryInfo.vesselInfoReference",
          "source": "registryInfo",
          "matches": [
            {
              "property": "registryInfo.ssvid",
              "value": "368045130"
            }
          ],
          "period": {
            "dateFrom": "2019-02-01T19:28:14Z",
            "dateTo": "2023-07-31T08:10:29Z"
          },
          "latestVesselInfo": true
        }
      ]
    }
  ],
  "metadata": {
    "query": "368045130",
    "normalizedQuery": "368045130",
    "didYouMean": {
      "shipname": {}
    }
  }
}