Skip to main content
POST
maps.features.query

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
location
object
required

Query location; may be a private coordinate.

dataset
enum<string>
default:streets

Public geographic dataset.

Available options:
streets,
terrain
radiusMeters
number
default:0

Search radius in meters; zero is a point query.

Required range: 0 <= x <= 100000
limit
integer
default:5

Maximum results, up to 50.

Required range: 1 <= x <= 50
dedupe
boolean
default:true

Remove duplicate features.

geometryType
enum<string>

Only this geometry type.

Available options:
point,
linestring,
polygon
layers
string[]

Public dataset layers to query.

Required array length: 1 - 20 elements
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,63}$

Response

The result

results
object[]
required

Features at or near your location.

Maximum array length: 50