Skip to content

Capabilities

Essential characteristics of this API including information about the data.


landing page of this API

GET
/

The landing page provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.

Authorizations

Responses

links to the API capabilities

application/json
JSON
{
  
"links": [
  
  
{
  
  
  
"href": "string",
  
  
  
"rel": "prev",
  
  
  
"type": "application/geo+json",
  
  
  
"hreflang": "en"
  
  
}
  
]
}

Playground

Server

Samples


information about standards that this API conforms to

GET
/conformance

list all requirements classes specified in a standard(e.g., Part 1: Core) that the server conforms to

Authorizations

Responses

the URIs of all requirements classes supported by the server

JSON
{
  
"conformsTo": [
  
  
[
  
  
  
"http://www.opengis.net/spec/wfs-1/3.0/req/core",
  
  
  
"http://www.opengis.net/spec/wfs-1/3.0/req/oas30",
  
  
  
"http://www.opengis.net/spec/wfs-1/3.0/req/geojson"
  
  
]
  
]
}

Playground

Server

Samples


retrieve the feature collections

GET
/collections

describe the feature collections in the dataset

Authorizations

Responses

Metadata about the feature collections shared by this API.

application/json
JSON
{
  
"links": [
  
  
{
  
  
  
"href": "string",
  
  
  
"rel": "prev",
  
  
  
"type": "application/geo+json",
  
  
  
"hreflang": "en"
  
  
}
  
],
  
"collections": [
  
  
{
  
  
  
"name": "buildings",
  
  
  
"title": "buildings",
  
  
  
"description": "buildings",
  
  
  
"links": [
  
  
  
  
{
  
  
  
  
  
"href": "string",
  
  
  
  
  
"rel": "prev",
  
  
  
  
  
"type": "application/geo+json",
  
  
  
  
  
"hreflang": "en"
  
  
  
  
}
  
  
  
],
  
  
  
"extent": {
  
  
  
  
"crs": "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
  
  
  
  
"spatial": [
  
  
  
  
  
[
  
  
  
  
  
  
-180,
  
  
  
  
  
  
-90,
  
  
  
  
  
  
180,
  
  
  
  
  
  
90
  
  
  
  
  
]
  
  
  
  
],
  
  
  
  
"trs": "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian",
  
  
  
  
"temporal": [
  
  
  
  
  
[
  
  
  
  
  
  
"2011-11-11T12:22:11Z",
  
  
  
  
  
  
"2012-11-24T12:32:43Z"
  
  
  
  
  
]
  
  
  
  
]
  
  
  
},
  
  
  
"crs": [
  
  
  
  
[
  
  
  
  
  
"http://www.opengis.net/def/crs/OGC/1.3/CRS84"
  
  
  
  
]
  
  
  
]
  
  
}
  
]
}

Playground

Server

Samples


retrieve the { collectionId } feature collection

GET
/collections/{collectionId}

describe the { collectionId } feature collection

Authorizations

Parameters

Path Parameters

collectionId*

Identifier (name) of a specific collection

Type
string
Required

Responses

Metadata about the { collectionId } collection shared by this API.

application/json
JSON
{
  
"name": "buildings",
  
"title": "buildings",
  
"description": "buildings",
  
"links": [
  
  
{
  
  
  
"href": "string",
  
  
  
"rel": "prev",
  
  
  
"type": "application/geo+json",
  
  
  
"hreflang": "en"
  
  
}
  
],
  
"extent": {
  
  
"crs": "http://www.opengis.net/def/crs/OGC/1.3/CRS84",
  
  
"spatial": [
  
  
  
[
  
  
  
  
-180,
  
  
  
  
-90,
  
  
  
  
180,
  
  
  
  
90
  
  
  
]
  
  
],
  
  
"trs": "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian",
  
  
"temporal": [
  
  
  
[
  
  
  
  
"2011-11-11T12:22:11Z",
  
  
  
  
"2012-11-24T12:32:43Z"
  
  
  
]
  
  
]
  
},
  
"crs": [
  
  
[
  
  
  
"http://www.opengis.net/def/crs/OGC/1.3/CRS84"
  
  
]
  
]
}

Playground

Server
Variables
Key
Value

Samples


Features


retrieve the features from the { collectionId } collection

GET
/collections/{collectionId}/items

Every feature in a dataset belongs to a collection.

Authorizations

Parameters

Path Parameters

collectionId*

Identifier (name) of a specific collection

Type
string
Required

Query Parameters

limit

The optional limit parameter limits the number of items that are presented in the response document.

Type
integer
Maximum
3000
Minimum
1
Default
3000
bbox

The bounding box is provided as four numbers.

Type
array
Max Items
6
Min Items
4
datetime

Either a date-time or a period string that adheres to RFC 3339.

Type
string

Responses

Information about the feature collection plus the first features matching the selection parameters.

application/geo+json
JSON
{
  
"type": "string",
  
"features": [
  
  
{
  
  
  
"type": "string",
  
  
  
"geometry": {
  
  
  
  
"type": "string"
  
  
  
},
  
  
  
"properties": {
  
  
  
},
  
  
  
"id": "string"
  
  
}
  
],
  
"links": [
  
  
{
  
  
  
"href": "string",
  
  
  
"rel": "prev",
  
  
  
"type": "application/geo+json",
  
  
  
"hreflang": "en"
  
  
}
  
],
  
"timeStamp": "string",
  
"numberMatched": 0,
  
"numberReturned": 0
}

Playground

Server
Variables
Key
Value

Samples


retrieve a feature

GET
/collections/{collectionId}/items/{featureId}

retrieve a feature; use content negotiation to request HTML or GeoJSON

Authorizations

Parameters

Path Parameters

collectionId*

Identifier (name) of a specific collection

Type
string
Required
featureId*

Local identifier of a specific feature

Type
string
Required

Responses

A feature

application/geo+json
JSON
{
  
"type": "string",
  
"geometry": {
  
  
"type": "string"
  
},
  
"properties": {
  
},
  
"id": "string"
}

Playground

Server
Variables
Key
Value

Samples