getFeature | OS APIs

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

Access to features matching a given query

get

Authorizations

Query parameters

requeststring · enumrequired

The type of request being made.

Default: GetFeatureAvailable options:

servicestring · enumrequired

The type of service being requested.

Available options:

versionstring · enumrequired

The type of service being requested.

Default: 2.0.0Available options:

typeNamesstring · enumrequired

The Feature Type being requested.

Available options:

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

sortBystringoptional

Allows the user to order their response based on search attribute.

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: GML32Available options:

resultTypestring · enumoptional

Type of the results. Default: results.

Default: resultsAvailable options:

srsNamestring · enumoptional

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

Default: EPSG:27700Available options:

Responses

objectoptional

get

GET /features/v1/wfs HTTP/1.1
Host: api.os.uk
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

Path parameters

yearstringrequired

The year being requested.

Query parameters

requeststring · enumrequired

The type of request being made.

Default: GetFeatureAvailable options:

servicestring · enumrequired

The type of service being requested.

Available options:

versionstring · enumrequired

The type of service being requested.

Default: 2.0.0Available options:

typeNamesstring · enumrequired

The Feature Type being requested.

Available options:

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

sortBystringoptional

Allows the user to order their response based on search attribute.

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: GML32Available options:

resultTypestring · enumoptional

Type of the results. Default: results.

Default: resultsAvailable options:

srsNamestring · enumoptional

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

Default: EPSG:27700Available options:

Responses

objectoptional

get

GET /features/v1/wfs/archive/{year} HTTP/1.1
Host: api.os.uk
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>