API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Query

Execute an Overpass QL query

FeatureCollection query().overpass(QueryOverpassParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/overpass

Execute a SPARQL query

SparqlResult query().sparql(QuerySparqlParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/sparql

ModelsExpand Collapse

class OverpassQuery:

String data

Overpass QL query string

class SparqlQuery:

String query

SPARQL query string

class SparqlResult:

GeoJSON FeatureCollection of SPARQL query results

List<GeoJsonFeature> features

GeoJSON features from SPARQL query

GeoJsonGeometry geometry

Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

List<double>

List<List<double>>

List<List<List<double>>>

List<List<List<List<double>>>>

Type type

One of the following:

POINT("Point")

LINE_STRING("LineString")

POLYGON("Polygon")

MULTI_POINT("MultiPoint")

MULTI_LINE_STRING("MultiLineString")

MULTI_POLYGON("MultiPolygon")

Properties properties

Type type

Optional<String> id

Feature identifier (type/osm_id)

Optional<Long> osmId

OpenStreetMap ID

Type type