API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Client

ModelsExpand Collapse

Error = object { error }

Standard API error response

error: object { code, message, details }

code: string

Machine-readable error code

message: string

Human-readable error message

details: optional unknown

Additional error details

FeatureCollection = object { features, type }

Bare GeoJSON FeatureCollection. Pagination metadata is returned in HTTP headers (X-Limit, X-Has-More, X-Next-Cursor, X-Next-Offset, Link).

features: array of GeoJsonFeature { geometry, properties, type, 2 more }

geometry: GeoJsonGeometry { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: map[unknown]

type: "Feature"

id: optional string

Feature identifier (type/osm_id)

osm_id: optional number

OpenStreetMap ID

type: "FeatureCollection"

GeoJsonFeature = object { geometry, properties, type, 2 more }

geometry: GeoJsonGeometry { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: map[unknown]

type: "Feature"

id: optional string

Feature identifier (type/osm_id)

osm_id: optional number

OpenStreetMap ID

GeoJsonGeometry = object { coordinates, type }

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

array of number

array of array of number

array of array of array of number

array of array of array of array of number

type: "Point" or "LineString" or "Polygon" or 3 more

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"