Service metadata

API test authentication

The Open API block allows you to test OS APIs directly from the page with example data and parameters. To use this feature, you will need to add your API Key or OAuth2 token to the authentication field.

For help generating an API Key or OAuth2 token, please see the Getting started with an API project or OAuth2 documentation.

Service Metadata for OS Vector Tiles API

get

Authorizations

api-key & api-key-header & oauth2

keystringRequired

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

Query parameters

srsstring · enumOptional

The Spatial Reference System for the service.

Default: 27700Possible values:

Responses

200

Retrieves Service Metadata for OS Vector Tiles API

application/json

currentVersionnumberOptional

namestringOptional

capabilitiesstringOptional

typestringOptional

defaultStylesstringOptional

tilesstring[]Optional

exportTilesAllowedbooleanOptional

minScalenumberOptional

maxScalenumberOptional

maxzoomintegerOptional

minLODintegerOptional

maxLODintegerOptional

serviceItemIdstringOptional

maxExportTilesCountintegerOptional

get

/vts

HTTPcURLJavaScriptPython

GET /maps/vector/v1/vts HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Retrieves Service Metadata for OS Vector Tiles API

{
  "currentVersion": 1,
  "name": "text",
  "capabilities": "text",
  "type": "text",
  "defaultStyles": "text",
  "tiles": [
    "text"
  ],
  "exportTilesAllowed": true,
  "initialExtent": {
    "xmin": 1,
    "ymin": 1,
    "xmax": 1,
    "ymax": 1,
    "spatialReference": {
      "wkid": 1,
      "latestWkid": 1
    }
  },
  "fullExtent": {
    "xmin": 1,
    "ymin": 1,
    "xmax": 1,
    "ymax": 1,
    "spatialReference": {
      "wkid": 1,
      "latestWkid": 1
    }
  },
  "minScale": 1,
  "maxScale": 1,
  "tileInfo": {
    "rows": 1,
    "cols": 1,
    "dpi": 1,
    "format": "text",
    "origin": {
      "x": 1,
      "y": 1
    },
    "spatialReference": {
      "xmin": 1,
      "ymin": 1,
      "xmax": 1,
      "ymax": 1,
      "spatialReference": {
        "wkid": 1,
        "latestWkid": 1
      }
    },
    "lods": [
      {
        "level": 1,
        "resolution": 1,
        "scale": 1
      }
    ]
  },
  "maxzoom": 1,
  "minLOD": 1,
  "maxLOD": 1,
  "resourceInfo": {
    "styleVersion": 1,
    "tileCompression": "text",
    "cacheInfo": {
      "storageInfo": {
        "packetSize": 1,
        "storageFormat": "text"
      }
    }
  },
  "serviceItemId": "text",
  "maxExportTilesCount": 1
}