waykiteDocs

Navigation

Navigation aids in an area

GET
/api/v1/navigation/aids/within

List the aids in a box, by its edges in decimal degrees: everything a map shows, for example.

A box whose west edge is east of its east edge crosses the antimeridian. At most 500 aids are returned; truncated says when there were more, and a smaller box shows them all.

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

south*number

The southern edge.

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

The western edge.

Range-180 <= value <= 180
north*number

The northern edge.

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

The eastern edge.

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.

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 aids in the box.

application/json
  1. response
results*array<>
truncated*boolean

Whether the box holds more than 500.

Example Request
curl -X GET 'https://waykite.com/api/v1/navigation/aids/within?south=-90&west=-180&north=-90&east=-180'
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
      }
    }
  ],
  "truncated": false
}

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.

List regions GET

Every M49 region, with the countries in each. Locations and facilities carry their country's region codes in `regions`, and search and nearby take `region` to keep to one. See [Regions and sea areas](https://waykite.com/docs/guides/regions-and-sea-areas).