Common - Inside Polygon

Location Inside Poly

POST /api/common

Returns results on if a location is inside a polygon or not. Recommended to use for high-level checking.

This specific endpoint does not auto-scale geohash precision, ensure your initial polygon points have precision or use another endpoint.

Body

Param
Value/Type
Description

function

'inside'

Static

points

array

precision

int

Default is 6

locations

array

Example

{
  .. other params
  "points": [
    [float, float],
    [float, float],
    [float, float],
    [float, float],
    ...
  ],
  "locations": [
    {
      "latitude": float,
      "longitude": float
    }
    ...
  ]
}

Response

[
  {
    "latitude": float,
    "longitude": float,
    "is_inside": bool
  }
  ...
]

Last updated