Navigation

Nearby navigation aids

GET
/api/v1/navigation/aids/nearby

Find the aids closest to a point, nearest first.

For example, the lights a ship passes on its way into port. Distances are great-circle distances in kilometres, rounded to 0.1 km.

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

lat*number

Latitude in decimal degrees.

Range-90 <= value <= 90
lon*number

Longitude in decimal degrees.

Range-180 <= value <= 180
country?array<>

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

max_distance_km?number

Leave out anything further away than this, in kilometres.

Range0 < value
limit?integer

How many to return.

Range1 <= value <= 50
Default10
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

The nearest aids, closest first, each with its distance. There is no total or offset: ask for a larger limit to see more.

application/json
  1. response
results*array<>
limit*integer
Example Request
curl -X GET 'https://waykite.com/api/v1/navigation/aids/nearby?lat=-90&lon=-180'
Example Response
{  "results": [    {      "id": "aid_0c1c9b4c42a7ee54fe722dd8",      "kind": "light",      "name": "Raffles",      "international_number": "F1693",      "country": "SG",      "coordinates": {        "lat": 1.160222,        "lon": 103.740775      },      "timezone": "Asia/Singapore",      "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      },      "distance_km": 3.2    }  ],  "limit": 1}