osrmroute
API sənədləri, SDK və inteqrasiya təlimatlarıİnteqrasiya və miqrasiya
OSRMRoute / API

API sənədləri, SDK və inteqrasiya təlimatları

API ünvanları, autentifikasiya, limitlər və nümunələrlə tanış olun. Mobil SDK, CLI, MCP, xəritə stilləri, məkan axtarışı və yol məlumatlarını inteqrasiya edin.

OpenAPI · Postman

API kataloqu

API-ni adı, istifadə məqsədi və ya sorğu yolu ilə tapın. Hər keçid parametrlərə, nümunələrə və istifadə hədlərinə aparır.

Naviqasiya (10)
  • Routing API →

    Avtomobil, velosiped və ya piyada profili ilə göndərdiyiniz nöqtələrdən ardıcıllıqla keçən marşrutu hesablayın. Dönüş təlimatları üçün steps=true, GeoJSON üçün geometries=geojson göndərin.

    GET /api/v1/osrm/route/v1/{profile}/{coordinates}
  • Isochrones API →

    Nümunə nöqtələrə yol üzrə səyahət vaxtından çatımlılıq təxmini hesablanır. Hər istiqamətdə çatıla bilən nöqtə varsa quality.status estimated olur; əks halda insufficient_data və boş polygons qaytarılır. Boş nəticə çatıla bilən yolların olmadığını sübut etmir. Sərhəd təxminidir; yalnız vaxt həddi dəstəklənir.

    GET /api/1/isochrone
  • Map Matching API →

    Dəqiq olmayan GPS izlərini real yol şəbəkəsinə uyğunlaşdırır (snap to road). GPS siqnallarındakı yayınmaları təmizləmək üçün istifadə olunur.

    GET /api/v1/osrm/match/v1/{profile}/{coordinates}
  • Nearest API →

    İstənilən koordinatı ona ən yaxın olan real yol seqmentinə bağlayır (snap) və yolun adı haqqında məlumat qaytarır.

    GET /api/v1/osrm/nearest/v1/{profile}/{coordinates}
  • Directions API →

    İki və ya daha çox nöqtə arasında addım-addım naviqasiya qaytarır — təmiz təlimat siyahısı ilə (mətn, məsafə, müddət, manevr növü və koordinat). Avtomobil, velosiped və piyada, həmçinin bir sorğuda 3-ə qədər alternativ marşrutu dəstəkləyir.

    GET /api/1/directions
  • Alternative Routes API →

    İki və ya daha çox nöqtə arasında addım-addım naviqasiya qaytarır — təmiz təlimat siyahısı ilə (mətn, məsafə, müddət, manevr növü və koordinat). Avtomobil, velosiped və piyada, həmçinin bir sorğuda 3-ə qədər alternativ marşrutu dəstəkləyir.

    GET /api/1/directions
  • Snap to Road API →

    Xam, qeyri-dəqiq GPS nöqtələrini yol şəbəkəsindəki ən yaxın mövqeyə yapışdırır. Hər koordinat üçün point parametrini təkrarlayın (100-ə qədər).

    GET /api/1/snap
  • Yanacaq Hesablama API →

    Məsafə, yüklü çəki, boş və tam yüklü sərfiyyat göstəriciləri və litr qiyməti ilə yanacaq miqdarını və səfər dəyərini təxmin edin. Ayrıca və ya Truck sorğusunda istifadə edin.

    POST /api/v1/fuel/estimate
  • Truck Routing API →

    Yol bağlantısı olan ölkədaxili və sərhədlərarası yük marşrutlarını planlayın. Hər sorğuda maşının ölçülərini və yüklü çəkisini göndərin.

    POST /api/v1/truck/route
  • Search Along Route API →

    Marşrut boyunca dayanacaqları və əlavə sürüş vaxtını müqayisə edin.

    POST /api/v1/places/along-route
Əməliyyat və yük planlaması (7)
  • Route Optimization API →

    Tutum, vaxt pəncərəsi, bacarıq və əlaqəli götürmə/çatdırılma şərtləri ilə donanma marşrutlarını planlayır. Məhdud vaxtlı evristik alqoritm səyahət vaxtını azaldır, qlobal optimuma zəmanət vermir. Təyin edilməyən tapşırıqlar solution.unassigned daxilində qalır; etibarsız giriş bütövlükdə rədd edilir.

    POST /api/1/vrp
  • Matrix API →

    Başlanğıc və son nöqtələr arasında müddəti, məsafəni və ya hər ikisini hesablayın. Koordinat siyahısından indeksləri sources və destinations ilə seçin.

    GET /api/v1/osrm/table/v1/{profile}/{coordinates}
  • Trip API (TSP) →

    Yol şəbəkəsinə əsasən bir nəqliyyat vasitəsinin dayanacaqlarını sıralayın. Marşrut başlanğıca qayıda və ya son nöqtədə bitə bilər. Açıq marşrut üçün roundtrip=false&source=first&destination=last göndərin. Sıralamanın optimal olmasına zəmanət verilmir.

    GET /api/v1/osrm/trip/v1/{profile}/{coordinates}
  • Location Clustering →

    Verilmiş koordinatları coğrafi yaxınlıqlarına və sıxlıqlarına görə qruplaşdırır (klasterlərə ayırır).

    POST /api/1/cluster
  • Yük planlaması →

    Qarışıq yükləri maşın, qoşqu və konteyner üçün planlayın. Yığılmanı, yükləmə sırasını və boş yeri 3D-də yoxlayın və ya API-ni öz sisteminizə qoşun.

    POST /api/v1/load-plansGET /api/v1/load-plansGET /api/v1/load-plans/{id}
    Bütün endpointlər (+38)
    DELETE /api/v1/load-plans/{id}POST /api/v1/load-plans/{id}/cancelGET /api/v1/load-plans/{id}/worksheetGET /api/v1/load-plans/{id}/csvGET /api/v1/load-plans/{id}/modelGET /api/v1/load-plans/pricesGET /api/v1/load-plans/import-previewPOST /api/v1/load-plans/import-previewPOST /api/v1/load-plans/comparePOST /api/v1/load-plans/fleetPOST /api/v1/load-plans/{id}/placement-previewPOST /api/v1/load-plans/{id}/placement-revisionsGET /api/v1/load-plans/{id}/pdfGET /api/v1/load-plans/{id}/xlsxPOST /api/v1/load-plans/{id}/shareDELETE /api/v1/load-plans/{id}/sharePOST /api/v1/load-plans/shared-viewPOST /api/v1/load-plans/palletizePOST /api/v1/load-plans/{id}/axle-estimateGET /api/v1/load-plans/workspace/{kind}GET /api/v1/load-plans/workspace/{kind}/{id}PUT /api/v1/load-plans/workspace/{kind}/{id}DELETE /api/v1/load-plans/workspace/{kind}/{id}GET /api/v1/load-plans/webhookPOST /api/v1/load-plans/webhookDELETE /api/v1/load-plans/webhookGET /api/v1/load-plans/webhook/eventsPOST /api/v1/load-plans/webhook/events/{id}POST /api/v1/load-plans/multi-stopPOST /api/v1/load-plans/bulkPOST /api/v1/load-plans/packagingPOST /api/v1/load-plans/dispatchPOST /api/v1/load-plans/fulfillmentPOST /api/v1/load-plans/simulationGET /api/v1/load-plans/{id}/warehousePOST /api/v1/load-plans/{id}/warehouseGET /api/v1/load-plans/{id}/simulation-reportGET /api/v1/load-plans/partner
  • Səfər analitikası: ziyarət sübutu →

    Göndərdiyiniz izdən xəritəyə uyğunlaşdırılmış ziyarət və dayanma sübutu.

    POST /api/v1/trip-analytics/visit-proof
  • Yük maşını parkının optimallaşdırılması →

    Nəqliyyat vasitəsinə xas statik yük maşını matrisləri.

    POST /api/v1/truck/optimize
Axtarış (8)
  • Geocoding API →

    Axtarış mətnini coğrafi koordinatlara (forward) və ya koordinatları ünvana (reverse) çevirir. Sürətli, səhv-yazılışa dözümlü autocomplete — küçələr, ünvanlar və maraq obyektlərini (kafe, mağaza, otel, ofis) əhatə edir. Yazdıqca axtarış üçün idealdır.

    GET /api/1/geocode
  • Places API →

    Bir nöqtənin yaxınlığındakı obyektləri tap — kafe, mağaza, otel, bankomat, aptek və s. — kateqoriya və radiusa görə süzülmüş, məsafəyə görə sıralı.

    GET /api/1/places
  • Autocomplete API →

    İstifadəçi yazdıqca sürətli, səhvə dözümlü ünvan təklifləri (məkan meyli ilə).

    GET /api/1/autocomplete
  • Batch Geocoding API →

    Bir sorğuda 100-dək ünvanı koordinata çevirin. Nəticələr göndərilən sırada qaytarılır və hər ünvan sorğusu bir kreditə hesablanır.

    POST /api/1/geocode/batch
  • Təbii dil axtarışı →

    Qısa ingilis sorğusu ilə məkanları tapın.

    POST /api/v1/search/natural
  • Məkan detalları →

    Axtarış nəticəsindəki mənbə atributlarını oxuyun.

    POST /api/v1/places/details
  • Structured Geocoding API →

    Küçə, şəhər, poçt indeksi və ölkə ilə ünvan axtarın.

    POST /api/v1/search/structured
  • Suggest & Retrieve API →

    Təkliflər və təhlükəsiz nəticə əldəetmə ilə məkan axtarışı yaradın.

    POST /api/v1/search/suggestPOST /api/v1/search/retrieve
Xəritələr (4)
  • Mətnlə stil önizləməsi →

    Rəng və qat dəyişikliklərini yazın, xəritəyə baxıb tətbiq edin.

    POST /api/v1/studio/preview
  • Static Maps API →

    Hesabat və tətbiqlər üçün üslublu xəritələri PNG kimi ixrac edin.

    POST /api/v1/maps/static
  • Studio API →

    Tətbiqinizdən xəritə stillərini, datasetləri və nəşri idarə edin.

    GET /api/v1/studio/{resource}POST /api/v1/studio/{resource}
  • Xəritə üslubları və vektor plitələr →

    MapLibre-də açıq baza xəritələrini və yayımlanmış üslubları yükləyin. Açıq sorğular API açarı tələb etmir və kredit sərf etmir. Üslubun verdiyi plitə ünvanlarından istifadə edin və mənbə istinadını saxlayın.

    GET /api/basemaps/{style}GET /api/map-styles/{id}GET /api/map-styles/{id}/tiles/{dataset}/{z}/{x}/{y}
    Bütün endpointlər (+2)
    GET /api/private-maps/{id}GET /api/private-maps/{id}/tiles/{dataset}/{z}/{x}/{y}
Məlumat (15)
  • Timezone API →

    Yer üzündə istənilən koordinat üçün IANA saat qurşağı, cari UTC ofset, DST statusu və yerli vaxt.

    GET /api/1/timezone
  • Elevation API →

    İstənilən koordinat üçün dəniz səviyyəsindən yüksəklik (metr) — bir nöqtə və ya bütöv marşrut profili.

    GET /api/1/elevation
  • Boundary Lookup API →

    Koordinatın hansı ölkə, əyalət, şəhər və rayona düşdüyünü tapın — istəyə görə sərhəd poliqonu ilə.

    GET /api/1/boundary
  • Geofencing API →

    Bir sorğuda hər nöqtənin hansı zonalarınıza düşdüyünü yoxlayın — poliqon və ya dairəvi hasarlar.

    POST /api/1/geofence
  • Elevation Profile API →

    Yolun hər nöqtəsində yüksəklik + ümumi dırmanma, eniş və məsafə — tam marşrut profili.

    POST /api/1/elevation/profile
  • Solar API →

    İstənilən koordinat və tarix üçün gündoğumu, günbatımı, toran, solar noon və gün uzunluğu.

    GET /api/1/solar
  • Geometry Utilities API →

    Məsafə, bearing, sahə, mərkəz, sadələşdirmə və polyline encode/decode — məkan riyaziyyatı xidmət kimi.

    POST /api/1/geometry
  • Coordinate Conversion API →

    Enlik/uzunluğu UTM və MGRS grid işarələrinə və əksinə çevir.

    GET /api/1/convert
  • Country Info API →

    İstənilən ölkə üçün valyuta, telefon kodu, dillər, paytaxt və bayraq — ISO kod və ya ad ilə.

    GET /api/1/country
  • Dataset Query API →

    Yüklədiyiniz coğrafi datasetlərdə yaxın obyektləri tapın.

    POST /api/v1/maps/datasets/{id}/query
  • Yol Məlumatları API →

    Mövcud əhatədə sürət hədləri, yol atributları və yol nişanı müşahidələri.

    POST /api/v1/roads/lookupPOST /api/v1/roads/batch
  • Hesabın istifadəsi →

    Yol məlumatları: ayda 100 000 əməliyyat

    POST /api/v1/roads/usage
  • Yol Nişanları API →

    Xəritədə seçilmiş ərazidə yol nişanı müşahidələrini tapın. Nişan təsnifatı, koordinatlar, istiqamət və müşahidə tarixlərini səhifələmə ilə əldə edin.

    POST /api/v1/roads/signs
  • Marşrut uyğunluq sübutu →

    Göndərilən marşrut mövqeləri üçün mənbə-kvalifikasiyalı sürət sübutu.

    POST /api/v1/roads/compliance
  • Yolun sürət həddi →

    Koordinata yaxın yolun xəritədə qeyd olunan minik avtomobili sürət həddini əldə edin. Məlumat çatışmadıqda və ya qeyri-müəyyən olduqda nəticə null olur.

    GET /api/1/speed-limit
Platforma inteqrasiya təlimatı (6)
  • Asinxron tapşırıqlar →

    Əməliyyatlar: geocode_batch, matrix, optimize. POST /api/jobs 202 və iş ID-si qaytarır. Eyni Idempotency-Key və eyni məzmun eyni işi qaytarır; dəyişmiş məzmun 409 qaytarır.

    POST /api/jobsGET /api/jobsGET /api/jobs/{id}
    Bütün endpointlər (+1)
    DELETE /api/jobs/{id}
  • Sandbox API →

    Əvvəl sandbox-da cavab strukturunu yoxlayın. Cavab fixture-dir; canlı geocoding və yol hesablaması deyil.

    POST /api/sandbox
  • Məlumat mənbələri →

    Xidmət üzrə məlumat mənbələrinə, coğrafi əhatəyə və məlumatın yenilənmə tarixinə baxın.

    GET /api/source-metadata
  • Mobil giriş →

    Mobil tətbiqinizi məxfi API açarı yerləşdirmədən qoşun.

    POST /api/mobile/challengePOST /api/mobile/token
  • Remote MCP API →

    AI alətlərini məkan xidmətlərinə bağla.

    POST /api/mcp
  • Əvvəlki inteqrasiyalar üçün endpoint-lər →

    Mövcud inteqrasiyanı əsas API-yə keçirərkən koordinat sırasını və cavabdakı ölçü vahidlərini yoxlayın.

    GET /api/v1/route/{profile}/{coordinates}GET /api/1/routeGET /api/1/route/info
    Bütün endpointlər (+9)
    GET /api/1/matrixPOST /api/1/matrixPOST /api/1/matrix/calculatePOST /api/1/matchPOST /api/1/elevationPOST /api/1/optimizePOST /api/1/vrp/optimizePOST /api/1/cluster/calculatePOST /api/1/batch-geocode

Giriş

#

OSRMRoute yol marşrutları, park planlaması, ünvan axtarışı, xəritələr və coğrafi məlumatlar üçün API-lər təqdim edir. İnteqrasiya edəcəyiniz əməliyyatın təlimatını kataloqdan tapın.

Cari plan limitləri

Kredit və dəqiqəlik sorğu limitləri hesabın bütün açarları arasında paylaşılır. Açara ayrıca qoyulan kredit həddi ümumi büdcəni artırmır. Əvvəl paket qalığı, sonra alınmış kreditlər istifadə olunur.

Free planına limitlər daxilində Routing, Route Optimization, Geocoding (əks ünvan axtarışı və avtomatik tamamlama daxil) və Matrix API-ləri daxildir. Map Matching, Isochrone, Truck Routing, Fuel Estimate və digər ayrıca API-lər üçün PAYG daxil ödənişli plan tələb olunur. API icazələri hesabın qüvvədə olan planına əsaslanır; balansın olması təkbaşına Free məhdudiyyətlərini aradan qaldırmır. Yol məlumatları və AI üçün ayrıca Business tələbləri qüvvədə qalır.

Route, Directions və Truck Routing: emal edilmiş sorğuda yaxın uyğun yol və ya birləşən marşrut tapılmadıqda PAYG daxil bütün uyğun planlarda bir dəfə 0,5 kredit tutulur. Səhv giriş, giriş/plan və ya dəstəklənməyən qraf əhatəsi səbəbindən rədd, həmçinin server xətaları ödənişsizdir. Əvvəl uğurlu sorğunun qiyməti rezerv edilir; artıq hissə qaytarılır.

Cari limitlər yüklənir…

Açıq xəritə demosu ayrıca demo limitləri ilə Route, Matrix, Match, Nearest və Trip xidmətlərini dəstəkləyir. Digər xidmətlər üçün API açarınızı və aşağıdakı nümunələri istifadə edin.

Autentifikasiya

#

API açarını Authorization başlığında Bearer token kimi göndərin. Tələb olunan açar icazəsini və mühitini əməliyyatın sənədindən yoxlayın. Bəzi köhnə endpoint-lər açarı URL parametrində də qəbul edir.

HTTP
Authorization: Bearer YOUR_API_KEY

Xəta Kodları

#

OSRMRoute, sorğunun vəziyyətini bildirmək üçün standart HTTP status kodlarından və ətraflı JSON xəta mesajlarından istifadə edir.

Xətada error və əlavə code sahəsi ola bilər; yalnız xəta mətninə əsaslanmayın. HTTP statusunu və qalan limit başlıqlarını oxuyun. Reset başlıqları gecə yarısını deyil, sürüşən vaxt pəncərəsini bildirir.

X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Compute-* · X-Quota-* · X-Credits-* · Retry-After

Etibarlı API açarı verin; açarın statusunu paneldə yoxlayın.

HTTP 401
{
  "error": "Invalid API Key"
}

Balansı artırın və ya sorğuya uyğun plan seçin.

HTTP 402
{
  "error": "Insufficient balance: this request costs 1 credit and your balance is 0 credits. Top up your account to continue."
}

Planın mürəkkəblik limitlərini və açar məhdudiyyətlərini paneldə yoxlayın.

HTTP 403
{
  "error": "This API Key is disabled"
}

Retry-After varsa ona əməl edin və sorğu tezliyini azaldın.

HTTP 429
{
  "error": "Rate limit exceeded: this account has exceeded its configured requests-per-minute limit. Please slow down."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 500
{
  "error": "Internal Server Error"
}

Routing API

#

Avtomobil, velosiped və ya piyada profili ilə göndərdiyiniz nöqtələrdən ardıcıllıqla keçən marşrutu hesablayın. Dönüş təlimatları üçün steps=true, GeoJSON üçün geometries=geojson göndərin.

GET
/api/v1/osrm/route/v1/{profile}/{coordinates}

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
profilestringMəcburidrivingNəqliyyat növü profili. Dəstəklənən dəyərlər: driving (avtomobil), cycling (velosiped), walking (piyada).
coordinatesstringMəcburi-Nöqtələrin koordinatları. Format: lon,lat;lon,lat;lon,lat... (ən azı 2 nöqtə).
overviewstringKönüllüsimplifiedQayıdan marşrut həndəsəsinin detalı: simplified (sadələşdirilmiş), full (tam həndəsə), false (həndəsəsiz).
geometriesstringKönüllüpolylineHəndəsə formatı: geojson (GeoJSON obyekt), polyline (kodlaşdırılmış sətir).
stepsbooleanKönüllüfalseHər dönmə nöqtəsi üçün addım-addım təlimatların qaytarılıb-qaytarılmaması.
alternativesinteger | booleanKönüllüfalseAxtarılacaq alternativ marşrutların sayı. Mövcudluq yol şəbəkəsindən asılıdır.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Routing API
curl "https://osrmroute.com/api/v1/osrm/route/v1/driving/49.8516,40.3777;49.86,40.40?steps=true&overview=full&geometries=geojson" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: Hər başlanmış 10 giriş nöqtəsinə 1 kredit; başlanğıc və son daxildir.

Route, Directions və Truck Routing: emal edilmiş sorğuda yaxın uyğun yol və ya birləşən marşrut tapılmadıqda PAYG daxil bütün uyğun planlarda bir dəfə 0,5 kredit tutulur. Səhv giriş, giriş/plan və ya dəstəklənməyən qraf əhatəsi səbəbindən rədd, həmçinin server xətaları ödənişsizdir. Əvvəl uğurlu sorğunun qiyməti rezerv edilir; artıq hissə qaytarılır.

OSRM yolunda: lon,lat; GeoJSON: [lon,lat].

  • points ≥ 2; points ≤ plan.maxRoutePoints
  • snap_distance_m ≤ 2000

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "routes": [
    {
      "distance": 3200,
      "duration": 420,
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            49.8516,
            40.3777
          ],
          [
            49.86,
            40.4
          ]
        ]
      },
      "legs": [
        {
          "distance": 3200,
          "duration": 420,
          "steps": []
        }
      ]
    }
  ],
  "waypoints": [
    {
      "name": "Example road",
      "location": [
        49.8516,
        40.3777
      ],
      "distance": 4.2
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidQuery",
  "error": "Coordinates must be finite longitude,latitude pairs."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

API seçilmiş profil üzrə bütün nöqtələri eyni yol şəbəkəsində emal edə bilmədi. Yol bağlantısı olan hissələri ayrı sorğularla göndərin.

HTTP 422
{
  "code": "CrossRegionNotSupported",
  "error": "These coordinates are not served by one routing graph. Split the request by region."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

Cavabda məsafə metrlə, müddət saniyə ilə verilir. Standart marşrut xətti sadələşdirilmiş, standart geometriya formatı isə polyline-dır. Tam xətt üçün overview=full göndərin.

Matrix API

#

Başlanğıc və son nöqtələr arasında müddəti, məsafəni və ya hər ikisini hesablayın. Koordinat siyahısından indeksləri sources və destinations ilə seçin.

GET
/api/v1/osrm/table/v1/{profile}/{coordinates}

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
profilestringMəcburidrivingNəqliyyat profili (driving, cycling, walking).
coordinatesstringMəcburi-Matris nöqtələri. Format: lon,lat;lon,lat;lon,lat...
annotationsstringKönüllüdurationHesablanacaq məlumat: duration (vaxt), distance (məsafə) və ya hər ikisi.
sourcesstringKönüllüallSıfırdan başlayan çıxış indekslərini nöqtəli vergüllə ayırın və ya all göndərin.
destinationsstringKönüllüallSıfırdan başlayan təyinat indekslərini nöqtəli vergüllə ayırın və ya all göndərin.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Matrix API
curl "https://osrmroute.com/api/v1/osrm/table/v1/driving/49.85,40.37;49.86,40.40;49.83,40.39?annotations=duration,distance" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: max(1, ceil(cells * 2 / 5))

OSRM yolunda: lon,lat; GeoJSON: [lon,lat].

  • points ≥ 2; points ≤ plan.maxRoutePoints
  • cells = sources × destinations
  • credits = max(1, ceil(cells * 2 / 5))

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "durations": [
    [
      0,
      420
    ],
    [
      430,
      0
    ]
  ],
  "distances": [
    [
      0,
      3200
    ],
    [
      3300,
      0
    ]
  ],
  "sources": [
    {
      "name": "Example road",
      "location": [
        49.8516,
        40.3777
      ],
      "distance": 4.2
    },
    {
      "name": "Second road",
      "location": [
        49.86,
        40.4
      ],
      "distance": 3
    }
  ],
  "destinations": [
    {
      "name": "Example road",
      "location": [
        49.8516,
        40.3777
      ],
      "distance": 4.2
    },
    {
      "name": "Second road",
      "location": [
        49.86,
        40.4
      ],
      "distance": 3
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidQuery",
  "error": "Coordinates must be finite longitude,latitude pairs."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

API seçilmiş profil üzrə bütün nöqtələri eyni yol şəbəkəsində emal edə bilmədi. Yol bağlantısı olan hissələri ayrı sorğularla göndərin.

HTTP 422
{
  "code": "CrossRegionNotSupported",
  "error": "These coordinates are not served by one routing graph. Split the request by region."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "UnreachablePoints",
  "error": "Some locations are disconnected in this road network."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

Standart cavabda durations matrisi qaytarılır. Yalnız məsafə üçün annotations=distance, hər iki matris üçün annotations=duration,distance göndərin. Müddət saniyə, məsafə metr ilə verilir. Uyğun qrafların heç biri matrisi tam hesablaya bilmirsə, əlaqəsiz nöqtələr üçün HTTP 422 UnreachablePoints qaytarılır.

Map Matching API

#

Dəqiq olmayan GPS izlərini real yol şəbəkəsinə uyğunlaşdırır (snap to road). GPS siqnallarındakı yayınmaları təmizləmək üçün istifadə olunur.

GET
/api/v1/osrm/match/v1/{profile}/{coordinates}

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
geometriesstringKönüllüpolylineHəndəsə formatı: geojson (GeoJSON obyekt), polyline (kodlaşdırılmış sətir).
profilestringMəcburidrivingNəqliyyat profili.
coordinatesstringMəcburi-Yola uyğunlaşdırılacaq (snap ediləcək) GPS koordinatlarının ardıcıllığı (lon,lat;lon,lat...)
overviewstringKönüllüsimplifiedUyğunlaşdırılmış marşrutun həndəsə dəqiqliyi.
timestampsstringKönüllü-Hər nöqtə üçün saniyə ilə bir Unix vaxtı verin. Vaxtlar azalmamalı və nöqtəli vergüllə ayrılmalıdır.
radiusesstringKönüllü-Hər nöqtə üçün metrlə GPS dəqiqliyi verin. Dəyərləri nöqtəli vergüllə ayırın.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Map Matching API
curl "https://osrmroute.com/api/v1/osrm/match/v1/driving/49.851536,40.375480;49.844011,40.379982;49.839336,40.389620;49.837774,40.389268?overview=full&geometries=geojson" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

OSRM yolunda: lon,lat; GeoJSON: [lon,lat].

  • points ≥ 2; points ≤ plan.maxRoutePoints
  • tracepoints[]: object | null

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "matchings": [
    {
      "distance": 3200,
      "duration": 420,
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            49.8516,
            40.3777
          ],
          [
            49.86,
            40.4
          ]
        ]
      },
      "legs": [
        {
          "distance": 3200,
          "duration": 420,
          "steps": []
        }
      ],
      "confidence": 0.97
    }
  ],
  "tracepoints": [
    {
      "name": "Example road",
      "location": [
        49.8516,
        40.3777
      ],
      "distance": 4.2
    },
    null
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidQuery",
  "error": "Coordinates must be finite longitude,latitude pairs."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

API seçilmiş profil üzrə bütün nöqtələri eyni yol şəbəkəsində emal edə bilmədi. Yol bağlantısı olan hissələri ayrı sorğularla göndərin.

HTTP 422
{
  "code": "CrossRegionNotSupported",
  "error": "These coordinates are not served by one routing graph. Split the request by region."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

matchings[]: distance — məsafə (m), duration — müddət (s), confidence — uyğunluq (0–1), geometry — geometriya; tracepoints[] — obyekt və ya null.

Nearest API

#

İstənilən koordinatı ona ən yaxın olan real yol seqmentinə bağlayır (snap) və yolun adı haqqında məlumat qaytarır.

GET
/api/v1/osrm/nearest/v1/{profile}/{coordinates}

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
profilestringMəcburidrivingNəqliyyat profili.
coordinatesstringMəcburi-Yaxınlığı axtarılan nöqtə. Format: lon,lat (tək cüt).
numberintegerKönüllü1Tapılacaq ən yaxın yol namizədlərinin sayı.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Nearest API
curl "https://osrmroute.com/api/v1/osrm/nearest/v1/driving/49.8516,40.3777?number=3" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

OSRM yolunda: lon,lat; GeoJSON: [lon,lat].

  • coordinates: 1
  • number: default = 1; example = 3

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "waypoints": [
    {
      "name": "Example road",
      "location": [
        49.8516,
        40.3777
      ],
      "distance": 4.2
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidQuery",
  "error": "Coordinates must be finite longitude,latitude pairs."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

waypoints[] → name, distance (m), location [lon,lat].

Trip API

#

Yol şəbəkəsinə əsasən bir nəqliyyat vasitəsinin dayanacaqlarını sıralayın. Marşrut başlanğıca qayıda və ya son nöqtədə bitə bilər. Açıq marşrut üçün roundtrip=false&source=first&destination=last göndərin. Sıralamanın optimal olmasına zəmanət verilmir.

GET
/api/v1/osrm/trip/v1/{profile}/{coordinates}

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
geometriesstringKönüllüpolylineHəndəsə formatı: geojson (GeoJSON obyekt), polyline (kodlaşdırılmış sətir).
profilestringMəcburidrivingNəqliyyat profili.
coordinatesstringMəcburi-Gəziləcək nöqtələr. Format: lon,lat;lon,lat...
sourcestringKönüllüanyMarşrutun başlaya biləcəyi nöqtə (any və ya birinci nöqtə).
destinationstringKönüllüanyMarşrutun bitəcəyi nöqtə (any və ya sonuncu nöqtə).
roundtripbooleanKönüllütrueBaşlanğıc nöqtəsinə qayıtmaq. false üçün source=first və destination=last göndərin.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Trip API (TSP)
curl "https://osrmroute.com/api/v1/osrm/trip/v1/driving/49.85,40.37;49.86,40.40;49.83,40.39?source=first&geometries=geojson" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 5 credits

OSRM yolunda: lon,lat; GeoJSON: [lon,lat].

  • points ≥ 2; points ≤ plan.maxRoutePoints
  • credits = 5

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "trips": [
    {
      "distance": 3200,
      "duration": 420,
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            49.8516,
            40.3777
          ],
          [
            49.86,
            40.4
          ]
        ]
      },
      "legs": [
        {
          "distance": 3200,
          "duration": 420,
          "steps": []
        }
      ]
    }
  ],
  "waypoints": [
    {
      "name": "Example road",
      "location": [
        49.8516,
        40.3777
      ],
      "distance": 4.2,
      "trips_index": 0,
      "waypoint_index": 0
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidQuery",
  "error": "Coordinates must be finite longitude,latitude pairs."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

API seçilmiş profil üzrə bütün nöqtələri eyni yol şəbəkəsində emal edə bilmədi. Yol bağlantısı olan hissələri ayrı sorğularla göndərin.

HTTP 422
{
  "code": "CrossRegionNotSupported",
  "error": "These coordinates are not served by one routing graph. Split the request by region."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

trips[]: distance — məsafə (m), duration — müddət (s), geometry — geometriya; waypoints[]: trips_index, waypoint_index — sıra indeksləri, location [lon,lat] — koordinatlar.

Directions API

#

İki və ya daha çox nöqtə arasında addım-addım naviqasiya qaytarır — təmiz təlimat siyahısı ilə (mətn, məsafə, müddət, manevr növü və koordinat). Avtomobil, velosiped və piyada, həmçinin bir sorğuda 3-ə qədər alternativ marşrutu dəstəkləyir.

GET
/api/1/directions

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburilat,lngNöqtə: lat,lng. Hər dayanacaq üçün parametri təkrarlayın (minimum 2).
profilestringKönüllüdrivingHərəkət növü: driving, cycling və ya walking.
alternativesintegerKönüllü0Əlavə qaytarılacaq alternativ marşrutların sayı (0–3).
langstringKönüllüenTəlimat mətninin dil kodu.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Directions API
curl "https://osrmroute.com/api/1/directions?point=40.3777,49.8516&point=40.40,49.86&profile=driving" -H "Authorization: Bearer YOUR_KEY"
Alternative Routes API
curl "https://osrmroute.com/api/1/directions?point=40.3777,49.8516&point=40.40,49.86&alternatives=2" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: Hər başlanmış 10 giriş nöqtəsinə 1 kredit; başlanğıc və son daxildir.

Route, Directions və Truck Routing: emal edilmiş sorğuda yaxın uyğun yol və ya birləşən marşrut tapılmadıqda PAYG daxil bütün uyğun planlarda bir dəfə 0,5 kredit tutulur. Səhv giriş, giriş/plan və ya dəstəklənməyən qraf əhatəsi səbəbindən rədd, həmçinin server xətaları ödənişsizdir. Əvvəl uğurlu sorğunun qiyməti rezerv edilir; artıq hissə qaytarılır.

Giriş point=lat,lng. Təlimat/dayanacaq yerləri: [lat,lng]; GeoJSON həndəsəsi: [lon,lat].

  • point: repeat ≥ 2; count ≤ plan.maxRoutePoints
  • alternatives: 0–3

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "profile": "driving",
  "routes": [
    {
      "distance": 3200,
      "duration": 420,
      "geometry": {
        "type": "LineString",
        "coordinates": [
          [
            49.8516,
            40.3777
          ],
          [
            49.86,
            40.4
          ]
        ]
      },
      "instructions": [
        {
          "text": "Continue on Example road",
          "type": "continue",
          "modifier": "straight",
          "distance": 300,
          "duration": 40,
          "name": "Example road",
          "bearing_after": 90,
          "location": [
            40.3777,
            49.8516
          ]
        }
      ]
    }
  ],
  "waypoints": [
    {
      "name": "Example road",
      "location": [
        40.3777,
        49.8516
      ]
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "At least two points must be provided (point=lat,lng repeated)."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

API seçilmiş profil üzrə bütün nöqtələri eyni yol şəbəkəsində emal edə bilmədi. Yol bağlantısı olan hissələri ayrı sorğularla göndərin.

HTTP 422
{
  "code": "CrossRegionNotSupported",
  "error": "These coordinates are not served by one routing graph. Split the request by region."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

{ code, profile, routes[], waypoints[] } qaytarır. Hər marşrutda distance (m), duration (san), GeoJSON həndəsə və instructions[] massivi var; hər təlimat text, type, modifier, distance, duration, name və [lat,lng] location daxil edir.

Snap to Road API

#

Xam, qeyri-dəqiq GPS nöqtələrini yol şəbəkəsindəki ən yaxın mövqeyə yapışdırır. Hər koordinat üçün point parametrini təkrarlayın (100-ə qədər).

GET
/api/1/snap

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburilat,lngGPS nöqtəsi: lat,lng. Hər nöqtə üçün parametri təkrarlayın (maksimum 100).
profilestringKönüllüdrivingYapışdırılacaq yol şəbəkəsi: driving, cycling və ya walking.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Snap to Road API
curl "https://osrmroute.com/api/1/snap?point=40.3778,49.8517&point=40.3801,49.8600" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • point: repeat 1–100

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "code": "Ok",
  "profile": "driving",
  "snapped": [
    {
      "input": [
        40.3777,
        49.8516
      ],
      "snapped": [
        40.3778,
        49.8517
      ],
      "distance": 14,
      "name": "Example road"
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "At least one point must be provided (point=lat,lng repeated)."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

{ code, profile, snapped[] } qaytarır. Hər element orijinal input [lat,lng], yapışdırılmış [lat,lng] mövqe, metrlə yapışma məsafəsi və yol adını daxil edir.

Geocoding API

#

Axtarış mətnini coğrafi koordinatlara (forward) və ya koordinatları ünvana (reverse) çevirir. Sürətli, səhv-yazılışa dözümlü autocomplete — küçələr, ünvanlar və maraq obyektlərini (kafe, mağaza, otel, ofis) əhatə edir. Yazdıqca axtarış üçün idealdır.

GET
/api/1/geocode

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
qstringKönüllü-Axtarılan ünvan (məs: "Nizami küçəsi, Bakı").
reversebooleanKönüllüfalseƏks geocoding (koordinatdan ünvana axtarış) etmək üçün true olmalıdır.
pointstringKönüllülat,lngÜnvana çevirmək üçün koordinat (lat,lng). reverse=true olduqda tələb olunur.
limitintegerKönüllü5Qaytarılacaq nəticələrin maksimum sayı (1–20, defolt 5).
langstringKönüllüenNəticə adları üçün üstün tutulan dil (məs. en, az, ru). Defolt en.
latnumberKönüllü-Nəticələri yaxınlaşdırmaq üçün en dairəsi (yaxın nəticələr öndə). lon ilə birlikdə.
lonnumberKönüllü-Nəticələri yaxınlaşdırmaq üçün uzunluq dairəsi. lat ilə birlikdə.
bboxstringKönüllü-Nəticələri sərhəd qutusu ilə məhdudlaşdır: minLon,minLat,maxLon,maxLat.
osm_tagstringKönüllü-OSM teqinə görə filtr, məs. place (yaşayış məntəqələri) və ya amenity:cafe. İstisna üçün ! önləməsi.
countrystringKönüllü-ISO 3166-1 alpha-2 ölkə kodu, məsələn AZ. Yalnız həmin ölkənin nəticələri qaytarılır.
citystringKönüllü-Məcburi şəhər filtri, məsələn Bakı. Bir country kodu ilə birlikdə göndərilməlidir.
elasticbooleanKönüllütrueElastik (fuzzy, yüksək əhatə) axtarış — defolt true. Səhvlərə, çatışmayan diakritikaya (ə↔e), söz sırasına, ümumi sözlərə (metro, rayonu) və ev nömrələrinə dözümlüdür. Dəqiq uyğunluq üçün false verin.

Ölkə və şəhər filtrləri

Ölkə göndərilmədikdə axtarış qlobaldır. country=AZ yalnız Azərbaycanı, country=AZ&city=Bakı yalnız Bakını əhatə edir. Uyğun nəticə olmadıqda HTTP 200 və boş siyahı qaytarılır; başqa əraziyə keçid edilmir. Şəhər ölkəsiz və ya yanlış ölkə kodu ilə göndərildikdə HTTP 400 InvalidGeocodeFilter qaytarılır. lat/lon yaxınlıq sıralamasıdır və bu filtrləri dəyişmir. Şəhəri təsdiqlənməyən qeydlər şəhər filtrinə daxil edilmir.

Nümunələr
GET /api/1/geocode?q=Nizami&country=AZ
GET /api/1/geocode?q=Nizami&country=AZ&city=Bak%C4%B1

HTTP 200: { "hits": [], "took": 12 }
HTTP 400: { "code": "InvalidGeocodeFilter", "error": "city requires exactly one country, for example country=AZ&city=Bakı." }

Nümunələr

Nümunələr
# Məkana yönləndir, yalnız yaşayış məntəqələri
GET /api/1/geocode?q=qala&lat=40.41&lon=49.87&osm_tag=place

# Yalnız seçilmiş ölkə və şəhər
GET /api/1/geocode?q=market&country=AZ&city=Bak%C4%B1

# Reverse geocode (koordinatdan ünvana)
GET /api/1/geocode?reverse=true&point=40.409,49.867

Dəqiq ünvan axtarışında küçəni və ev nömrəsini q parametrində göndərin. locality və postcode üçün bir ölkə göstərilməlidir. unit mənbədəki mənzil və ya bölməni dəqiq seçir və address_mode=units rejimini işə salır. Standart buildings rejimi eyni nöqtədəki bölmə qeydlərini qruplaşdırır.

GET
/api/1/geocode?q=101+Main+Street&country=US&locality=Boston&postcode=02129&unit=2&address_mode=units

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Geocoding API
curl "https://osrmroute.com/api/1/geocode?q=Nizami&country=AZ&city=Bak%C4%B1&lang=az" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • limit: 1–20
  • reverse: max_distance_m = 1000
  • city: exactly 1 country

Uyğunluq tapılmasa, uğurlu cavab boş siyahı ola bilər. Ölkə/şəhər filtrləri başqa bazarlara genişləndirilmir. Ünvan detalları indekslənmiş məlumatdan asılıdır.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "hits": [
    {
      "name": "Nizami Street",
      "city": "Baku",
      "country": "Azerbaijan",
      "countrycode": "AZ",
      "point": {
        "lat": 40.3777,
        "lng": 49.8516
      }
    }
  ],
  "took": 12
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "The \"q\" parameter (search text) is required."
}

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidGeocodeFilter",
  "error": "city requires exactly one country, for example country=AZ&city=Bakı."
}

Əks axtarış radiusunda indekslənmiş ünvan və ya yer yoxdur.

HTTP 422
{
  "code": "NoNearbyAddress",
  "error": "No indexed address or place within 1 km."
}

Cavab Strukturunun Şərhi

hits[]: name, city, country, countrycode — yer və ölkə məlumatları, point (lat,lng) — koordinatlar; took — vaxt (ms). reverse=true: source — mənbə, accuracy — dəqiqlik, distance_m — məsafə.

Yerlər (Yaxın POI)

#

Bir nöqtənin yaxınlığındakı obyektləri tap — kafe, mağaza, otel, bankomat, aptek və s. — kateqoriya və radiusa görə süzülmüş, məsafəyə görə sıralı.

GET
/api/1/places

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburilat,lngƏtrafında axtarılacaq mərkəz koordinatı lat,lng (tələb olunur).
radiusnumberKönüllü1Axtarış radiusu kilometrlə (0.05–20, defolt 1).
categorystringKönüllü-OSM teq filtri, məs. amenity:cafe, shop, tourism:hotel. İstisna üçün !. Boş = bütün POI-lər.
limitintegerKönüllü10Maksimum nəticə (1–50, defolt 10).
langstringKönüllüenAdlar üçün üstün tutulan dil (məs. en, az, ru).

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Places API
curl "https://osrmroute.com/api/1/places?point=40.371,49.845&radius=1&category=amenity:cafe" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • radius: 0.05–20 km
  • limit: 1–50

Uyğunluq tapılmasa, uğurlu cavab boş siyahı ola bilər. Ölkə/şəhər filtrləri başqa bazarlara genişləndirilmir. Ünvan detalları indekslənmiş məlumatdan asılıdır.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "places": [
    {
      "name": "Example cafe",
      "category": "amenity",
      "type": "cafe",
      "distance_m": 85,
      "point": {
        "lat": 40.3777,
        "lng": 49.8516
      }
    }
  ],
  "took": 12
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "The \"point\" parameter (lat,lng) is required."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 502
{
  "error": "Places service unavailable."
}

Cavab Strukturunun Şərhi

places[]: name, category, type — yer məlumatları, distance_m — məsafə, point (lat,lng) — koordinatlar; took — vaxt (ms).

Autocomplete API

#

İstifadəçi yazdıqca sürətli, səhvə dözümlü ünvan təklifləri (məkan meyli ilə).

GET
/api/1/autocomplete

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
qstringMəcburi-Axtarış mətni — natamam giriş də olar.
limitintegerKönüllü8Qaytarılacaq maksimum təklif sayı (1–15).
langstringKönüllüenNəticə etiketləri üçün dil kodu.
latnumberKönüllü-Nəticələri yönləndirmək üçün en dairəsi (opsional).
lonnumberKönüllü-Nəticələri yönləndirmək üçün uzunluq dairəsi (opsional).
countrystringKönüllü-ISO 3166-1 alpha-2 ölkə kodu, məsələn AZ. Yalnız həmin ölkənin nəticələri qaytarılır.
citystringKönüllü-Məcburi şəhər filtri, məsələn Bakı. Bir country kodu ilə birlikdə göndərilməlidir.
osm_tagstringKönüllü-Təklifləri OSM növünə görə süz, məs. place:city.

Ölkə və şəhər filtrləri

Ölkə göndərilmədikdə axtarış qlobaldır. country=AZ yalnız Azərbaycanı, country=AZ&city=Bakı yalnız Bakını əhatə edir. Uyğun nəticə olmadıqda HTTP 200 və boş siyahı qaytarılır; başqa əraziyə keçid edilmir. Şəhər ölkəsiz və ya yanlış ölkə kodu ilə göndərildikdə HTTP 400 InvalidGeocodeFilter qaytarılır. lat/lon yaxınlıq sıralamasıdır və bu filtrləri dəyişmir. Şəhəri təsdiqlənməyən qeydlər şəhər filtrinə daxil edilmir.

Nümunələr
GET /api/1/autocomplete?q=Nizami&country=AZ
GET /api/1/autocomplete?q=Nizami&country=AZ&city=Bak%C4%B1

HTTP 200: { "suggestions": [], "took": 12 }
HTTP 400: { "code": "InvalidGeocodeFilter", "error": "city requires exactly one country, for example country=AZ&city=Bakı." }

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Autocomplete API
curl "https://osrmroute.com/api/1/autocomplete?q=niz&lang=az&lat=40.40&lon=49.86" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • limit: 1–15
  • city: exactly 1 country

Uyğunluq tapılmasa, uğurlu cavab boş siyahı ola bilər. Ölkə/şəhər filtrləri başqa bazarlara genişləndirilmir. Ünvan detalları indekslənmiş məlumatdan asılıdır.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "suggestions": [
    {
      "name": "Nizami Street",
      "city": "Baku",
      "country": "Azerbaijan",
      "countrycode": "AZ",
      "point": {
        "lat": 40.3777,
        "lng": 49.8516
      },
      "label": "Nizami Street, Baku, Azerbaijan"
    }
  ],
  "took": 12
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "The \"q\" parameter (search text) is required."
}

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidGeocodeFilter",
  "error": "city requires exactly one country, for example country=AZ&city=Bakı."
}

Cavab Strukturunun Şərhi

{ suggestions[], took } qaytarır. Hər təklif label, name, city, state, country, countrycode, type, osm_id və point {lat,lng} daxil edir.

Batch Geocoding API

#

Bir sorğuda 100-dək ünvanı koordinata çevirin. Nəticələr göndərilən sırada qaytarılır və hər ünvan sorğusu bir kreditə hesablanır.

POST
/api/1/geocode/batch

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
queriesarrayMəcburi[]Geocode ediləcək ünvan sətirləri massivi (maks 100).
langstringKönüllüenNəticə etiketləri üçün dil kodu.
limitintegerKönüllü1Hər sorğu üçün maksimum uyğunluq sayı (1–5).

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Batch Geocoding API
curl -X POST "https://osrmroute.com/api/1/geocode/batch" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"queries":["Nizami küçəsi 10","28 May, Bakı"],"lang":"az"}'

Limitlər və koordinatlar

Kredit sərfi: 1 credit / query

JSON-dakı sahə adlarına baxın; bu sorğu koordinat cütü tələb etmir.

  • queries: 1–100
  • limit: 1–5 / query
  • credits = queries.length

Uyğunluq tapılmasa, uğurlu cavab boş siyahı ola bilər. Ölkə/şəhər filtrləri başqa bazarlara genişləndirilmir. Ünvan detalları indekslənmiş məlumatdan asılıdır.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "results": [
    {
      "query": "Baku",
      "hits": [
        {
          "name": "Nizami Street",
          "city": "Baku",
          "country": "Azerbaijan",
          "countrycode": "AZ",
          "point": {
            "lat": 40.3777,
            "lng": 49.8516
          }
        }
      ]
    }
  ],
  "count": 1,
  "took": 12
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Body must include a non-empty \"queries\" array of address strings."
}

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "A maximum of 100 queries can be geocoded per batch request."
}

Cavab Strukturunun Şərhi

{ results[], count, took } qaytarır. Hər nəticə giriş query-ni hits[] massivi ilə cütləşdirir; hər uyğunluq label, city, country və point {lat,lng} daxil edir. Nəticələr giriş ardıcıllığını saxlayır.

Timezone API

#

Yer üzündə istənilən koordinat üçün IANA saat qurşağı, cari UTC ofset, DST statusu və yerli vaxt.

GET
/api/1/timezone

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringKönüllü-point=lat,lng göndərin və ya lat ilə lon parametrlərinin hər ikisini göstərin.
latnumberKönüllü-En dairəsi (point əvəzinə).
lonnumberKönüllü-Uzunluq dairəsi (point əvəzinə).
timestampstringKönüllünowOfsetin hesablanacağı Unix vaxtı (saniyə) və ya ISO tarix; defolt indi.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Timezone API
curl "https://osrmroute.com/api/1/timezone?point=40.4093,49.8671" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • timestamp: Unix seconds | ISO 8601; default = now
  • utc_offset_seconds: seconds

Giriş formatını yoxlayın və nümunədəki sahə vahidlərini istifadə edin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "timezone": "Asia/Baku",
  "point": {
    "lat": 40.3777,
    "lng": 49.8516
  },
  "utc_offset": "+04:00",
  "utc_offset_seconds": 14400,
  "dst": false,
  "abbreviation": "GMT+4",
  "local_time": "2026-01-01T16:00:00",
  "utc_time": "2026-01-01T12:00:00.000Z"
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}

Cavab Strukturunun Şərhi

{ timezone, point, utc_offset, utc_offset_seconds, dst, abbreviation, local_time, utc_time } qaytarır. utc_offset +HH:MM sətiridir, yay vaxtı aktivdirsə dst true olur, local_time isə qurşaq ofseti ilə ISO vaxt möhürüdür.

Elevation API

#

İstənilən koordinat üçün dəniz səviyyəsindən yüksəklik (metr) — bir nöqtə və ya bütöv marşrut profili.

GET
/api/1/elevation

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburilat,lngKoordinat: lat,lng. Hər nöqtə üçün təkrarlayın (GET-də 100-ə qədər).

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Elevation API
curl "https://osrmroute.com/api/1/elevation?point=40.4093,49.8671&point=41.30,48.50" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit / 10 points

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • GET: point count = 1–100
  • POST: points count = 1–1000
  • credits = max(1, ceil(points / 10))
  • elevation: number | null
  • GET with 1 point: elevation alias

Məlumat olmadıqda hündürlük null ola bilər. Çatışmayan hündürlüyü sıfırla əvəz etməyin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "results": [
    {
      "point": {
        "lat": 40.3777,
        "lng": 49.8516
      },
      "elevation": null
    }
  ],
  "unit": "meters"
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide at least one point=lat,lng (repeatable)."
}

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "A maximum of 100 points can be queried per GET request; use POST for larger batches."
}

Cavab Strukturunun Şərhi

{ results[], unit:"meters" } qaytarır; hər nəticə { point:{lat,lng}, elevation }. elevation dəniz səviyyəsindən metrdir (naməlumdursa null, dənizdə 0). Tək nöqtə üçün yuxarı səviyyədə elevation da daxil edilir. Böyük toplular üçün POST { points:[[lat,lng],...] } (1000-ə qədər).

Boundary Lookup API

#

Koordinatın hansı ölkə, əyalət, şəhər və rayona düşdüyünü tapın — istəyə görə sərhəd poliqonu ilə.

GET
/api/1/boundary

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburilat,lngKoordinat: lat,lng.
polygonbooleanKönüllüfalseSərhədi GeoJSON kimi də qaytarmaq üçün true.
langstringKönüllüenYer adları üçün dil kodu.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Boundary Lookup API
curl "https://osrmroute.com/api/1/boundary?point=40.4093,49.8671" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • polygon: true | false
  • HTTP 422: BoundaryCoverageUnavailable

Ətraflı sərhədlər yalnız qəbul edilmiş regional məlumatlarda var. Dəstəklənməyən nöqtələr BoundaryCoverageUnavailable qaytarır.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "point": {
    "lat": 40.3777,
    "lng": 49.8516
  },
  "display_name": "Baku, Azerbaijan",
  "boundary_scope": "city",
  "country": "Azerbaijan",
  "countrycode": "AZ",
  "city": "Baku",
  "boundary": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          49.84,
          40.37
        ],
        [
          49.87,
          40.37
        ],
        [
          49.87,
          40.4
        ],
        [
          49.84,
          40.37
        ]
      ]
    ]
  }
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}

Burada ətraflı inzibati məlumat yoxdur; xidmət əhatəsinə baxın.

HTTP 422
{
  "code": "BoundaryCoverageUnavailable",
  "error": "Detailed administrative boundary data is not available at this coordinate."
}

Cavab Strukturunun Şərhi

{ point, display_name, country, countrycode, state, county, city, district, postcode, osm_id, osm_type } qaytarır və polygon=true olduqda GeoJSON sərhəd həndəsəsi.

Geofencing API

#

Bir sorğuda hər nöqtənin hansı zonalarınıza düşdüyünü yoxlayın — poliqon və ya dairəvi hasarlar.

POST
/api/1/geofence

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
fencesarrayMəcburi[]Hasarlar massivi: { id?, polygon:[[lat,lng],...] } və ya { id?, center:[lat,lng], radius_m }. 100-ə qədər.
pointsarrayMəcburi[]Yoxlanacaq [lat,lng] nöqtələri massivi (1000-ə qədər).

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Geofencing API
curl -X POST "https://osrmroute.com/api/1/geofence" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fences":[{"id":"zone1","polygon":[[40.40,49.85],[40.43,49.85],[40.43,49.90],[40.40,49.90]]}],"points":[[40.41,49.87],[40.50,50.10]]}'

Limitlər və koordinatlar

Kredit sərfi: 1 credit / 100 points

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • fences: 1–100
  • points: 1–1000
  • credits = max(1, ceil(points / 100))

Giriş formatını yoxlayın və nümunədəki sahə vahidlərini istifadə edin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "results": [
    {
      "point": {
        "lat": 40.3777,
        "lng": 49.8516
      },
      "inside": [
        "depot"
      ]
    }
  ],
  "count": 1,
  "took": 1
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Body must include non-empty \"fences\" and \"points\" arrays."
}

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Limits: up to 100 fences and 1000 points per request."
}

Cavab Strukturunun Şərhi

{ results[], count } qaytarır. Hər nəticə { point:{lat,lng}, inside:[fenceId,...] } — nöqtənin düşdüyü bütün hasarları sadalayır (heç biri yoxdursa boş).

Elevation Profile API

#

Yolun hər nöqtəsində yüksəklik + ümumi dırmanma, eniş və məsafə — tam marşrut profili.

POST
/api/1/elevation/profile

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointsarrayKönüllü[]Yolu təşkil edən [lat,lng] nöqtələri massivi (>=2, 2000-ə qədər).
polylinestringKönüllü-points əvəzinə encoded polyline.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Elevation Profile API
curl -X POST "https://osrmroute.com/api/1/elevation/profile" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"points":[[40.37,49.85],[40.80,48.90],[41.30,48.05]]}'

Limitlər və koordinatlar

Kredit sərfi: 1 credit / 10 points

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • points: 2–2000
  • credits = max(1, ceil(points / 10))
  • elevation: number | null

Məlumat olmadıqda hündürlük null ola bilər. Çatışmayan hündürlüyü sıfırla əvəz etməyin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "profile": [
    {
      "point": {
        "lat": 40.3777,
        "lng": 49.8516
      },
      "elevation": null,
      "distance": 0
    },
    {
      "point": {
        "lat": 40.4,
        "lng": 49.86
      },
      "elevation": null,
      "distance": 2590
    }
  ],
  "total_ascent": 0,
  "total_descent": 0,
  "min_elevation": null,
  "max_elevation": null,
  "distance": 2590,
  "unit": "meters",
  "took": 12
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide a \"points\" array (>=2 [lat,lng]) or an encoded \"polyline\"."
}

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "A maximum of 2000 points is allowed per request."
}

Cavab Strukturunun Şərhi

{ profile[], total_ascent, total_descent, min_elevation, max_elevation, distance, unit } qaytarır. Hər element { point, elevation, distance } (metr).

Solar API

#

İstənilən koordinat və tarix üçün gündoğumu, günbatımı, toran, solar noon və gün uzunluğu.

GET
/api/1/solar

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburilat,lngKoordinat: lat,lng.
datestringKönüllütodayVaxtların hesablanacağı tarix (YYYY-MM-DD); defolt bu gün.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Solar API
curl "https://osrmroute.com/api/1/solar?point=40.4093,49.8671&date=2026-07-07" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • date: YYYY-MM-DD; default = today
  • times: UTC ISO 8601 | null

Qütb gündüzü və gecəsində günəş vaxtları null ola bilər. Vaxtlar UTC-dir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "point": {
    "lat": 40.3777,
    "lng": 49.8516
  },
  "date": "2026-01-01",
  "sunrise": "2026-01-01T04:00:00.000Z",
  "sunset": "2026-01-01T13:00:00.000Z",
  "solar_noon": "2026-01-01T08:30:00.000Z",
  "day_length_seconds": 32400
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide a valid coordinate via point=lat,lng or lat= & lon=."
}

Cavab Strukturunun Şərhi

{ point, date, sunrise, sunset, solar_noon, dawn, dusk, golden_hour, night_start, night_end, day_length_seconds } qaytarır. Vaxtlar UTC ISO; qütb gecə/gündüzündə null.

Geometry Utilities API

#

Məsafə, bearing, sahə, mərkəz, sadələşdirmə və polyline encode/decode — məkan riyaziyyatı xidmət kimi.

POST
/api/1/geometry

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
opstringMəcburidistanceƏməliyyat: distance, bearing, destination, midpoint, length, area, centroid, simplify, polyline_encode və ya polyline_decode.
fromarrayKönüllü[lat,lng]Başlanğıc nöqtə [lat,lng].
toarrayKönüllü[lat,lng]Son nöqtə [lat,lng].
patharrayKönüllü[][lat,lng] massivi (length/simplify/polyline_encode üçün).
polygonarrayKönüllü[][lat,lng] halqası (area üçün).
op → JSON
distance, bearing, midpoint → from, to
destination → from, bearing (°), distance_m
length → path (≥ 2)
area → polygon (≥ 3)
centroid → points (≥ 1)
simplify → path (2–2000), tolerance_m (10)
polyline_encode → path (≥ 1), precision (5)
polyline_decode → polyline, precision (5)

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Geometry Utilities API
curl -X POST "https://osrmroute.com/api/1/geometry" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"op":"distance","from":[40.37,49.85],"to":[40.40,49.86]}'

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • op: distance | bearing | destination | midpoint | length | area | centroid | simplify | polyline_encode | polyline_decode

Giriş formatını yoxlayın və nümunədəki sahə vahidlərini istifadə edin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "op": "distance",
  "distance": 2590.25,
  "unit": "meters"
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Invalid geometry input for the requested op."
}

Cavab Strukturunun Şərhi

{ op, ... } qaytarır — seçilmiş əməliyyatın nəticəsi ilə, məs. { distance, unit }, { bearing_deg }, { point }, { area, unit }, { path } və ya { polyline }.

Coordinate Conversion API

#

Enlik/uzunluğu UTM və MGRS grid işarələrinə və əksinə çevir.

GET
/api/1/convert

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringKönüllülat,lngUTM/MGRS-ə çevriləcək koordinat: lat,lng.
mgrsstringKönüllü-Koordinata geri çevriləcək MGRS sətiri.

point=lat,lng, lat və lon cütünü, yaxud mgrs göndərin. Boş olmayan mgrs üstünlük daşıyır. Əks çevirmə MGRS xanasının mərkəzini qaytarır və utm sahəsini daxil etmir.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Coordinate Conversion API
curl "https://osrmroute.com/api/1/convert?point=40.3755,49.8516" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • point=lat,lng OR (lat=... AND lon=...) OR mgrs=...

Giriş formatını yoxlayın və nümunədəki sahə vahidlərini istifadə edin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "point": {
    "lat": 40.3755,
    "lng": 49.8516
  },
  "mgrs": "39TVE0251070068",
  "utm": {
    "zone": 39,
    "band": "T",
    "easting": 402511,
    "northing": 4470068,
    "hemisphere": "N"
  }
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide point=lat,lng (or lat= & lon=), or mgrs= to reverse-convert."
}

Cavab Strukturunun Şərhi

{ point, mgrs, utm:{ zone, band, easting, northing, hemisphere } } qaytarır. mgrs= verildikdə { mgrs, point }.

Country Info API

#

İstənilən ölkə üçün valyuta, telefon kodu, dillər, paytaxt və bayraq — ISO kod və ya ad ilə.

GET
/api/1/country

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
codestringKönüllüAZISO 3166 alpha-2 və ya alpha-3 ölkə kodu (məs. AZ və ya AZE).
namestringKönüllü-Kod əvəzinə ölkə adı.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Country Info API
curl "https://osrmroute.com/api/1/country?code=AZ" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 1 credit

JSON-dakı sahə adlarına baxın; bu sorğu koordinat cütü tələb etmir.

  • code=ISO2/ISO3 OR name=...

Giriş formatını yoxlayın və nümunədəki sahə vahidlərini istifadə edin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "name": "Azerbaijan",
  "official_name": "Republic of Azerbaijan",
  "cca2": "AZ",
  "cca3": "AZE",
  "capital": "Baku",
  "region": "Asia",
  "subregion": "Western Asia",
  "currency": {
    "code": "AZN",
    "name": "Azerbaijani manat",
    "symbol": "₼"
  },
  "calling_code": "+994",
  "languages": [
    "Azerbaijani"
  ],
  "flag": "🇦🇿",
  "latlng": [
    40.5,
    47.5
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide code=ISO2/ISO3 or name=CountryName."
}

Düzgün ölkə kodunu və ya ölkənin dəqiq adını istifadə edin.

HTTP 404
{
  "error": "Country not found."
}

Cavab Strukturunun Şərhi

{ name, official_name, cca2, cca3, capital, region, subregion, currency:{code,name,symbol}, calling_code, languages[], flag, latlng } qaytarır.

Isochrone API

#

Nümunə nöqtələrə yol üzrə səyahət vaxtından çatımlılıq təxmini hesablanır. Hər istiqamətdə çatıla bilən nöqtə varsa quality.status estimated olur; əks halda insufficient_data və boş polygons qaytarılır. Boş nəticə çatıla bilən yolların olmadığını sübut etmir. Sərhəd təxminidir; yalnız vaxt həddi dəstəklənir.

GET
/api/1/isochrone

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
pointstringMəcburi-Mərkəz nöqtə. Format: lat,lon.
time_limitintegerKönüllü600Səyahət vaxt limiti (saniyə ilə).

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Isochrones API
curl "https://osrmroute.com/api/1/isochrone?point=40.4093,49.8671&time_limit=600" -H "Authorization: Bearer YOUR_KEY"

Limitlər və koordinatlar

Kredit sərfi: 2 credits / minute; minimum 10

point=lat,lng; JSON nöqtələri: [lat,lng]. GeoJSON həndəsəsi həmişə [lon,lat] istifadə edir.

  • time_limit: min = 60 s
  • time_limit ≤ plan.maxIsochroneMinutes × 60
  • quality.status = estimated | insufficient_data; polygons = [] when any bearing lacks a reachable sample
  • Sampled OSRM estimate, not an exact reachable-area boundary; an empty polygon does not prove no reachable roads
  • credits = max(10, ceil(time_limit_seconds / 30))

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "quality": {
    "status": "estimated",
    "method": "sampled_osrm",
    "sampled_points": 80,
    "reachable_points": 48,
    "covered_bearings": 16,
    "total_bearings": 16,
    "unknown_points": 0
  },
  "polygons": [
    {
      "type": "Feature",
      "properties": {
        "bucket": 0,
        "time_limit": 600
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              49.84,
              40.37
            ],
            [
              49.87,
              40.37
            ],
            [
              49.87,
              40.4
            ],
            [
              49.84,
              40.37
            ]
          ]
        ]
      }
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "point parameter is required"
}

Planın mürəkkəblik limitlərini və açar məhdudiyyətlərini paneldə yoxlayın.

HTTP 403
{
  "error": "The Isochrone API is not available on your plan. Upgrade your plan to use it."
}

Bu koordinatlarda dəstəklənən hərəkət profilini seçin. Avtomobil profilinə avtomatik keçid yoxdur.

HTTP 422
{
  "code": "ProfileNotAvailable",
  "error": "This travel profile is not available at one or more coordinates. No driving fallback was used."
}

Xidmət və ya məlumat mənbəyi əlçatan deyil. Fasiləni artıraraq ehtiyatla yenidən sınayın.

HTTP 504
{
  "code": "RoutingTimeout",
  "error": "The routing service did not respond within the request deadline. Retry later."
}

Cavab Strukturunun Şərhi

polygons[] — GeoJSON Feature; geometry — Polygon [lon,lat]; properties.time_limit — vaxt həddi (s).

Route Optimization API

#

Tutum, vaxt pəncərəsi, bacarıq və əlaqəli götürmə/çatdırılma şərtləri ilə donanma marşrutlarını planlayır. Məhdud vaxtlı evristik alqoritm səyahət vaxtını azaldır, qlobal optimuma zəmanət vermir. Təyin edilməyən tapşırıqlar solution.unassigned daxilində qalır; etibarsız giriş bütövlükdə rədd edilir.

POST
/api/1/vrp

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
vehiclesarrayKönüllüone default vehicleNəqliyyat vasitələrinin siyahısı — hər biri id, ixtiyari tutum və başlanğıc nöqtəsi ilə; nöqtə [lon, lat] massividir (əvvəl uzunluq).
servicesarrayKönüllü[]Xidmət göstəriləcək dayanacaqlar — hər biri id, [lon, lat] massivi kimi nöqtə (əvvəl uzunluq) və ixtiyari xidmət müddəti ilə.
shipmentsarrayKönüllü[]Əlaqəli götürmə və çatdırılma tapşırıqları; amount və skills ilə. services, shipments və ya hər ikisini verin; ən çox 250 tapşırıq nöqtəsi.
profilestringKönüllüdrivingOrtaq nəqliyyat profili: driving, cycling və ya walking; sənədləşdirilmiş alternativ adlar da qəbul edilir.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Route Optimization API
curl -X POST "https://osrmroute.com/api/1/vrp" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"vehicles":[{"vehicle_id":"v1","start":[49.85,40.37]}],"services":[{"id":10,"location":[49.86,40.40]}]}'

Limitlər və koordinatlar

Kredit sərfi: max(10, ceil(vehicles * task_points * 13 / 15)) credits

VRP start/location massivləri: [lon,lat]; adlı obyektlər: lat və lng/lon. Vaxt saniyə ilədir.

  • vehicles.length ≤ plan.maxVehicles
  • vehicles defaults to one vehicle when omitted
  • services.length + 2 × shipments.length ≤ 250; vehicles.length ≤ 100
  • task_points = services.length + 2 × shipments.length
  • credits = max(10, ceil(vehicles * task_points * 13 / 15)); invalid inputs are refunded
  • Capacity arrays, time_windows, skills and paired shipments are enforced; unsupported options return 400
  • solution.unassigned lists tasks not assigned by the bounded heuristic; this is not proof of infeasibility
  • transport_time is travel only; service_time, waiting_time and elapsed time are separate; costs is travel seconds

Avtomobil, piyada və velosiped marşrutları qlobaldır. Nöqtələr uyğun hərəkətə icazə verən yollarla birləşməlidir. VRP evristikdir, izoxronlar təxminidir; qlobal optimum və canlı trafik vəd edilmir.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "status": "finished",
  "job_id": "opt-1234567890",
  "processing_time": 0,
  "solution": {
    "unassigned": [],
    "quality": {
      "solver": "vroom",
      "version": "1.15.0",
      "constraints_verified": true,
      "optimality_proven": false
    },
    "costs": 420,
    "distance": 3200,
    "time": 420,
    "no_vehicles": 1,
    "no_unassigned": 0,
    "routes": [
      {
        "vehicle_id": "v1",
        "distance": 3200,
        "transport_time": 420,
        "activities": [
          {
            "type": "start",
            "location_id": "depot",
            "end_time": 0
          },
          {
            "type": "service",
            "id": 10,
            "location_id": "stop_1",
            "arr_time": 200,
            "end_time": 200
          },
          {
            "type": "end",
            "location_id": "depot",
            "arr_time": 420
          }
        ]
      }
    ]
  }
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "code": "InvalidOptimizationInput",
  "error": "At least one service with valid coordinates is required."
}

Planın mürəkkəblik limitlərini və açar məhdudiyyətlərini paneldə yoxlayın.

HTTP 403
{
  "error": "Your plan allows up to 1 vehicles per request. Upgrade your plan for more."
}

Nöqtələrin girişə açıq yollara yaxın olduğunu və seçilmiş profil üçün bu yolların bir-birinə bağlı olduğunu yoxlayın.

HTTP 422
{
  "code": "NoNearbyRoad",
  "error": "No connected route within 2000 metres of the requested coordinates."
}

Cavab Strukturunun Şərhi

status → finished; job_id — sorğu ID-si; solution: distance — məsafə (m), time və costs — vaxt (s), no_vehicles, no_unassigned — saylar, routes[] — marşrutlar. routes[]: vehicle_id, distance (m), transport_time (s), activities[] — fəaliyyətlər.

Location Clustering API

#

Verilmiş koordinatları coğrafi yaxınlıqlarına və sıxlıqlarına görə qruplaşdırır (klasterlərə ayırır).

POST
/api/1/cluster

Parametrlər (Query Params)

ParametrTipStatusDefaultTəsvir
customersarrayMəcburi[]Klasterləşdiriləcək müştəri koordinatları və çəkiləri.

Sorğu nümunəsi

YOUR_KEY yerinə öz API açarınızı yazın. API sorğuları kredit sərf edir; nümunəni köçürmək sorğu göndərmir.

Location Clustering
curl -X POST "https://osrmroute.com/api/1/cluster" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customers":[[49.85,40.37],[49.86,40.40],[49.83,40.39]],"clusters":2}'

Limitlər və koordinatlar

Kredit sərfi: 3 credits

Müştəri nöqtələrinin girişi: [lon,lat]; qrup mərkəzinin çıxışı: [lat,lon].

  • customers: valid coordinates ≥ 1
  • 1 ≤ clusters ≤ valid_customers.length

Giriş formatını yoxlayın və nümunədəki sahə vahidlərini istifadə edin.

Cari planlar və qiymətlərXidmətlər üzrə əhatə

JSON cavab nümunəsi

Qısaldılmış, izahlı JSON nümunəsidir. Dəyərlər, əlavə sahələr və xəritə məlumatları dəyişə bilər. Başqa vahid göstərilməyibsə, məsafə metr, marşrut müddəti saniyə ilə verilir.

HTTP 200 · application/json
{
  "status": "finished",
  "job_id": "cluster-1234567890",
  "processing_time": 0,
  "no_clusters": 1,
  "clusters": [
    {
      "ids": [
        "s1",
        "s2"
      ],
      "center": [
        40.385,
        49.855
      ],
      "size": 2
    }
  ]
}
Xidmətə aid xətalar

Yenidən göndərməzdən əvvəl əskik və ya yanlış parametrləri düzəldin.

HTTP 400
{
  "error": "Provide a \"customers\" array with valid coordinates."
}

Cavab Strukturunun Şərhi

status → finished; job_id — sorğu ID-si; no_clusters — klaster sayı; clusters[]: ids[] — elementlər, center [lat,lon] — mərkəz, size — ölçü.

Əvvəlki inteqrasiyalar üçün endpoint-lər

Mövcud inteqrasiyanı əsas API-yə keçirərkən koordinat sırasını və cavabdakı ölçü vahidlərini yoxlayın.

Qısa Routing ünvanı əsas OSRM marşrutu ilə eyni giriş və cavabdan istifadə edir. Köhnə Route sorğusunda enlik,uzunluq cütlərini point ilə təkrarlayın. paths[].time millisaniyə, paths[].distance metrdir. Route info qurulmuş əhatəni göstərir və bir kredit sərf edir.

HTTP
GET /api/v1/route/driving/49.8516,40.3755;49.8378,40.3892
GET /api/1/route?point=40.3755,49.8516&point=40.3892,49.8378
GET /api/1/route/info

Köhnə Matrix GET sorğusunda point və ya ayrı from_point və to_point siyahılarından istifadə edin. JSON sorğusunda from_points və to_points üçün enlik,uzunluq cütləri göndərin. times millisaniyə, distances metrdir.

HTTP
GET /api/1/matrix?point=40.3755,49.8516&point=40.3892,49.8378
POST /api/1/matrix · POST /api/1/matrix/calculate
{"from_points":[[40.3755,49.8516]],"to_points":[[40.3892,49.8378]]}

Köhnə Match ardıcıl GPS izini [lon, lat] cütləri ilə qəbul edir. Hər nöqtə üçün istəyə görə saniyə ilə vaxt və metrlə radius göndərin. Cavabda uyğunlaşma məsafəsi metr, müddəti millisaniyədir. Toplu Elevation ən çox 1 000 [lat, lon] cütü qəbul edir və hündürlüyü metr və ya null kimi qaytarır.

POST /api/1/match
{"points":[[49.8516,40.3755],[49.8378,40.3892]],"timestamps":[1760000000,1760000120],"radiuses":[20,20]}
POST /api/1/elevation
{"points":[[40.3755,49.8516],[40.3892,49.8378]]}

optimize və vrp/optimize eyni VRP sorğu formatını qəbul edir. Klaster və toplu geokodlaşdırma alternativ ünvanları da əsas sorğuların formatından istifadə edir. VRP və klaster nəticəni birbaşa cavabda qaytarır.

Xəritə Playground

Rəsmi SDK-lar

Android/JVM üçün Kotlin, iOS üçün Swift. Tipli modellər və asinxron sorğularla OSRMRoute coğrafi API-lərinə qoşulun.

JavaScript / TypeScriptPythonKotlin / AndroidSwift / iOSSDK-lara bax

OSRMRoute Dəstək

Komandamıza birbaşa yazın

KÖMƏK ÜÇÜN BURADAYIQ

Sizə necə kömək edək?

Mesaj göndərin. Ticket cavabları təsdiqlənmiş emailinizə də göndərilir.

Sizin çatlarınız

Çatlarınız burada görünəcək.