Documentation
DocumentationGET /v1/geocode
DOCS / UWA V1 RELEASE CONTRACT SELF-HOSTED GATEWAY

GET /v1/geocode

Forward and reverse geocoding (location.v1)

ONE GATEWAYCoordinates → eligible provider → canonical responseWhy UWA
On this page 4 sections

#Request

Required scope: geocode:read. Registered in internal/routing/router.go (active in default lean_v1 profile).

#Parameters

ParameterTypeNotes
qstringForward place/address lookup
lat, lonnumberReverse lookup alternative
limitintegerResult count limit (1–10)
countrystringOptional ISO country filter

#Request example

curl -H "X-API-Key: YOUR_GATEWAY_KEY" "http://127.0.0.1:8080/v1/geocode?q=Bhilai%2C%20Chhattisgarh%2C%20India"

Verified against the UWA v1 router and request parsers. Replace YOUR_GATEWAY_KEY and configure an eligible upstream provider.

#Availability and provenance

Operator configuration required

Upstream use, caching allowlist, attribution and volume must follow each provider’s policy.

Successful responses return canonical data plus meta (provider attribution, cache/fallback state, request correlation, and meta.partial on /v1/datasets). Refer to docs/openapi.yaml and docs/openapi.experimental.yaml for complete schema definitions.

Canonical contracts: docs/openapi.yaml (lean_v1) and docs/openapi.experimental.yaml · Verify against your build before production use.

Search local documentation. No external requests.

↑↓ to move · Enter to openESC to close