Getting started
Quick start
Make your first request in a few minutes, then drop Orvia Maps into whatever you build with.
1. Get an API key
Copy your key from your account — it's free on the Growth plan, no card needed. Keys are shown once, so copy yours when you create it.
Your API keys
Create, copy and revoke keys in your account.
2. Make your first request
Send the key as a Bearer token. Every service lives under one versioned base URL, https://orviamaps.ir/api/v1.
curl -G "https://orviamaps.ir/api/v1/geocode" \ --data-urlencode "q=تهران" \ -H "Authorization: Bearer YOUR_API_KEY"
{"query":"تهران","result":{"id":25960293,"name":"تهران","type":"city","population":9930000,"lat":35.6892523,"lon":51.3896004}}3. Show a map
/api/v1/style.json is a ready-made MapLibre style over Orvia's vector tiles, so a map needs just one URL in any MapLibre SDK — web, iOS, Android, Flutter or React Native.
new maplibregl.Map({
container: "map",
style: "https://orviamaps.ir/api/v1/style.json?key=YOUR_API_KEY",
center: [51.389, 35.689], // Tehran
zoom: 11,
});