getFeature

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.

Access to features matching a given query

get

Authorizations

api-key & api-key-header & oauth2

keystringRequired

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

Query parameters

requeststring · enumRequired

The type of request being made.

Default: GetFeaturePossible values:

servicestring · enumRequired

The type of service being requested.

Possible values:

versionstring · enumRequired

The type of service being requested.

Default: 2.0.0Possible values:

typeNamesstring · enumRequired

The Feature Type being requested.

Possible values:

bboxstringOptional

A set of valid WFS BBOX coordinates, in the order <bottom-left y, bottom-left x, top-right y, top-right x> (Dependent on CRS)

filterstringOptional

A valid OGC XML filter object

countinteger · min: 1 · max: 100Optional

An integer stating the maximum number of features to be returned in a single response. In version 1.0.0 and 1.1.0 this is known as maxFeatures

Default: 100

maxFeaturesinteger · min: 1 · max: 100Optional

An integer stating the maximum number of features to be returned in a single response. In version 2.0.0 this is known as count

Default: 100

propertyNamestringOptional

A list of valid feature attribute names, for example, ChangeDate, TOID, PhysicalLevel

startIndexintegerOptional

An integer stating which result to start from, when returning a response

Default: 0

outputFormatstring · enumOptional

The format the response will be returned in. Default: XML.

Default: GML32Possible values:

resultTypestring · enumOptional

Type of the results. Default: results.

Default: resultsPossible values:

srsNamestring · enumOptional

Allows the user to reproject the selected features into another CRS. Default: EPSG:27700

Default: EPSG:27700Possible values:

Responses

200

Returns a description of the attributes for each feature type supported by the WFS service.

application/xmlapplication/json

get

/wfs

HTTPcURLJavaScriptPython

GET /features/v1/wfs?request=GetFeature&service=WFS&version=2.0.0&typeNames=DetailedPathNetwork_RouteLink HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Returns a description of the attributes for each feature type supported by the WFS service.

<?xml version="1.0"?>
<object>
	<type>FeatureCollection</type>
	<features>
		<type>text</type>
		<geometry>
			<type>text</type>
			<coordinates>
				<x>1</x>
				<y>1</y>
			</coordinates>
		</geometry>
		<properties>
			<ANY_ADDITIONAL_PROPERTY/>
		</properties>
	</features>
</object>

Access to features matching a given query for a particular year (as an annual snapshot - taking the last full release in the calendar year)

get

Authorizations

api-key & api-key-header & oauth2

keystringRequired

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

Path parameters

yearstringRequired

The year being requested.

Query parameters

requeststring · enumRequired

The type of request being made.

Default: GetFeaturePossible values:

servicestring · enumRequired

The type of service being requested.

Possible values:

versionstring · enumRequired

The type of service being requested.

Default: 2.0.0Possible values:

typeNamesstring · enumRequired

The Feature Type being requested.

Possible values:

bboxstringOptional

A set of valid WFS BBOX coordinates, in the order <bottom-left y, bottom-left x, top-right y, top-right x> (Dependent on CRS)

filterstringOptional

A valid OGC XML filter object

countinteger · min: 1 · max: 100Optional

An integer stating the maximum number of features to be returned in a single response. In version 1.0.0 and 1.1.0 this is known as maxFeatures

Default: 100

maxFeaturesinteger · min: 1 · max: 100Optional

An integer stating the maximum number of features to be returned in a single response. In version 2.0.0 this is known as count

Default: 100

propertyNamestringOptional

A list of valid feature attribute names, for example, ChangeDate, TOID, PhysicalLevel

startIndexintegerOptional

An integer stating which result to start from, when returning a response

Default: 0

outputFormatstring · enumOptional

The format the response will be returned in. Default: XML.

Default: GML32Possible values:

resultTypestring · enumOptional

Type of the results. Default: results.

Default: resultsPossible values:

srsNamestring · enumOptional

Allows the user to reproject the selected features into another CRS. Default: EPSG:27700

Default: EPSG:27700Possible values:

Responses

200

Returns a description of the attributes for each feature type supported by the WFS service.

application/xmlapplication/json

get

/wfs/archive/{year}

HTTPcURLJavaScriptPython

GET /features/v1/wfs/archive/{year}?request=GetFeature&service=WFS&version=2.0.0&typeNames=Highways_RoadLink HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Returns a description of the attributes for each feature type supported by the WFS service.

<?xml version="1.0"?>
<object>
	<type>FeatureCollection</type>
	<features>
		<type>text</type>
		<geometry>
			<type>text</type>
			<coordinates>
				<x>1</x>
				<y>1</y>
			</coordinates>
		</geometry>
		<properties>
			<ANY_ADDITIONAL_PROPERTY/>
		</properties>
	</features>
</object>