Tiles | OS National Geographic Database

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

get

Path parameters

collectionIdstring · enumRequired

Local identifier of a collection

Possible values:

Responses

200

List of available tilesets.

application/json

400

The request was not supported.

application/json

404

The requested resource does not exist on the server. For example, a path parameter had an incorrect value.

application/json

405

The HTTP method requested is not supported. This endpoint only supports 'GET' requests.

application/json

406

A request header value was not supported.

application/json

500

A server error occurred.

application/json

504

Gateway Timeout.

application/json

get

/collections/{collectionId}/tiles

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

Possible values:

tileMatrixSetIdstring · enumRequired

Identifier for a supported TileMatrixSet

Possible values:

Responses

200

Description of the tileset

application/json

400

The request was not supported.

application/json

404

The requested resource does not exist on the server. For example, a path parameter had an incorrect value.

application/json

405

The HTTP method requested is not supported. This endpoint only supports 'GET' requests.

application/json

406

A request header value was not supported.

application/json

500

A server error occurred.

application/json

504

Gateway Timeout.

application/json

get

/collections/{collectionId}/tiles/{tileMatrixSetId}

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

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

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

Possible values:

tileMatrixSetIdstring · enumRequired

Identifier for a supported TileMatrixSet

Possible values:

Responses

200

A vector tile returned as a response.

application/octet-stream

Responsestring · binary

400

The request was not supported.

application/json

404

The requested resource does not exist on the server. For example, a path parameter had an incorrect value.

application/json

405

The HTTP method requested is not supported. This endpoint only supports 'GET' requests.

application/json

406

A request header value was not supported.

application/json

500

A server error occurred.

application/json

504

Gateway Timeout.

application/json

get

/collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}

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

binary

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

get

Authorizations

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

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

Possible values:

Responses

200

A vector tile returned as a response.

application/octet-stream

Responsestring · binary

400

The request was not supported.

application/json

404

The requested resource does not exist on the server. For example, a path parameter had an incorrect value.

application/json

405

The HTTP method requested is not supported. This endpoint only supports 'GET' requests.

application/json

406

A request header value was not supported.

application/json

500

A server error occurred.

application/json

504

Gateway Timeout.

application/json

get

/collections/{collectionId}/tiles/{tileMatrix}/{tileRow}/{tileCol}

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

binary