Getting Started

In order to use the Polpred API, you must have access to a licence key to use in each request. This licence key references what data the user is allowed to compute and return. A licence key can reference multiple licences. For example, you may obtain a licence key which contains multiple licences scattered over different parts of the world, or multiple licences covering the same area but using different oceanographic models.

Obtaining a Licence Key

You can obtain a key by contacting a member of the products team at the National Oceanography Centre:

Alternatively, you can use the free Demonstration Key available.

JSON Data Format

All data return from this API is returned as a JSON object type. JSON is a standard format of sending and receiving data which can be used as a data format by many different programming languages. More information about the JSON format can be found at json.org.

API Call - Basic Setup

Below is an example of how the Polpred API is called. Each function of the API is referenced via a specific path given as a URL. Parameters are passed to that funciton which are used to return the desired data.

Example of an API URL.

Next Steps