waykiteDocs

Navigation

Get a navigation aid

GET
/api/v1/navigation/aids/{id}

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

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.

Path Parameters

id*string

The aid's id.

Length1 <= length

Response Body

The aid.

application/json
  1. response

An aid to navigation, such as a lighthouse or a lit buoy. Fields without a value are left out.

id*string

The aid, by an identifier that does not change.

kind*string

The kind of aid: light, a lighthouse or other fixed light; buoy, lit or not; beacon, a fixed mark without a light; racon, a radar beacon on its own; fog_signal, a sound signal on its own; virtual, a mark broadcast over AIS where there is nothing to see; radio_beacon, a radio direction-finding beacon; dgps, a station broadcasting GPS corrections; or drilling_unit, a mobile offshore drilling unit, which moves.

Value in"light""buoy""beacon""racon""fog_signal""virtual""radio_beacon""dgps""drilling_unit"
name*string

Its name, with the place it belongs to where it is part of one.

international_number?string

Its number in the international list of lights, where it has one, such as 'A1871'.

country*string

The country of its nearest port, ISO 3166-1 alpha-2.

coordinates*
characteristics*array<string>

How it shows itself, as charts abbreviate it: its light, such as Fl.(2)W. period 10s, and any radar beacon (RACON) on it; and a radio beacon's identifier, which it sends in Morse.

height_m?number

The height of its light above the water, in metres.

range_nm?number

How far its light is seen, in nautical miles: the furthest of its colours. For a radio beacon or a DGPS station, how far its signal reaches.

frequency_khz?number

The frequency a radio beacon or a DGPS station broadcasts on, in kilohertz.

reported_on?string

For a drilling unit: the day its position was last reported, as YYYY-MM-DD.

structure?string

What it stands on or looks like by day.

remarks?string

Its sectors, other lights on it and other notes.

nearest_port*
Example Request
curl -X GET 'https://waykite.com/api/v1/navigation/aids/string'
Example Response
{  "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  }}

Search navigation aids GET

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.

Nearby navigation aids GET

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.