Setting up an API project
How do I generate an API key?
Before you can access the OS NGD APIs, you will need to add one of them to a new or an existing project in the OS Data Hub and generate an API key.
To do this:
Log into your OS Data Hub account.
Select API Dashboard from the main menu (you must be signed into the OS Data Hub to view the contents of this tab).
Select APIs from the secondary navigation menu.
Select the Add to API project button of the API you want to add.
If you already have a project, you may want to add OS NGD API – Features or OS NGD API – Tiles into that existing project. Alternatively, if you want to add one of the NGD APIs to a new project, you should select Add to NEW PROJECT from the drop-down menu. If creating a new project, enter the project name.
The next screen will contain the project API key and the API endpoint address (API URL).
You can return to this screen by clicking My projects from the secondary navigation menu at any point in the future if you need to copy your API key or the API endpoint address, or if you need to regenerate your API key.
You can freely explore OS NGD data without having an API key.
Where is my API endpoint address?
To find an API endpoint address:
Log into your OS Data Hub account.
Select API Dashboard from the main menu (you must be signed into the OS Data Hub to view the contents of this tab).
Select My projects from the secondary navigation menu.
Select the project you're interested in.
Your API endpoint address will be displayed in the project information under the OS NGD API that has been added to the project.
Last updated
