avurnav-api

AVURNAV API

This library exposes an HTTP API to get navigational warnings for Metropolitan France currently in-force. Navigational warnings contain information about persons in distress, or objects and events that pose an immediate hazard to navigation. Navigational warnings are called AVURNAV (avis urgent aux navigateurs) in French.

It relies on another library: https://github.com/AntoineAugusti/avurnav.

On top of exposing an HTTP API, it periodically fetches information from the Préfet Maritime websites to get the latest published AVURNAVs.

API documentation

An HTML documentation of the API is available here. The documentation is build thanks to Spectacle.

This documentation is build using the Swagger 2.0 specification. With Swagger, you can automatically build HTTP clients for this API. The definition file can be found here.

Notice

This software is available under the MIT license and was developed as part of the Entrepreneur d'Intérêt Général program by the French government.