Getting started with an API project

To access any OS APIs, you need an API key and / or API secret token. These credentials are scoped to a dedicated API project that is linked to your OS Data Hub account. You can can find your API Projects and Project API Keys in your API Dashboard where you can fully manage all aspects of your OS APIs.

Adding an API to a new project

Before you can access our OS APIs, you need to add at least one API to a new or existing project in the OS Data Hub and generate an API key.

To add an API to a project and generate an API key:

1. Log in to your OS Data Hub account.

2. Click API Dashboard in the main menu.

   
3. Click APIs in the secondary navigation menu.

   

   Example API Dashboard highlighting APIs link in secondary navigation
4. Click the Add to API project button of the API you want to add.

   
5. In the Add to API project dropdown click Add to NEW PROJECT.

   
6. Enter a project name in the dialog and then click Create project.

   
7. The <Project Name> page opens and displays the:

   • Project API Key: For example, GCk3L4TFnuKwcwG1PMJBtOyuipu6MOlV

   • Project API Secret: For example, zi7Vbor5f8i2ZTMs

   • Other API-specific information, for example the API endpoint address.

You can return to this page at any point in the future by opening My projects in the secondary navigation menu, if you need to copy your Project API Key or API endpoint address, or Regenerating an API key, for example.

YouTube video showing how to add OS NGD API – Tiles to a new project on the OS Data Hub and generate an API key.

Adding an API to an existing project

1. In API Dashboard > My Projects.

2. Click the <project name> link in the list of projects to open the dedicated project page, if necessary.

3. Click + Add API.

   
4. Click Add to API project for the required API and then Done to close the dialog.

   
5. The API will be added to the project and will be able to utilise the same Project API key.

   

Removing an API from a project

1. In API Dashboard > My Projects.

2. Click the <Project Name> link in the list of projects to open the dedicated project page, if necessary.

3. Click Remove from project for the specific API.

   
4. Click Remove API from project to confirm the removal.

   

Regenerating an API key

1. In API Dashboard > My Projects.

2. Click the <Project Name> link in the list of projects to open the dedicated project page, if necessary.

3. Click Actions > Regenerate API key.

   
4. Enter the one-time code to confirm your action and then click Regenerate API Key.

   

Deleting a project

1. In API Dashboard > My Projects.

2. Click the <Project Name> link in the list of projects to open the dedicated project page, if necessary.

3. Click Actions > Delete this project.

   

   Example API Dashboard showing Actions > Delete this project button
4. Enter the one-time code to confirm your action and then click Permanently remove project.

   

   Example API Dashboard showing the Permanently delete this project and its API key? confirmation dialog

Finding your API endpoint address

1. Log into your OS Data Hub account.
2. Select API Dashboard from the main menu. You must be logged into the OS Data Hub to view the contents of this tab.

3. Select My projects from the secondary navigation menu.

4. Select the project you're interested in.

5. Your API endpoint address will be displayed in the project information under the OS API that has been added to the project.