Base function to get vessel information from API and convert response to data frame

get_vessel_info(
  query = NULL,
  search_type = NULL,
  dataset = "all",
  key = gfw_auth()
)

Arguments

query: search terms to identify vessel
search_type: type of search, may be 'basic','advanced', or 'id'
dataset: identity datasets to search against, default = 'all'
key: Authorization token. Can be obtained with gfw_auth function

Details

There are three search types. basic search takes features like MMSI, IMO, callsign, shipname as inputs and identifies all vessels in the specified dataset that match. advanced search allows for the use of fuzzy matching with terms such as LIKE. The id search allows the user to search using a GFW vessel id. There are three identity databases available, "carrier_vessel", "support_vessel", and "fishing_vessel". The user can also specify "all" and search again all databases at once. This is generally recommended.