GET /api/v1/search

Search vessels, ports and companies

The site's own search. Each hit is an identifier set with links to its API and page representations. Vessel type and flag are withheld (their source's API right is not granted).

1 creditKey required

Parameters
Name	In	Description
q(required)	query	Name, IMO, MMSI or UN/LOCODE; 2 to 100 characters.
kind	query	Comma list of kinds to return (default all).

Request

curl -H "Authorization: Bearer $VOYDAR_API_KEY" \
  https://www.voydar.com/api/v1/search?q=ever%20given

Response (abridged)

{
  "type": "search",
  "query": "ever given",
  "count": 1,
  "data": [
    { "kind": "vessel", "id": "9811000", "name": "EVER GIVEN", "imo": 9811000, "mmsi": …,
      "api": "https://www.voydar.com/api/v1/vessels/9811000", "page": "https://www.voydar.com/vessel/9811000-ever-given" }
  ],
  "withheld": [ { "section": "vessel.vesselType,vessel.flag", "sources": ["seadar_legacy_vessels"], "rows": 1, "reason": "source_not_licensed_for_api" } ]
}