Sign in

v1

latestOpenAPI 3.0.22026-07-1741871.9 KB

Get Osm Current Snapshot As File

Generates the current raw OpenStreetMap data available on database based on the input geometry, query and spatial features.

Steps to Run Snapshot :

  1. Post the your request here and your request will be on queue, endpoint will return as following : { "task_id": "your task_id", "track_link": "/tasks/task_id/" }
  2. Now navigate to /tasks/ with your task id to track progress and result
post/snapshot/

Request body

outputType'geojson' | 'kml' | 'shp' | 'fgb' | 'mbtiles' | 'gpkg' | 'sql' | 'csv'

An enumeration.

minZoominteger

Only for mbtiles

maxZoominteger

Only for mbtiles

fileNamestring
geometryTypeSupportedGeometryFilters[]
joinFilterType'OR' | 'AND'

An enumeration.

countryExportboolean

Intersects the passed geom to country boundary if set to true and exports whole country : Use with Caution , May take hours

Example request

{
  "fileName": "My test export",
  "geometryType": [
    "point",
    "polygon"
  ]
}

Response

Successful Response

taskIdstring required
trackLinkstring required

Example response

{
  "task_id": "aa539af6-83d4-4aa3-879e-abf14fffa03f",
  "track_link": "/tasks/status/aa539af6-83d4-4aa3-879e-abf14fffa03f/"
}