Skip to Content
API ReferenceEndpoints

Endpoints

All routes below are mounted under /api/v1.

Health and Metadata

MethodPathDescription
GET/healthAPI health check. Returns 200 OK.
GET/info/Lists available routing, clustering, and bootstrap algorithm options.

Calculation (/calc)

MethodPathDescription
POST/calc/bootstrapBuilds bootstrap points from area, instance, or parent, optionally saves to DB/scanner.
POST/calc/{mode}/{category}Clusters and routes points for a category. Typical mode: cluster or route.
POST/calc/rerouteRe-routes existing clusters/data points without re-clustering.
POST/calc/route-statsComputes distance/coverage stats for provided route clusters.
POST/calc/route-stats/{category}Computes stats; if data_points omitted, loads points from area by category.
POST/calc/areaComputes geodesic area for polygon/multipolygon features.

category accepted values (validated by server):

  • gym
  • pokestop
  • spawnpoint
  • fort (gym + pokestop)

Conversion (/convert)

MethodPathDescription
POST/convert/dataConverts area between supported geo formats; optional simplify and internal prop cleanup.
POST/convert/simplifySimplifies polygon and multipolygon geometry.
POST/convert/merge-pointsMerges point features into a single GeoJSON MultiPoint feature.

Geofence (/geofence)

MethodPathDescription
GET/geofence/allReturns all geofences as FeatureCollection envelope data.
GET/geofence/area/{geofence}Returns one geofence, format controlled by query rt (default feature).
GET/geofence/referenceReturns geofence reference list (no fence geometry payload).
GET/geofence/reference/{project}Returns geofence references filtered by project.
GET/geofence/{return_type}Returns all geofences in requested return type.
GET/geofence/{return_type}/{project}Returns project geofences in requested return type.
POST/geofence/save-kojiUpserts provided geofences into Koji DB.
POST/geofence/save-scannerUpserts provided geofences into scanner/controller DB and triggers project API call.
GET/geofence/push/{id}Pushes one Koji geofence to scanner/controller DB and triggers project API call.

Route (/route)

MethodPathDescription
GET/route/allReturns all routes as FeatureCollection envelope data.
GET/route/area/{id}Returns one route, format controlled by query rt (default feature).
GET/route/referenceReturns route reference list (no fence geometry payload).
GET/route/reference/{geofence}Returns route references filtered by geofence name.
GET/route/{return_type}Returns all routes in requested return type.
GET/route/{return_type}/{geofence_name}Returns routes by geofence in requested return type.
POST/route/save-kojiUpserts provided routes into Koji DB.
GET/route/push/{id}Pushes one Koji route to scanner/controller DB and triggers project API call.

Project (/project)

MethodPathDescription
GET/project/push/{id}Pushes every geofence in a project to scanner/controller DB and triggers project API call.

S2 (/s2)

MethodPathDescription
POST/s2/circle-coverageReturns S2 cells covering a circle centered at lat/lon.
POST/s2/cell-coverageReturns neighboring S2 cell ids around lat/lon.
POST/s2/polygonsReturns polygon geometry for provided S2 cell ids.
POST/s2/{cell_level}Returns S2 cells within bounds, optional id filter.
Last updated on
OverviewRequest Bodies