Instructions for using the AVCS Online Discovery API

About AVCS Online

ADMIRALTY Vector Chart Service (AVCS) Online gives shore-based users and planning teams access to more than 15,000 Electronic Navigational Charts (ENCs), updated weekly, to support vessel tracking, voyage planning and for use in accident and emergency incidents. The inclusion of chart display settings and pick reports enables the on-board experience to be replicated from ashore.

AVCS Online can be integrated into existing web-based systems as a standalone chart solution, or as a base layer with other layers added, to optimise the planning and support potential of the service. To find out more about AVCS Online, click here.

How to get AVCS Online

AVCS Online is available through approved ADMIRALTY Technical Solution Providers.

Find an ADMIRALTY Technical Solution Provider

About the AVCS Online Discovery API

The AVCS Online Discovery API provides free access to a trial version of the AVCS Online Web Map Service (WMS). It is intended for use by developers from organisations who are interested in becoming re-sellers of AVCS Online. The Discovery API provides you with Electronic Navigational Charts (ENCs) along the south coast of England. You will have access to a maximum of 2000 API calls per day at a maximum rate of 30 calls per 30 second period.

Using the AVCS Online Discovery API

The AVCS Online Discovery API includes the same Web Map Service display controls and features as the AVCS Online Live service. The Discovery API call parameters are similar to the AVCS Online live service which is documented here, except for the following key differences:

  • Authentication for the AVCS Online Discovery API is via a subscription key, so Sections 2.1 (Obtain Map Token using GetCapabilities) and 2.2 (Renew Map Token using GenerateToken) are not applicable.

  • All parameters called licenseId, Token, UserId and userRef are not needed in the Discovery API so should not be included in the calls - For further information on how to connect, see the section below.

  • AVCS Online Discovery API users are subject to rate limits and quotas. To see the values for these see the AVCS Online Discovery API Product page.

How to get a subscription key

You will need a subscription key for the AVCS Online Discovery API to call the service. Below are instructions on how to sign up and obtain a subscription key:

  1. Go to https://admiraltyapi.developer.azure-api.net/

  2. Click on the "Sign Up" button and follow the instructions to create an account

  3. When you have activated your account, click on the "Products" menu at the top of the page

  4. Click on the "AVCS Online Developer Discovery API" link

  5. Click on the "Subscribe" button and follow the subscription process, including acceptance of the Terms of Use

  6. You can now retrieve your subscription key by selecting the "Show" link next to your primary or secondary key

How to use subscription key

To use the subscription key, add it to the Ocp-Apim-Subscription-Key request header for each AVCS Online Discovery API call.

Electronic Navigational Charts provided

The Discovery API provides you with Electronic Navigational Charts (ENCs) along the south coast of England. The ENC data provided is not up-to-date and the UKHO does not routinely update the ENCs. The UKHO may change the coverage and update the ENCs without notice.

Terms of Use

Users must be aware that by using the AVCS Online Discovery API they are agreeing to its Terms of Use, which can be found by following the link on the AVCS Online Discovery API Product page.

How to apply to become an AVCS Online re-seller

Following your trial of the AVCS Online Discovery API, if you would like to become a re-seller of AVCS Online, please visit: https://www.admiralty.co.uk/working-with-us