API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Client

ModelsExpand Collapse

type Error struct{…}

Standard API error response

Error ErrorError

Code string

Machine-readable error code

Message string

Human-readable error message

Details unknownoptional

Additional error details

type FeatureCollection struct{…}

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

Features []GeoJsonFeature

Geometry GeoJsonGeometry

Coordinates GeoJsonGeometryCoordinatesUnion

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

type GeoJsonGeometryCoordinatesArray []float64

type GeoJsonGeometryCoordinatesArray [][]float64

type GeoJsonGeometryCoordinatesArray [][][]float64

type GeoJsonGeometryCoordinatesArray [][][][]float64

Type GeoJsonGeometryType

One of the following:

const GeoJsonGeometryTypePoint GeoJsonGeometryType = "Point"

const GeoJsonGeometryTypeLineString GeoJsonGeometryType = "LineString"

const GeoJsonGeometryTypePolygon GeoJsonGeometryType = "Polygon"

const GeoJsonGeometryTypeMultiPoint GeoJsonGeometryType = "MultiPoint"

const GeoJsonGeometryTypeMultiLineString GeoJsonGeometryType = "MultiLineString"

const GeoJsonGeometryTypeMultiPolygon GeoJsonGeometryType = "MultiPolygon"

Properties map[string, unknown]

Type GeoJsonFeatureType

ID stringoptional

Feature identifier (type/osm_id)

OsmID int64optional

OpenStreetMap ID

Type FeatureCollectionType

type GeoJsonFeature struct{…}

Geometry GeoJsonGeometry

Coordinates GeoJsonGeometryCoordinatesUnion

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

type GeoJsonGeometryCoordinatesArray []float64

type GeoJsonGeometryCoordinatesArray [][]float64

type GeoJsonGeometryCoordinatesArray [][][]float64

type GeoJsonGeometryCoordinatesArray [][][][]float64

Type GeoJsonGeometryType

One of the following:

const GeoJsonGeometryTypePoint GeoJsonGeometryType = "Point"

const GeoJsonGeometryTypeLineString GeoJsonGeometryType = "LineString"

const GeoJsonGeometryTypePolygon GeoJsonGeometryType = "Polygon"

const GeoJsonGeometryTypeMultiPoint GeoJsonGeometryType = "MultiPoint"

const GeoJsonGeometryTypeMultiLineString GeoJsonGeometryType = "MultiLineString"

const GeoJsonGeometryTypeMultiPolygon GeoJsonGeometryType = "MultiPolygon"

Properties map[string, unknown]

Type GeoJsonFeatureType

ID stringoptional

Feature identifier (type/osm_id)

OsmID int64optional

OpenStreetMap ID

type GeoJsonGeometry struct{…}

Coordinates GeoJsonGeometryCoordinatesUnion

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

type GeoJsonGeometryCoordinatesArray []float64

type GeoJsonGeometryCoordinatesArray [][]float64

type GeoJsonGeometryCoordinatesArray [][][]float64

type GeoJsonGeometryCoordinatesArray [][][][]float64

Type GeoJsonGeometryType

One of the following:

const GeoJsonGeometryTypePoint GeoJsonGeometryType = "Point"

const GeoJsonGeometryTypeLineString GeoJsonGeometryType = "LineString"

const GeoJsonGeometryTypePolygon GeoJsonGeometryType = "Polygon"

const GeoJsonGeometryTypeMultiPoint GeoJsonGeometryType = "MultiPoint"

const GeoJsonGeometryTypeMultiLineString GeoJsonGeometryType = "MultiLineString"

const GeoJsonGeometryTypeMultiPolygon GeoJsonGeometryType = "MultiPolygon"