Surface v2 Hexbin
POST/v2/surfaceLast modified: 6 months ago
Scope: surface:create
Combine authoritative data provided by Airspace Link with your own GIS data to deliver profile services tailored to your needs. Over 65 datasets that can be used as a feature within the surface engine to aggregate and process vast amounts of data. For a GeoJSON response, use the Surface v2 (GeoJSON) endpoint.
Request
Header Params
Content-Type
enum<string>
required
Allowed value:
application/json;charset=UTF-8
Example:
application/json;charset=UTF-8
Authorization
string
required
Authorization bearer accessToken generated in Authorization step
Example:
{{access-token}}
Body Params application/json
coordinates
array [array]
required
type
string
required
layers
array [object {2}]
required
Array of layer objects. Valid length of 1-5.
code
string
optional
where
array [oneOf]
optional
resolution
integer
required
Hex grid resolution.
Example
{
"geometry": {
"coordinates": [
[
[
-83.2428932189941,
42.2835320469015
],
[
-83.2011795043945,
42.2835320469015
],
[
-83.2011795043945,
42.3354533445451
],
[
-83.2428932189941,
42.3354533445451
],
[
-83.2428932189941,
42.2835320469015
]
]
],
"type": "Polygon"
},
"layers": [
{
"code": "code",
"where": [
"AND",
[
[
"=",
"some_field",
100
],
[
"<=",
"another_field",
200
]
]
]
}
],
"resolution": 10
}Request samples
Responses
Successful response(200)
Your request was invalid JSON or is using invalid types(400)
Your request timed out; try reducing the size of the request(408)
Part of your request had invalid values(422)
Internal error reaching data(500)
Successful response
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array [object {2}]
required
hexes
array[string]
optional
props
object
optional
message
string
required
statusCode
integer
required
Example
{
"data": [
{
"hexes": [
"872ab2554ffffff",
"872ab2550ffffff"
],
"props": {
"type": "code"
}
}
],
"message": "success",
"statusCode": 200
}Last modified: 6 months ago