API User Keys


Introduction

To use the UK Data Service open data API, you will require a personal API user key. You will not be able to retrieve data from the API without appending your user key to the requests. Signup is free and only takes a couple of minutes.

What’s an API key for?

We keep track of who uses our API, and how they’re using it. This information remains private, but we might use your email to send you updates about the API that might interest you, such as when we add new features or new data, or the dates for planned maintenance.

How do I use my API key?

Once you have your key, you can start to explore the API calls. A good place to start is the Active Documents https://ukdataservice.3scale.net/docs. Using this, you can generate sample calls and actually run them straight from the page.

An example call might be:

https://api.ukdataservice.ac.uk/V1/datasets/EQLS?user_key=1a2b3c4d5e6f7g8h9ij10

Note: This call doesn’t work because it uses a dummy key of 1a2b3c4d5e6f7g8h9ij10 that is specified in the user_key parameter. Replace this fake key with your valid one.