Technical Specification | OS National Geographic Database

OS Docs Home OS NGD OS APIs OS Download Products More than Maps OS Data Hub

Retrieve the OS NGD API – Tiles landing page for this service.

get

Responses

application/json

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/ HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "title": "OS NGD API",
  "description": "Ordnance Survey National Geographic Database API",
  "links": [
    {
      "href": "http://data.example.org/",
      "rel": "self",
      "type": "application/json",
      "title": "this document"
    },
    {
      "href": "http://data.example.org/api?f=json",
      "rel": "service-desc",
      "type": "application/vnd.oai.openapi+json;version=3.0",
      "title": "the API definition"
    },
    {
      "href": "http://data.example.org/api",
      "rel": "service-doc",
      "type": "text/html",
      "title": "the API documentation"
    },
    {
      "href": "http://data.example.org/conformance",
      "rel": "conformance",
      "type": "application/json",
      "title": "OGC API conformance classes implemented by this service"
    },
    {
      "href": "http://data.example.org/collections",
      "rel": "data",
      "type": "application/json",
      "title": "Information about the collections"
    }
  ]
}

Retrieve the set of OS NGD API – Tiles conformance classes that are supported by this service.

get

Responses

application/json

all ofoptionalExample:

{"conformsTo":["http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/core","http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/json","http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/html","http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/oas30","http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/collections","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/core","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tileset","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tilesets-list","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geodata-tilesets","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/dataset-tilesets","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geodata-selection","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/jpeg","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/png","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/mvt","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geojson","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tiff","http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/netcdf"]}

application/json

get

GET /maps/vector/ngd/ota/v1/conformance HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "conformsTo": [
    "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/core",
    "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/json",
    "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/html",
    "http://www.opengis.net/spec/ogcapi-common-1/1.0/conf/oas30",
    "http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/collections",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/core",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tileset",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tilesets-list",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geodata-tilesets",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/dataset-tilesets",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geodata-selection",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/jpeg",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/png",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/mvt",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/geojson",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tiff",
    "http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/netcdf"
  ]
}

Retrieve the list of geospatial data collections available from this service.

get

Responses

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "links": [
    {
      "href": "http://data.example.org/collections",
      "rel": "self",
      "type": "application/json",
      "title": "All collections"
    }
  ],
  "collections": [
    {
      "id": "buildingpart",
      "title": "Building Part",
      "description": "Polygon feature representing a building.",
      "extent": {
        "spatial": {
          "bbox": [
            [
              -8.82,
              49.79,
              1.92,
              60.94
            ]
          ]
        },
        "temporal": {
          "interval": [
            [
              "2022-08-27T00:00:00Z",
              null
            ]
          ]
        }
      },
      "links": [
        {
          "href": "http://data.example.org/collections/buildingpart/items",
          "rel": "items",
          "type": "application/geo+json",
          "title": "Building Part"
        }
      ]
    }
  ]
}

Retrieve the description of a collection available from this service.

get

Path parameters

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

Responses

application/json

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId} HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "id": "buildingpart",
  "title": "Building Part",
  "description": "Polygon feature representing a building.",
  "extent": {
    "spatial": {
      "bbox": [
        [
          -8.82,
          49.79,
          1.92,
          60.94
        ]
      ]
    },
    "temporal": {
      "interval": [
        [
          "2022-08-27T00:00:00Z",
          null
        ]
      ]
    }
  },
  "links": [
    {
      "href": "http://data.example.org/collections/buildingpart/items",
      "rel": "items",
      "type": "application/geo+json",
      "title": "Building Part"
    }
  ]
}

Retrieve the list of available tiling schemes (tile matrix sets)

get

Responses

application/json

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/tilematrixsets HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "tileMatrixSets": [
    {
      "id": "text",
      "title": "text",
      "uri": "https://example.com",
      "crs": "https://example.com",
      "links": [
        {
          "href": "http://data.example.com/buildingpart/123",
          "rel": "alternate",
          "type": "application/geo+json",
          "templated": true,
          "varBase": "/ogcapi/vars/",
          "hreflang": "en",
          "title": "Building Part",
          "length": 1
        }
      ]
    }
  ]
}

Retrieve the definition of the specified tiling scheme (tile matrix set)

get

Path parameters

tileMatrixSetIdstring · enumrequired

Identifier for a supported TileMatrixSet

Available options:

Responses

application/json

objectoptional

A definition of a tile matrix set following the Tile Matrix Set standard. For tileset metadata, such a description (in tileMatrixSet property) is only required for offline use, as an alternative to a link with a http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme relation type.

application/json

get

GET /maps/vector/ngd/ota/v1/tilematrixsets/{tileMatrixSetId} HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "title": "text",
  "id": "text",
  "uri": "https://example.com",
  "orderedAxes": [
    "text"
  ],
  "crs": "https://example.com",
  "wellKnownScaleSet": "https://example.com",
  "tileMatrices": [
    {
      "id": "text",
      "scaleDenominator": 1,
      "cellSize": 1,
      "cornerOfOrigin": "topLeft",
      "pointOfOrigin": [
        1
      ],
      "tileWidth": 1,
      "tileHeight": 1,
      "matrixHeight": 1,
      "matrixWidth": 1
    }
  ]
}

Retrieve a list of available vector tilesets for the specified collection.

get

Path parameters

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

Responses

application/json

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/tiles HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "links": [
    {
      "href": "http://data.example.com/buildingpart/123",
      "rel": "alternate",
      "type": "application/geo+json",
      "templated": true,
      "varBase": "/ogcapi/vars/",
      "hreflang": "en",
      "title": "Building Part",
      "length": 1
    }
  ],
  "tilesets": [
    {
      "id": "3857",
      "title": "text",
      "dataType": "map",
      "crs": "https://example.com",
      "tileMatrixSetURI": "https://example.com",
      "links": [
        {
          "href": "http://data.example.com/buildingpart/123",
          "rel": "alternate",
          "type": "application/geo+json",
          "templated": true,
          "varBase": "/ogcapi/vars/",
          "hreflang": "en",
          "title": "Building Part",
          "length": 1
        }
      ]
    }
  ]
}

Retrieve the vector tileset metadata for the specified collection and tiling scheme (tile matrix set)

get

Path parameters

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

tileMatrixSetIdstring · enumrequired

Identifier for a supported TileMatrixSet

Available options:

Responses

application/json

all ofoptional

A resource describing a tileset based on the OGC TileSet Metadata Standard. At least one of the 'TileMatrixSet', or a link with 'rel' http://www.opengis.net/def/rel/ogc/1.0/tiling-scheme

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/tiles/{tileMatrixSetId} HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "description": "text",
  "tileMatrixSetLimits": [
    {
      "tileMatrix": "text",
      "minTileRow": 1,
      "maxTileRow": 1,
      "minTileCol": 1,
      "maxTileCol": 1
    }
  ],
  "layers": [
    {
      "description": "text",
      "id": "text",
      "dataType": "map",
      "geometryType": "text",
      "maxTileMatrix": "text",
      "minTileMatrix": "text",
      "propertiesSchema": {
        "type": "object",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "type": "array",
            "enum": [
              {}
            ]
          }
        }
      }
    }
  ],
  "boundingBox": {
    "lowerLeft": [
      1
    ],
    "upperRight": [
      1
    ],
    "crs": "https://example.com"
  },
  "id": "3857",
  "title": "text",
  "dataType": "map",
  "crs": "https://example.com",
  "tileMatrixSetURI": "https://example.com",
  "links": [
    {
      "href": "http://data.example.com/buildingpart/123",
      "rel": "alternate",
      "type": "application/geo+json",
      "templated": true,
      "varBase": "/ogcapi/vars/",
      "hreflang": "en",
      "title": "Building Part",
      "length": 1
    }
  ]
}

Retrieve a vector tile from a collection.

get

Authorizations

Path parameters

tileMatrixstringrequired

Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.

Example: 15

tileRowintegerrequired

Row index of the tile on the selected TileMatrix.

Example: 11179

tileColintegerrequired

Column index of the tile on the selected TileMatrix.

Example: 16558

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

tileMatrixSetIdstring · enumrequired

Identifier for a supported TileMatrixSet

Available options:

Responses

application/octet-stream

string · binaryoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol} HTTP/1.1
Host: api.os.uk
Accept: */*

binary

Retrieve a vector tile from a collection for Web Mercator Quad EPSG: 3857 tile matrix set.

get

Authorizations

Path parameters

tileMatrixstringrequired

Identifier selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.

Example: 15

tileRowintegerrequired

Row index of the tile on the selected TileMatrix.

Example: 11179

tileColintegerrequired

Column index of the tile on the selected TileMatrix.

Example: 16558

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

Responses

application/octet-stream

string · binaryoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/tiles/{tileMatrix}/{tileRow}/{tileCol} HTTP/1.1
Host: api.os.uk
Accept: */*

binary

Retrieve the list of styles available from this service.

get

Path parameters

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

Responses

application/json

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/styles HTTP/1.1
Host: api.os.uk
Accept: */*

{
  "links": [
    {
      "href": "http://data.example.com/buildingpart/123",
      "rel": "alternate",
      "type": "application/geo+json",
      "templated": true,
      "varBase": "/ogcapi/vars/",
      "hreflang": "en",
      "title": "Building Part",
      "length": 1
    }
  ],
  "styles": [
    {
      "id": "text",
      "title": "text",
      "links": [
        {
          "href": "http://data.example.com/buildingpart/123",
          "rel": "alternate",
          "type": "application/geo+json",
          "templated": true,
          "varBase": "/ogcapi/vars/",
          "hreflang": "en",
          "title": "Building Part",
          "length": 1
        }
      ]
    }
  ]
}

Root level properties of a style specify the map's layers, tile sources and other resources, and default values for the initial camera position when not specified elsewhere.

get

Path parameters

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

styleIdstring · enumrequired

An identifier representing a specific style.

Available options:

Responses

*/*

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/styles/{styleId} HTTP/1.1
Host: api.os.uk
Accept: */*

{}

Styling resources such as fonts and sprites

get

Path parameters

collectionIdstring · enumrequired

Local identifier of a collection

Available options:

styleIdstring · enumrequired

An identifier representing a specific style.

Available options:

resourceBaseNamestringrequired

Styling resourece base name.

Example: sprites

Responses

*/*

objectoptional

application/json

get

GET /maps/vector/ngd/ota/v1/collections/{collectionId}/styles/{styleId}/{resourceBaseName}/** HTTP/1.1
Host: api.os.uk
Accept: */*

{}