API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Query

Execute an Overpass QL query

query.overpass(**kwargs) -> FeatureCollection { features, type }

POST/api/v1/overpass

Execute a SPARQL query

query.sparql(**kwargs) -> SparqlResult { features, type }

POST/api/v1/sparql

ModelsExpand Collapse

class OverpassQuery { data }

data: String

Overpass QL query string

class SparqlQuery { query }

query: String

SPARQL query string

class SparqlResult { features, type }

GeoJSON FeatureCollection of SPARQL query results

features: Array[GeoJsonFeature { geometry, properties, type, 2 more } ]

GeoJSON features from SPARQL query

geometry: GeoJsonGeometry { coordinates, type }

coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array[Float]

Array[Array[Float]]

Array[Array[Array[Float]]]

Array[Array[Array[Array[Float]]]]

type: :Point | :LineString | :Polygon | 3 more

One of the following:

:Point

:LineString

:Polygon

:MultiPoint

:MultiLineString

:MultiPolygon

properties: Hash[Symbol, untyped]

type: :Feature

id: String

Feature identifier (type/osm_id)

osm_id: Integer

OpenStreetMap ID

type: :FeatureCollection