Skip to main content
POST
geo.geofence.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by geo.geofence-layer.create or geo.geofence-layers.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
point
object
required

Position to check.

radiusMetres
integer
default:0

Search radius in metres.

Required range: 0 <= x <= 50000
attributeNames
string[]

Custom attributes to return; default none.

Maximum array length: 16

Custom uppercase column name.

Pattern: ^[A-Z][A-Z0-9_]{0,31}$

Response

The result

results
object[]
required

Your nearby fences and whether the point is inside.

Maximum array length: 1000