waykiteDocs

Navigation

Search navigation aids

GET
/api/v1/navigation/aids/search

Find lighthouses, buoys, beacons and other aids by name.

Matching is case-insensitive and finds the text anywhere in an aid's name, which includes the place it belongs to where it is part of one: rotterdam finds the lights of Rotterdam's breakwaters. Names written with other spaces, punctuation or accents match too, when q holds punctuation or finds nothing as written.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the dashboard: a secret key (wk_sk_) from servers, or a publishable key (wk_pk_) from the origins listed on it. A workload can send its token in place of a secret key. See Authentication.

Query Parameters

limit?integer

Results per page.

Range1 <= value <= 200
Default50
offset?integer

How many results to skip, for the next page.

Range0 <= value
Default0
q?string

Text to look for. Leave it out to list every aid that passes the filters.

Default""
country?array<>

ISO 3166-1 alpha-2 country code in capitals, e.g. NL. Repeat it for several countries: country=US&country=CA.

kind?array<>

Only aids of these kinds: light, buoy, beacon, racon, fog_signal, virtual, radio_beacon, dgps or drilling_unit. Leave it out for all of them.

Response Body

A page of matching aids, by name. When offset + limit is less than total, there are more pages.

application/json
  1. response
results*array<>
total*integer

How many aids match, across all pages.

limit*integer
offset*integer
Example Request
curl -X GET 'https://waykite.com/api/v1/navigation/aids/search'
Example Response
{
  "results": [
    {
      "id": "aid_0c1c9b4c42a7ee54fe722dd8",
      "kind": "light",
      "name": "Raffles",
      "international_number": "F1693",
      "country": "SG",
      "coordinates": {
        "lat": 1.160222,
        "lon": 103.740775
      },
      "characteristics": [
        "Fl.(3)W. period 20s",
        "RACON O(- - - )"
      ],
      "height_m": 32,
      "range_nm": 20,
      "structure": "White round tower",
      "remarks": "AIS (MMSI No 005631114). Radar Reflector. DGPS Station",
      "nearest_port": {
        "unlocode": "SGSEB",
        "distance_km": 7.9
      }
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Nearby facilities GET

Find the facilities closest to a point, nearest first. For example, the terminal a vessel or a truck is at. Distances are great-circle distances in kilometres, rounded to 0.1 km.

Get a navigation aid GET

Look up one aid by its `id`. When there is none, the response is `204 No Content`, with an empty body.