VrilMap Developer API

Versioned JSON API (/api/v1) for geocode, reverse, routing, tiles, and public maps. Authenticate with a VrilMap product key from Vrilsoft My API Manager.

Interactive API reference (Swagger)

Authentication

Create a product key for vrilmap at My API Manager, then send it on every request:

X-Vrilsoft-Api-Key: <your-api-key>
X-Vrilsoft-Api-Secret: <your-api-secret>   # optional when your key was issued with a secret

Staff keys also work. Keys scoped to other products are rejected.

Endpoints

  • GET /api/v1/health — authenticated health
  • GET /api/v1/geocode?q= — place search
  • GET /api/v1/reverse?lat=&lon= — reverse geocode
  • GET /api/v1/route?points=lat,lon;lat,lon&mode=car — directions
  • GET /api/v1/tiles/{provider}/{z}/{x}/{y}.png — map tiles
  • GET /api/v1/maps/{id} — public/unlisted map JSON
  • GET /api/v1/maps/by-slug/{slug} — same by slug

Example

curl -sS "https://vrilmap.com/api/v1/geocode?q=Dublin" \
  -H "Accept: application/json" \
  -H "X-Vrilsoft-Api-Key: YOUR_KEY" \
  -H "X-Vrilsoft-Api-Secret: YOUR_SECRET"

Rate limits

Per product key, per minute (defaults):

  • Geocode / reverse: 60
  • Route: 30
  • Maps: 120
  • Tiles: 600

HTTP 429 with {"error":"rate_limited"} when exceeded.

Attribution

Geocode data via Nominatim/OpenStreetMap; routes via OSRM. Follow OSM attribution requirements in your product UI. Private maker maps are not exposed through this API.

What’s next

  • Embeddable map iframe / widget
  • Owner-scoped write APIs for maker features