API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Elements

Query features by bounding box or H3 cell

FeatureCollection elements().query(ElementQueryParamsparams = ElementQueryParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/features

Get feature by type and ID

GeoJsonFeature elements().retrieve(ElementRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/features/{type}/{id}

Fetch multiple features by type and ID

FeatureCollection elements().batch(ElementBatchParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/features/batch

Find features near a geographic point

FeatureCollection elements().nearby(ElementNearbyParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/features/nearby

ModelsExpand Collapse

class BatchRequest:

List<Element> elements

long id

Type type

One of the following:

NODE("node")

WAY("way")

RELATION("relation")