LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsContact Us
  • More than Maps
  • Geographic Data Visualisation
    • Guide to cartography
      • Introduction to cartography
      • Types of maps
      • Symbology
      • Colour
      • Text on maps
      • Generalisation
      • Coordinate reference systems
      • Projections
      • Scale
      • Map legends
      • Map layout
      • Relief representation
      • North arrows
    • Guide to data visualisation
      • Introduction to data visualisation
      • GeoDataViz design principles
      • Types of visualisation
      • Thematic mapping techniques
      • Data visualisation critique
      • Accessible data visualisation
      • Ethical data visualisation
      • Software
      • Data
    • GeoDataViz assets
      • GeoDataViz basemaps
      • Stylesheets
      • GeoDataViz virtual gallery
      • Equal area cartograms
      • How did I make that?
        • Apollo 11 Landing
        • North York Moors National Park, 70 years
        • Snowdonia National Park, 70 years
        • Great Britain's National Parks
        • Great Britain's Islands
        • Great Britain's AONB's and National Scenic Areas
        • Famous shipwrecks of Pembrokeshire
        • Trig pillars today
        • Britain's most complex motorway junctions
      • #30DayMapChallenge
  • Data in Action
    • Examples
  • Demonstrators
    • 🆕Product Viewer
    • Addressing & location demonstrators
      • Address Portfolio overview
      • Which address product should you use?
      • AddressBase
      • AddressBase Core
      • AddressBase Plus
      • AddressBase Premium
      • Address Classifications
      • Addressing Lifecycle
      • OS Emergency Services Gazetteer
      • What are Vertical Streets?
      • Why are there differences in boundaries?
    • Contextual demonstrators
    • Customer best practice
      • Channel Shift
      • Data Management and OS Data Hub
      • End User Licence vs Contractor Licence
      • 🆕 IDs vs Spatial Relationships
      • Why we should capture good quality addresses at source
      • Why we Snap and Trace
    • Network Demonstrators
      • OS Detailed Path Network
      • OS Multi Modal Routing Network
        • OS Multi Modal Routing Network
      • Water Networks overview
      • OS MasterMap Highways Network and OS NGD Speeds
      • OS MasterMap® Highways Network and OS Open Roadsâ„¢
    • OS MasterMap Generation APIs
      • Using the OS Features API
      • Using the OS Features API Archive
      • Using the OS Downloads API
      • Using OS APIs in ESRI Software
    • 🆕OS NGD (National Geographic Database)
      • OS NGD Address
      • OS NGD Boundaries
      • 🆕OS NGD Buildings
        • 🆕Building and Building Access Feature Types
        • Building Part and Building Line Feature Types
      • 🆕OS NGD Geographical Names
      • OS NGD Land
      • OS NGD Land Cover enhancements
      • 🆕OS NGD Land Use
      • OS NGD Land Use enhancements
      • 🆕OS NGD Structures
        • 🆕OS NGD Structures
        • Field Boundaries
      • 🆕OS NGD Transport Features
      • 🆕OS NGD Transport Network
      • OS NGD Transport RAMI
      • OS NGD Water Features
      • OS NGD Water Network
      • OS NGD API - Features
      • Ordering OS NGD data
      • Change only updates
      • OS NGD Versioning
      • Creating a topographic map from OS NGD Data
      • Analytical styling for OS NGD data
    • OS MasterMap® demonstrators
    • 🆕Product & API Comparisons
      • 🆕Comparison of Water Network Products
  • Tutorials
    • GeoDataViz
      • Thematic Mapping Techniques
      • Downloading and using data from the OS Data Hub
      • How to download and use OS stylesheets
      • How to use the OS Maps API
      • Creating a bespoke style in Maputnik
    • GIS
      • Analysing pavement widths
      • Basic routing with OS Open Data and QGIS
      • Walktime analysis using OS Multi-modal Routing Network and QGIS
      • Creating 3D Symbols for GIS Applications
      • Constructing a Single Line Address using a Geographic Address
      • Creating a Digital Terrain Model (DTM)
      • Visualising a road gradient using a Digital Terrain Model
      • Visualising a road gradient using OSMM Highways
    • 🆕APIs
      • 🆕Using OS APIs with EPC API
      • 🆕OS APIs and ArcGIS
  • Deep Dive
    • Introduction to address matching
    • Guide to routing for the Public Sector
      • Part 1: Guide to routing
      • Part 2: Routing software and data options
      • Part 3: Building a routable network
    • Unlocking the Power of Geospatial Data
    • Using Blender for Geospatial Projects
    • A Guide to Coordinate Systems in Great Britain
      • Myths about coordinate systems
      • The shape of the Earth
      • What is position?
        • Types of coordinates
        • We need a datum
        • Position summary
      • Modern GNSS coordinate systems
        • Realising WGS84 with a TRF
        • The WGS84 broadcast TRF
        • The International Terrestrial Reference Frame (ITRF)
        • The International GNSS Service (IGS)
        • European Terrestrial Reference System 1989 (ETRS89)
      • Ordnance Survey coordinate systems
        • ETRS89 realised through OS Net
        • National Grid and the OSGB36 TRF
        • Ordnance Datum Newlyn
        • The future of British mapping coordinate systems
        • The future of British mapping coordinate systems
      • From one coordinate system to another: geodetic transformations
        • What is a geodetic transformation?
        • Helmert datum transformations
        • National Grid Transformation OSTN15 (ETRS89–OSGB36)
        • National Geoid Model OSGM15 (ETRS89-Orthometric height)
        • ETRS89 to and from ITRS
        • Approximate WGS84 to OSGB36/ODN transformation
        • Transformation between OS Net v2001 and v2009 realisations
      • Transverse Mercator map projections
        • The National Grid reference convention
      • Datum, ellipsoid and projection information
      • Converting between 3D Cartesian and ellipsoidal latitude, longitude and height coordinates
      • Converting between grid eastings and northings and ellipsoidal latitude and longitude
      • Helmert transformation worked example
      • Further information
  • Code
    • Ordnance Survey APIs
    • Mapping
    • Routing with pgRouting
      • Getting started with OS MasterMap Highways and pgRouting
      • Getting started with OS MasterMap Highways Network - Paths and pgRouting
      • Getting started with OS NGD Transport Theme and pgRouting
      • Getting started with OS NGD Transport Path features and pgRouting
  • RESOURCES
    • 🆕Data Visualisation External Resources
Powered by GitBook

Website

  • Ordnance Survey

Data

  • OS Data Hub
On this page
  • What is OS NGD API – Features?
  • How do I access the API?
  • What are the main benefits of the API?
  • How is the OS Features API different to the OS NGD API - Features?
  • Limitations
  • Pagination
  • Resources

Was this helpful?

  1. Demonstrators
  2. OS NGD (National Geographic Database)

OS NGD API - Features

PreviousOS NGD Water NetworkNextOrdering OS NGD data

Last updated 8 months ago

Was this helpful?

What is OS NGD API – Features?

OS NGD API – Features gives you simple access to the OS National Geographic Database (OS NGD)

OS NGD API – Features allows you to

  • Request specific feature types and their attributes using spatial or attribute queries.

  • Interrogate highly detailed feature information.​​

  • Freely discover what data collection are available.​​

  • Explore the data schemas.​​

  • Request data in GeoJSON format.​​

  • Visualise Ordnance Survey data and apply your own styling.​

The API uses the same naming convention as OS NGD to allow you to explore themes and collections easily.

The on the OS Data Hub goes into detail about the different themes that are accessible.​

​The API is compliant with OGC API standards.​

How do I access the API?

  • Your API key can be found in the API Dashboard by clicking ‘Add to Project’ under the OS NGD API – Features section​​

You will now be able to find the API EndPoint address with your API key under your projects

With your API key you can access the API through GIS Software (such as QGIS and Cadcorp) and through programming languages such as Python and R. ​

Example scripts for getting started with the API can be found online:​

What are the main benefits of the API?

  • Plug and play – easily set up in QGIS to explore NGD data

  • More flexible – pull in exactly the data you want

  • No ordering or waiting – less time processing and storing data

  • Easy Testing – great for quick and easy analysis of features

The table below shows the attributes that are available to query against on top of the options available in OS Select+Build.

How is the OS Features API different to the OS NGD API - Features?

The main difference between the new OS NGD API – Features and the OS Features API is the OS NGD API – Features is for accessing OS NGD data.

OS NGD attribution can be explored through the OS NGD layers found in the OS NGD API – Features API

Limitations

There are a number of considerations to keep in mind when using the API.

  • Limits- the API can return 100 features in a single call. Most GIS software will keep calling the API to bring in the requested features so it is important to set a feature limit when setting up the API. Pagination will be required when using a scripting language, this is explained in the next side.

  • Scale- the API is not designed to create a scalable map of Great Britain across zoom levels. It is designed to interrogate specific features and small areas. ​

  • Access- the API does not have the ability to access OS NGD Address Theme, the Administrative & Statistical Theme data or Water Catchments​

  • CQL errors- the API currently (as of May 2023) does not allow CQL querying with apostrophe (e.g. description = ‘Children’s Centre’)

Pagination

The API returns 100 features per page and the JSON response will include the URL for the following page

Most GIS already understand how to page as its part of the OGC standard. So remember to set limits to avoid calling back the entire country.

However, when using a scripting language you will need to page through the results by utilising the offset attribute.

Resources

There are a number of resources available for the OS Features API:

Get access to the API through the OS Data Hub. The getting started guide can be accessed .​

The has a walk through on getting the API in QGIS.

R script for calling the API and outputting a Shiny web app ​

Code examples for on OS labs ​

The Data Hub contains an of the API, a and a

There are a series of to help you get started with the API

More resources, including style sheets and example scripts, are available on

here
getting started guide
here
here
overview
getting started guide
technical specification
code examples
GitHub
🆕
technical specification
OS NGD Collections
Page cover image