API Reference
Auto-generated from /openapi.yaml. Always in sync with production.
admin
| Method | Path | Summary | Cost |
|---|
| GET | /v1/admin/ward | Get the enclosing municipal ward polygon. | 250 |
| GET | /v1/admin/pincode | Get the enclosing pincode polygon. | — |
| GET | /v1/admin/state | Get the enclosing state. | — |
| GET | /v1/admin/city | Get the enclosing onboarded city. | — |
env
| Method | Path | Summary | Cost |
|---|
| GET | /v1/env/aqi | Latest air-quality reading at lat/lng. | 300 |
| GET | /v1/env/weather | Latest weather observation at lat/lng. | — |
| GET | /v1/env/forecast | 24-hour weather forecast at lat/lng. | — |
geo
| Method | Path | Summary | Cost |
|---|
| GET | /v1/geo/h3 Convert a GPS coordinate to a stable spatial key for joining. | Resolve lat/lng to an H3 cell index. | 50 |
| GET | /v1/geo/reverse What is at this coordinate? | Reverse-geocode lat/lng to city + semantic labels. | 600 |
| GET | /v1/geo/forward | Resolve a place name to a city centroid. | 800 |
| GET | /v1/geo/autocomplete | Prefix-match city names for typeahead. | 400 |
hex
| Method | Path | Summary | Cost |
|---|
| GET | /v1/hex/{h3}/boundary | Get the polygon vertices of an H3 cell. | 250 |
| GET | /v1/hex/{h3}/parent | Get the parent H3 cell at a coarser resolution. | — |
| GET | /v1/hex/{h3}/children | Get child H3 cells at a finer resolution (max +3 levels). | — |
| GET | /v1/hex/{h3}/neighbors | Get k-ring neighbour cells. | — |
| GET | /v1/hex/{h3}/labels | Get semantic labels (locality, ward, LULC, etc.) for a cell. | 700 |
| GET | /v1/hex/{h3}/freshness | Get signal freshness state for a cell. | — |
intel
| Method | Path | Summary | Cost |
|---|
| GET | /v1/intel/hex/{h3} Full ground-truth context for a single 100m hex of India. | Single-hex full-stack readout (showcase endpoint). | 3500 |
meta
| Method | Path | Summary | Cost |
|---|
| GET | /v1/meta/cities | List all onboarded cities and their bboxes. | 1500 |
| GET | /v1/meta/signals | List the catalogue of signal types and their sample frequencies. | — |
| GET | /v1/meta/health | Service identity + uptime. | — |
poi
| Method | Path | Summary | Cost |
|---|
| GET | /v1/poi/nearby | Find points of interest within a radius (free-tier hard caps). | 1500 |
| GET | /v1/poi/details/{place_id} | Full POI record by place_id. | — |
| GET | /v1/poi/categories | POI taxonomy. | — |
ref
| Method | Path | Summary | Cost |
|---|
| GET | /v1/ref/pincodes | Pincode prefix lookup. | — |
| GET | /v1/ref/holidays | India national holidays catalog. | — |
register
| Method | Path | Summary | Cost |
|---|
| POST | /oauth/register | RFC 7591 dynamic client registration (agents). | 200 |
token
| Method | Path | Summary | Cost |
|---|
| POST | /oauth/token | OAuth 2.1 client_credentials → short-lived JWT. | 100 |
transit
| Method | Path | Summary | Cost |
|---|
| GET | /v1/transit/nearest | Find nearest transit stops within a radius. | 600 |
| GET | /v1/transit/stops | List transit stops by city or H3 cell. | — |
| GET | /v1/transit/routes | List distinct agencies/routes in a city. | — |