getFeature

Access to features matching a given query

get

Authorizations

api-keyapi-key-headeroauth2

Query parameters

requeststring · enum · default: "GetFeature"required

The type of request being made.

Options: GetCapabilities, DescribeFeatureType, GetFeature

servicestring · enumrequired

The type of service being requested.

Options: WFS

versionstring · enum · default: "2.0.0"required

The type of service being requested.

Options: 1.0.0, 1.1.0, 2.0.0

typeNamesstring · enumrequired

The Feature Type being requested.

Options: DetailedPathNetwork_RouteLink, DetailedPathNetwork_RouteNode, Highways_RoadLink, Highways_RoadNode, Highways_FerryLink, Highways_FerryNode, Highways_Street, Highways_ConnectingLink, Highways_ConnectingNode, Highways_PathLink, Highways_PathNode, Greenspace_GreenspaceArea, Sites_AccessPoint, Sites_RoutingPoint, Sites_FunctionalSite, Topography_CartographicText, Topography_CartographicSymbol, Topography_TopographicPoint, Topography_TopographicLine, Topography_TopographicArea, Topography_BoundaryLine, WaterNetwork_HydroNode, WaterNetwork_WatercourseLink, Zoomstack_Airports, Zoomstack_Boundaries, Zoomstack_Contours, Zoomstack_DistrictBuildings, Zoomstack_ETL, Zoomstack_Foreshore, Zoomstack_Greenspace, Zoomstack_LocalBuildings, Zoomstack_Names, Zoomstack_NationalParks, Zoomstack_RailwayStations, Zoomstack_Rail, Zoomstack_RoadsLocal, Zoomstack_RoadsNational, Zoomstack_RoadsRegional, Zoomstack_Sites, Zoomstack_Surfacewater, Zoomstack_UrbanAreas, Zoomstack_Waterlines, Zoomstack_Woodland, OpenUPRN_Address, OpenUSRN_USRN, OpenTOID_TopographyLayer, OpenTOID_HighwaysNetwork, OpenTOID_SitesLayer

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: 100 · default: "100"optional

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

maxFeaturesinteger · min: 1 · max: 100 · default: "100"optional

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

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

startIndexinteger · default: "0"optional

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

outputFormatstring · enum · default: "GML32"optional

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

Options: GML32, GML3, GML2, GEOJSON

resultTypestring · enum · default: "results"optional

Type of the results. Default: results.

Options: results, hits

srsNamestring · enum · default: "EPSG:27700"optional

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

Options: EPSG:27700, EPSG:4326, EPSG:3857

Responses

application/xmlapplication/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.os.uk/features/v1/wfs?request=GetCapabilities&service=WFS&version=1.0.0&typeNames=DetailedPathNetwork_RouteLink'

200

200

application/xml

application/json

application/xml

<?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>

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

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-keyapi-key-headeroauth2

Path parameters

yearstringrequired

The year being requested.

Query parameters

requeststring · enum · default: "GetFeature"required

The type of request being made.

Options: GetCapabilities, DescribeFeatureType, GetFeature

servicestring · enumrequired

The type of service being requested.

Options: WFS

versionstring · enum · default: "2.0.0"required

The type of service being requested.

Options: 1.0.0, 1.1.0, 2.0.0

typeNamesstring · enumrequired

The Feature Type being requested.

Options: Highways_RoadLink, Highways_RoadNode, Highways_FerryLink, Highways_FerryNode, Highways_Street, Highways_ConnectingLink, Highways_ConnectingNode, Highways_PathLink, Highways_PathNode, Topography_CartographicText, Topography_CartographicSymbol, Topography_TopographicPoint, Topography_TopographicLine, Topography_TopographicArea, Topography_BoundaryLine, OpenUPRN_Address, ITN_Roads_FerryNode, ITN_Roads_RoadLink, ITN_Roads_RoadNode, ITN_UrbanPaths_ConnectingNode, ITN_UrbanPaths_FerryNode, ITN_UrbanPaths_PathLink, ITN_UrbanPaths_PathNode

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: 100 · default: "100"optional

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

maxFeaturesinteger · min: 1 · max: 100 · default: "100"optional

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

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

startIndexinteger · default: "0"optional

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

outputFormatstring · enum · default: "GML32"optional

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

Options: GML32, GML3, GML2, GEOJSON

resultTypestring · enum · default: "results"optional

Type of the results. Default: results.

Options: results, hits

srsNamestring · enum · default: "EPSG:27700"optional

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

Options: EPSG:27700, EPSG:4326, EPSG:3857

Responses

application/xmlapplication/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.os.uk/features/v1/wfs/archive/{year}?request=GetCapabilities&service=WFS&version=1.0.0&typeNames=Highways_RoadLink'

200

200

application/xml

application/json

application/xml

<?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>

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