v1

latestOpenAPI 3.0.22026-07-174950145.6 KB

Read Features

Get features by bounding box

Return the features which are inside a bounding box stipulated by west, north, east and south parameters.

get/spaces/{spaceId}/bbox

Path parameters

spaceIdstring required

The unique identifier of the space.

Query parameters

westnumber double

The longitude in WGS'84 decimal degree (-180 to +180) of the west (left) border of the bounding box.

northnumber double

The latitude in WGS'84 decimal degree (-90 to +90) of the north (top) border of the bounding box.

eastnumber double

The longitude in WGS'84 decimal degree (-180 to +180) of the east (right) border of the bounding box.

southnumber double

The latitude in WGS'84 decimal degree (-90 to +90) of the south (bottom) border of the bounding box.

clipboolean

If set to true the features' geometries are clipped to the geometry of the tile, bounding box or input geometry. Default is false.

limitinteger

The maximum number of features in the response. Default is 30000. Hard limit is 100000.

paramsobject

Additional feature filters which compare the feature's property value with the one specified in the query, resulting in a subset of features.

The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation.

Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt', 'f.updatedAt'.

Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values.

The format should follow the specification below

?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1

For example, the above query, the Features are filtered by 'property' AND 'special property' equals to their respective values.

While in the following example

?p.property_name_1=value_1,value_2

The resulting Features list contains all elements having value_1 OR value_2.

Additionally, to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=". The following queries yield the same result:

?p.property_name_1>=10
?p.property_name_1=gte=10

The available operators are:

"=" - equals
"!=" - not equals
"=.null" - is null
"!=.null" - is not null
">=" or "=gte=" - greater than or equals
"<=" or "=lte=" - less than or equals
">" or "=gt=" - greater than
"<" or "=lt=" - less than
"@>" or "=cs=" - Array contains

{
  "p.myProperty1": "someValue",
  "p.myProperty2!": "not-equal",
  "p.myNumber1": 5,
  "p.myNumber2=gte": 7
}

selectionstring[]

A list of properties to be returned in the features result list. Multiple attributes can be specified by using comma(,).

Example: ?selection=p.name,p.capacity,p.color,rootpropertyname

!geometry : special value to omit geometries

skipCacheboolean

If set to true the response is not returned from cache. Default is false.

clustering'hexbin' | 'quadbin'

The clustering algorithm to apply to the data within the result. Providing this query parameter, the data is returned in a clustered way. This means the data is not necessarily returned in its original shape or with its original properties. Depending on the chosen clustering algorithm, there could be different mandatory and/or optional parameters to specify the behavior of the algorithm. Possible values are:

"hexbin"

The hexbin algorithm divides the world in hexagonal "bins" on a specified resolution. Each hexagon has an address being described by the H3 addressing scheme. For more information on this topic see: https://eng.uber.com/h3/
"quadbin"

The quadbin algorithm takes the geometry input from the request (for example, quadkey / bbox..) and count the features in it. This clustering mode works also for very large spaces and can be used for getting an overview where data is present in a given space. Furthermore, a property filter on one property is applicable.

clusteringParamsstring[]

Some parameters for the chosen clustering algorithm.

Depending on the chosen clustering algorithm, there could be different mandatory and/or optional parameters to specify the behavior of the algorithm.

Clustering-Parameter reference

NOTE: The actual query parameters in the URL look like: ?clustering.aParameterName=aValue

Clustering-type: "hexbin":

There are several parameters needed by the H3 based hexbin algorithm. For more information on this topic see: https://eng.uber.com/h3/

Parameter	Type	Mandatory	Meaning
absoluteResolution	Number	NO	integer, The H3 hexagon resolution [0,13]
resolution	Number	NO	deprecated, renamed to absoluteResolution
relativeResolution	Number	NO	integer value [-2,2] to be added to current used resolution
property	String	NO	A property of the original features for which to calculate statistics
pointmode	Boolean	NO	retuns the centroid of hexagons as geojson feature
singlecoord	Boolean	NO	force to evaluate the first object coordinate only (default: false)
sampling	String	NO	samplingratio of underlying dataset
			string value [off (1/1), low (1/8), lowmed (1/32), med (1/128), medhigh (1/1024), high (1/4096)] (default: off)

Clustering-type: "quadbin":

There are several parameters needed by the quadbin algorithm. You can use one property filter in combination.

Parameter	Type	Mandatory	Meaning
relativeResolution	Number	NO	integer, The quad resolution [0,4]
noBuffer	Boolean	NO	do not place a buffer around quad polygons, default: false
resolution	Number	NO	deprecated, renamed to resolutionRelative
countmode	String	NO	[real, estimated, mixed, bool]
			real = real feature counts. Best accuracy, but slow.
			Not recommended for big result sets

			estimated = estimated feature counts. Low accuracy, but very fast
			Recommended for big result sets

			mixed (default) = estimated feature counts combined with real ones.
			If the estimation is low a real count gets applied. Fits to the
			most use cases

			bool = test if data exists in tile but does not count features
			The returned count property set to 1, for non empty tiles

tweaks'sampling' | 'simplification' | 'ensure'

Providing this query parameter only a subset of the data will be returned. This can be used for rendering higher zoom levels. Possible values are:

"sampling" Delivery of geometry distributed data-samples.
"simplification" Delivery of simplified geometries

tweaksParamsstring[]

Providing this query parameter only a subset of the data will be returned. This can be used for rendering higher zoom levels.

Tweaks-Parameter reference

Tweaks-type: "sampling":

With the strength parameter it is possibile to control the behavior of the tweaks-sampling algorithm.

Parameter	Type	Mandatory	Meaning
algorithm	String	NO	distribution, geometrysize
strength	String	NO	Use presets: low, lowmed, med, medhigh, high or define strengh in percentage 1-100

Tweaks-type: "simplification":

With the strength parameter it is possibile to control the behavior of the tweaks-simplification algorithm.

Parameter	Type	Mandatory	Meaning
algorithm	String	NO	grid, gridbytilelevel, simplifiedkeeptopology, simplified, merge, linemerge
strength	String	NO	Use presets: low, med, high or define strengh in percentage 1-100

Tweaks-type: "ensure":

Parameter	Type	Mandatory	Meaning
defaultselection	boolean	NO	use standard selection behaviour [default: false]
samplingthreshold	Number	NO	integer 10-100, size of samples (x1000) [default: 10]

force2Dboolean

If set to true the features in the response have only X's and Y's as coordinates.

context'default' | 'extension' | 'super'

The context where the operation will be performed on a composite space. If not specified, the operation occurs based on the extension rules. For additional information, see Space.extends.

Available context are:

Context	Description
default	The default value if none is given. For composite spaces the operation occurs based on the extension rules. For normal spaces this is the only valid context.
extension	The operation will be executed only in the extension and no operation will be performed in the extended space.
super	Only applicable for read-operations. The operation will be executed only in the space being extended (super space).

versionstring

The query parameter used to specify the version of a feature or feature collection to be loaded.

versionRefstring

The query parameter used to specify the target version reference when reading or writing features. A reference describes a target tag or a branch and/or a version within that target branch.

Default is: main:HEAD

Version references have the following syntax: `[<branchName (optional, default: main)>:][<version (optional, default: HEAD)>] | [<tagName> (optional)]` The "main"-branch is pointing to the space itself as it has been created in the first place. Defining the branch as part of the reference only becomes necessary if further branches have been created for the space, which should be addressed by the ref. Depending on the use-case it can be necessary to specify a range of versions rather than only one version. In such a case the version part of the Ref would look like: `<start>..<end>`

Where <start> is the start of the range (exclusive) and <end> is the end of the range (inclusive).

Another way of specifying a version range is using the star-symbol: *

Using * refers to "all available versions" in the space or branch and is only applicable in the cases in which a version range may be provided.

Samples: - `main:42` points to version 42 of the "main"-branch - `myTag` points to the version of the tag with ID "myTag" - `myBranch:37` Points to version 37 of the branch with ID "myBranch" - `42` points to version 42 of the "main"-branch - `myBranch:HEAD` points to the latest version of the branch with ID "myBranch" - `HEAD` points to the latest version of the "main"-branch - `myBranch` points to the latest version of the branch with ID "myBranch" - `myBranch:0..HEAD` points to all available versions of the branch with ID "myBranch" - `0..HEAD` also points to all available versions of the "main"-branch - `*` also points to all versions (short form) - `myBranch:*` also points to all versions of branch "myBranch" (short form) - `main:5..10` points to the versions in the interval `]5, 10]` of the "main"-branch - `5..10` also points to the versions in the interval `]5, 10]` of the "main"-branch

Response

An array of features response.