CINXE.COM

<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-navigation/map-matching" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.3.0"> <title data-rh="true">Map Matching API | API Docs | Mapbox</title><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="ja"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" charset="utf-8"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="msapplication-TileColor" content="#ffffff"><meta data-rh="true" name="msapplication-config" content="https://static-assets.mapbox.com/branding/favicon/v2/browserconfig.xml?v=gAd4JjrGWl"><meta data-rh="true" name="theme-color" content="#ffffff"><meta data-rh="true" name="p:domain_verify" content="57838af58c8045c2c024bc2f9d1577f9"><meta data-rh="true" name="google-site-verification" content="umPiCFUc_EX8CJ7xWQDPgQwApDxNi59w6riFZPNZj4w"><meta data-rh="true" name="twitter:site" content="@Mapbox"><meta data-rh="true" property="og:site_name" content="Mapbox"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="description" content="The Mapbox Map Matching API snaps fuzzy, inaccurate traces to the OpenStreetMap road and path network."><meta data-rh="true" name="twitter:title" content="Map Matching API | API Docs"><meta data-rh="true" property="og:title" content="Map Matching API | API Docs"><meta data-rh="true" name="twitter:description" content="The Mapbox Map Matching API snaps fuzzy, inaccurate traces to the OpenStreetMap road and path network."><meta data-rh="true" property="og:description" content="The Mapbox Map Matching API snaps fuzzy, inaccurate traces to the OpenStreetMap road and path network."><meta data-rh="true" property="og:url" content="https://docs.mapbox.com//api/navigation/map-matching"><meta data-rh="true" property="og:type" content="website"><meta data-rh="true" class="swiftype" name="title" data-type="string" content="Map Matching API"><meta data-rh="true" class="swiftype" name="excerpt" data-type="string" content="The Mapbox Map Matching API snaps fuzzy, inaccurate traces to the OpenStreetMap road and path network."><meta data-rh="true" name="twitter:image:alt" content="Mapbox"><meta data-rh="true" property="og:image" content="https://static-assets.mapbox.com/branding/social/social-1200x630.v4.png"><meta data-rh="true" class="swiftype" name="image" data-type="enum" content="https://static-assets.mapbox.com/branding/social/social-120x120.v2.png"><meta data-rh="true" class="swiftype" name="site" data-type="string" content="API Docs"><meta data-rh="true" class="swiftype" name="contentType" data-type="string" content="API"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" name="twitter:image" content="https://static-assets.mapbox.com/branding/social/social-1200x630.v4.png"><link data-rh="true" rel="canonical" href="https://docs.mapbox.com/api/navigation/map-matching/"><link data-rh="true" rel="alternate" href="https://docs.mapbox.com/api/navigation/map-matching/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.mapbox.com/api/ja/navigation/map-matching/" hreflang="ja"><link data-rh="true" rel="alternate" href="https://docs.mapbox.com/api/navigation/map-matching/" hreflang="x-default"><link data-rh="true" rel="apple-touch-icon" sizes="180x180" href="https://static-assets.mapbox.com/branding/favicon/v2/apple-touch-icon.png?v=gAd4JjrGWl"><link data-rh="true" rel="icon" type="image/png" sizes="32x32" href="https://static-assets.mapbox.com/branding/favicon/v2/favicon-32x32.png?v=gAd4JjrGWl"><link data-rh="true" rel="icon" type="image/png" sizes="16x16" href="https://static-assets.mapbox.com/branding/favicon/v2/favicon-16x16.png?v=gAd4JjrGWl"><link data-rh="true" rel="manifest" href="https://static-assets.mapbox.com/branding/favicon/v2/site.webmanifest?v=gAd4JjrGWl"><link data-rh="true" rel="mask-icon" href="https://static-assets.mapbox.com/branding/favicon/v2/safari-pinned-tab.svg?v=gAd4JjrGWl" color="#4264fb"><link data-rh="true" rel="shortcut icon" href="https://static-assets.mapbox.com/branding/favicon/v2/favicon.ico?v=gAd4JjrGWl"><link data-rh="true" rel="preconnect" href="https://Z7QUXRWJ7L-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="b96d25fb-28f1-4bea-a2d6-70a31920b822" data-project-name="Mapbox" data-project-color="#000000" data-project-logo="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzMiAzMiIgd2lkdGg9IjY0IiBoZWlnaHQ9IjY0IiBmaWxsPSIjRkZGIj48cGF0aCBkPSJNMTYgMEM3LjE2MyAwIDAgNy4xNjMgMCAxNnM3LjE2MyAxNiAxNiAxNiAxNi03LjE2MyAxNi0xNlMyNC44MzcgMCAxNiAwem03LjU5NSAxOS45MjRDMTguMTI0IDI1LjM5NSA4LjM1IDIzLjY1IDguMzUgMjMuNjVzLTEuNzY0LTkuNzU1IDMuNzI2LTE1LjI0NGMzLjA0Mi0zLjA0MiA4LjA4LTIuOTE2IDExLjI2Ny4yNTJzMy4yOTQgOC4yMjUuMjUyIDExLjI2N3ptLTUuNzYtLjk3MmwxLjU2Ni0zLjIyMiAzLjIyMi0xLjU2Ni0zLjIyMi0xLjU2Ni0xLjU2Ni0zLjIyMi0xLjU2NiAzLjIyMi0zLjIyMiAxLjU2NiAzLjIyMiAxLjU2NnoiLz48L3N2Zz4=" data-modal-override-open-class="chakra-input" data-search-mode-enabled="false" data-modal-disclaimer="This is a custom LLM for Mapbox with access to all developer docs (docs.mapbox.com) and all Stackoverflow questions (stackoverflow.com/questions/tagged/mapbox). Please note that answers are generated by AI and may not be fully accurate, so please use your best judgement." data-user-analytics-fingerprint-enabled="true"></script><link rel="stylesheet" href="/api/assets/css/styles.1a9e7e80.css"> <script src="/api/assets/js/runtime~main.d86d3794.js" defer="defer"></script> <script src="/api/assets/js/main.41471caf.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div id="page-shell"><div class="flex flex--column" style="min-height:100vh"><div class="flex-child-grow flex-child-no-shrink"><div role="region" aria-label="Skip to main content"><a class="skipToContent_ZU_v" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar sticky top z3 shell-wrapper"><header class="inline-block w-full z1 bg-gray-faint border--gray-lighter border-b" data-swiftype-index="false" style="height:69px"><div id="page-header-content" class="wmax1800 w-full w-11/12-mm mx-auto px24 flex px24 px0-mm py12 z2 relative h-full flex--center-cross flex--space-between-main"><div class="flex flex--center-cross"><a href="https://www.mapbox.com" target="_blank" rel="noopener noreferrer" aria-label="Mapbox" class="mb-logo"></a><div class="h24 mx12 bg-black" style="width:1px" data-subtitle-bar-dark="true"></div><a href="https://docs.mapbox.com" target="_blank" rel="noopener noreferrer" class="txt-bold txt-l color-black color-blue-dark-on-hover" style="margin-bottom:2px" data-subtitle-dark="true">Docs</a></div><div class="flex-child-grow flex flex--center-cross flex--center-main"><div class="flex flex--center-cross flex--end-main"><div class="mx6 mx18-mxl" style="line-height:1"><a href="https://docs.mapbox.com/#maps" target="_blank" rel="noopener noreferrer" class="py6 txt-s txt-bold navigation-menu-button color-gray-dark color-blue-on-hover">Maps</a></div><div class="mx6 mx18-mxl" style="line-height:1"><a href="https://docs.mapbox.com/#navigation" target="_blank" rel="noopener noreferrer" class="py6 txt-s txt-bold navigation-menu-button color-gray-dark color-blue-on-hover">Navigation</a></div><div class="mx6 mx18-mxl" style="line-height:1"><a href="https://docs.mapbox.com/#search" target="_blank" rel="noopener noreferrer" class="py6 txt-s txt-bold navigation-menu-button color-gray-dark color-blue-on-hover">Search</a></div><div class="mx6 mx18-mxl" style="line-height:1"><a href="https://docs.mapbox.com/#data" target="_blank" rel="noopener noreferrer" class="py6 txt-s txt-bold navigation-menu-button color-gray-dark color-blue-on-hover">Data</a></div><div class="mx6 mx18-mxl" style="line-height:1"><a href="https://docs.mapbox.com/help/" target="_blank" rel="noopener noreferrer" class="py6 txt-s txt-bold navigation-menu-button color-gray-dark color-blue-on-hover">Help</a></div></div></div><div class="flex-child-no-shrink flex flex--center-cross"><div class="mx12"><button type="button" class="flex flex--center-cross border--gray-lighter border--gray-on-hover border--blue-on-active py12 round-bold color-gray h36 txt-s border bg-white pl12 pr12" aria-label="Search..." style="width:180px"><svg style="left:-2px" class="icon color-gray relative w18 h18 mr3"><title>Search</title><use xlink:href="#icon-search"></use></svg><span class="flex-child-grow">Search...</span><span class="flex-child-no-shrink color-gray txt-bold"></span></button></div><div class="mx12"><div class="relative" role="menuitem" tabindex="0"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link flex flex--center-cross my3 txt-s txt-bold color-blue-on-hover transition" position="right"><div class="flex flex--center-cross"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" style="vertical-align:text-bottom;margin-right:5px"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English<svg class="events-none icon" data-testid="icon-caret-down" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-caret-down"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">caret-down</span></div></a><ul style="min-width:140px;visibility:hidden" class="transition bg-white shadow-darken25-bold py18 px12 round absolute opacity0 mt-neg3"><div class="flex flex--center-main"><div class="triangle-l--u triangle color-white inline-block absolute top mt-neg12"></div></div><li class="align-l"><a href="/api/navigation/map-matching/" target="_self" rel="noopener noreferrer" class="inline-block transition py6 px12 mt6 round bg-gray-faint-on-hover w-full txt-s txt-bold bg-gray-faint color-blue" lang="en"><div class="flex flex--center-cross">English</div></a></li><li class="align-l"><a href="/api/ja/navigation/map-matching/" target="_self" rel="noopener noreferrer" class="inline-block transition py6 px12 mt6 round bg-gray-faint-on-hover w-full txt-s txt-bold" lang="ja"><div class="flex flex--center-cross">日本語<span class="ml6"><div style="padding-top:1px;letter-spacing:0.07em" class="txt-fancy-medium round inline-block cursor-default color-gray-dark bg-blue-lighter color-blue-dark txt-s px6">BETA</div></span></div></a></li></ul></div></div><div class="ml12"><div id="mbx-user-menu" class="flex-child-no-shrink" style="min-width:66px;max-width:120px" data-user-menu-trigger="true"></div></div></div></div><div class="z1 absolute top left right w-full"><div id="mobile-nav-backdrop" data-test="mobile-nav-backdrop" class="absolute bottom left right shell-mobile-nav__backdrop" style="top:72px;background-image:linear-gradient(to bottom, transparent, rgba(31, 51, 73, .5))"></div><div id="mobile-nav-menu" data-test="mobile-nav-menu" class="absolute z5 w-full shell-animated-menu" style="top:0;right:0"><div class="shadow-darken10-bold bg-white overflow-hidden px24" style="padding-top:72px"><div class="pb24"><a href="https://docs.mapbox.com/#maps" target="_blank" rel="noopener noreferrer" class="block py6">Maps</a><a href="https://docs.mapbox.com/#navigation" target="_blank" rel="noopener noreferrer" class="block py6">Navigation</a><a href="https://docs.mapbox.com/#search" target="_blank" rel="noopener noreferrer" class="block py6">Search</a><a href="https://docs.mapbox.com/#data" target="_blank" rel="noopener noreferrer" class="block py6">Data</a><a href="https://docs.mapbox.com/help/" target="_blank" rel="noopener noreferrer" class="block py6">Help</a></div><li style="list-style:none;margin-bottom:12px"><a role="button" class="flex flex--center-cross my3 txt-s txt-bold color-blue-on-hover transition" position="right"><div class="flex flex--center-cross"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" style="vertical-align:text-bottom;margin-right:5px"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>Languages<svg class="events-none icon" data-testid="icon-caret-right" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-caret-right"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">caret-right</span></div></a></li><div class="border-t border--gray-light py24"><a href="https://docs.mapbox.com" target="_blank" rel="noopener noreferrer" class="color-blue">All docs</a></div></div></div></div></header></nav><div id="__docusaurus_skipToContent_fallback" class="flex-child-grow relative z0 block main-wrapper mainWrapper_tfBg"><div class="wmax-full w-11/12-mm w-11/12-ml mx-auto px24 px0-mm mt24 mt18-mm mb18"><div class="fixed block none-mm mx24 my24 z5 bottom right"><div class="mx24 my24 z5"><button aria-label="Scroll back to top" class="btn btn--blue w60 h60 round-full shadow-darken25 flex flex--center-main flex--center-cross" type="button" data-state="closed"><svg class="events-none icon" data-testid="icon-arrow-up" style="width:30px;height:30px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-arrow-up"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">arrow-up</span></button></div></div><div class="flex-mm"><aside class="flex-child-no-shrink w-full w180-mm w240-ml mr36-mm"><div data-swiftype-index="false" id="dr-ui--page-layout-sidebar" class="sticky-mm overflow-auto-mm scroll-styled px12-mm pb18-mm mb0-mm" style="top:88px"><div class="mb18"><div class="dr-ui--product-menu"><a class="txt-fancy txt-l block color-blue-on-hover color-text" href="/api/">API Docs</a></div></div><div class="color-text"><nav class="mx-neg12"><ul><li><div class="px12 flex txt-uppercase txt-fancy round-full w-full"><a class="flex-child-grow color-blue-on-hover py6 py3-mm txt-spacing05" href="/api/overview/">Overview</a></div></li><li><div class="px12 flex txt-uppercase txt-fancy round-full w-full flex flex--space-between-main"><a class="flex-child-grow color-blue-on-hover py6 py3-mm txt-spacing05" href="/api/maps/">Maps</a><button class="flex-child-no-shrink color-blue-on-hover px12 px0-mm" aria-label="Toggle Maps menu" aria-controls="menu-undefined" aria-expanded="false" value="Maps"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-down" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-down"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-down</span></button></div></li><li><div class="px12 flex txt-uppercase txt-fancy round-full w-full bg-blue-faint color-blue-deep flex flex--space-between-main"><a class="flex-child-grow color-blue-on-hover py6 py3-mm txt-spacing05" href="/api/navigation/">Navigation</a><button class="flex-child-no-shrink color-blue-on-hover px12 px0-mm" aria-label="Toggle Navigation menu" aria-controls="menu-undefined" aria-expanded="true" value="Navigation"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-down" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-down"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-down</span></button></div></li><li><div class="px12 flex txt-uppercase txt-fancy round-full w-full flex flex--space-between-main"><a class="flex-child-grow color-blue-on-hover py6 py3-mm txt-spacing05" href="/api/search/">Search</a><button class="flex-child-no-shrink color-blue-on-hover px12 px0-mm" aria-label="Toggle Search menu" aria-controls="menu-undefined" aria-expanded="false" value="Search"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-down" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-down"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-down</span></button></div></li><li><div class="px12 flex txt-uppercase txt-fancy round-full w-full flex flex--space-between-main"><a class="flex-child-grow color-blue-on-hover py6 py3-mm txt-spacing05" href="/api/accounts/">Accounts</a><button class="flex-child-no-shrink color-blue-on-hover px12 px0-mm" aria-label="Toggle Accounts menu" aria-controls="menu-undefined" aria-expanded="false" value="Accounts"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-down" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-down"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-down</span></button></div></li><li><div class="px12 flex txt-uppercase txt-fancy round-full w-full"><a href="https://docs.mapbox.com/playground/?topic=APIs" target="_blank" rel="noopener noreferrer" class="flex-child-grow color-blue-on-hover py6 py3-mm txt-spacing05">Playgrounds<span class="ml3 color-gray"><svg class="events-none icon inline-block align-t" data-testid="icon-share" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-share"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">share</span></span></a></div></li></ul></nav></div></div></aside><main class="flex-child-grow w-full"><nav class="dr-ui--breadcrumb pt3 pb12 none block-mm" data-swiftype-index="false" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="inline-block"><span itemprop="name"><a href="https://docs.mapbox.com" target="_blank" rel="noopener noreferrer" class="link">All docs</a></span><span class="color-gray-light inline-block-mm none px6"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-right" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-right"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-right</span></span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="inline-block"><span itemprop="name"><a class="link" href="/api/">API Docs</a></span><span class="color-gray-light inline-block-mm none px6"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-right" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-right"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-right</span></span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="inline-block"><span itemprop="name"><a class="link" href="/api/navigation/">Navigation</a></span><span class="color-gray-light inline-block-mm none px6"><svg class="events-none icon inline-block align-t" data-testid="icon-chevron-right" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-chevron-right"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">chevron-right</span></span><meta itemprop="position" content="3"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="inline-block"><span class="color-gray none inline-block-mm" itemprop="name">Map Matching API</span><meta itemprop="position" content="4"></li></ul></nav><article><div id="docs-content" class="theme-doc-markdown markdown"><header class="col col--auto prose w-2/3-mxl w-full mt18 mt0-mm"><h1 class="txt-fancy">Map Matching API</h1></header><div class="grid grid--gut60"><div class="dr-ui--page-layout-aside col w-full w-1/3-mxl"><div class="overflow-scroll scroll-styled sticky color-text pb0 pb18 none block-mxl" style="top:88px;height:calc(100vh - 88px)"><nav class="dr-ui--on-this-page mb24-mxl mb18 color-text"><h2 id="on-this-page" class="unprose txt-m txt-bold mb6">On this page</h2><ul><li class="mb3 mb6-mxl txt-s"><a href="#retrieve-a-match" class="link inline-block link--gray">Retrieve a match</a><ul class="block pl12 my6"><li class="mb3 mb6-mxl txt-s"><a href="#example-request-retrieve-a-match" class="link inline-block link--gray">Example request: Retrieve a match</a></li><li class="mb3 mb6-mxl txt-s"><a href="#supported-libraries-retrieve-a-match" class="link inline-block link--gray">Supported libraries: Retrieve a match</a></li><li class="mb3 mb6-mxl txt-s"><a href="#response-retrieve-a-match" class="link inline-block link--gray">Response: Retrieve a match</a></li></ul></li><li class="mb3 mb6-mxl txt-s"><a href="#use-http-post-to-retrieve-a-match" class="link inline-block link--gray">Use HTTP POST to retrieve a match</a></li><li class="mb3 mb6-mxl txt-s"><a href="#match-object" class="link inline-block link--gray">Match object</a><ul class="block pl12 my6"><li class="mb3 mb6-mxl txt-s"><a href="#example-match-object" class="link inline-block link--gray">Example match object</a></li></ul></li><li class="mb3 mb6-mxl txt-s"><a href="#tracepoint-object" class="link inline-block link--gray">Tracepoint object</a><ul class="block pl12 my6"><li class="mb3 mb6-mxl txt-s"><a href="#example-tracepoint-object" class="link inline-block link--gray">Example tracepoint object</a></li></ul></li><li class="mb3 mb6-mxl txt-s"><a href="#map-matching-api-errors" class="link inline-block link--gray">Map Matching API errors</a></li><li class="mb3 mb6-mxl txt-s"><a href="#map-matching-api-restrictions-and-limits" class="link inline-block link--gray">Map Matching API restrictions and limits</a></li><li class="mb3 mb6-mxl txt-s"><a href="#map-matching-api-pricing" class="link inline-block link--gray">Map Matching API pricing</a></li></ul></nav><div class="mb18"><div class="dr-ui--signup-banner py18 px18 mb12 round-bold flex bg-gray-faint color-text mb18"><div class="w-full prose flex flex--wrap" style="row-gap:10px"><div class="flex-child-grow mr12"><div class="txt-bold mb6">Ready to get started?</div><div class="txt-ms mb18-mxl">Create a free account to start building with Mapbox.</div></div><div class="flex flex--center-cross flex-child-no-shrink"><a href="https://account.mapbox.com/auth/signup" target="_blank" rel="noopener noreferrer" class="btn btn--blue round-full unprose">Sign Up</a></div></div></div></div><div class="my18 color-text mb18"><div class="py18 px18 round-bold flex bg-gray-faint color-text"><div class="w-full prose flex flex--wrap" style="row-gap:10px"><div class="flex-child-grow mr12"><div class="txt-bold mb12">Additional Developer Resources</div><div class="mb4"><div data-state="closed"><a href="https://discord.gg/uMpcC5RmJh" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M18.2477 6.16644C17.0825 5.62152 15.8367 5.2255 14.5342 5C14.3742 5.28908 14.1873 5.67791 14.0585 5.98721C12.6739 5.77908 11.302 5.77908 9.94287 5.98721C9.81404 5.67791 9.62292 5.28908 9.46152 5C8.15761 5.2255 6.91032 5.62298 5.74514 6.16933C3.39498 9.7192 2.75789 13.1809 3.07644 16.5934C4.63519 17.757 6.14581 18.4638 7.63093 18.9263C7.99762 18.4218 8.32465 17.8856 8.60638 17.3205C8.06981 17.1167 7.5559 16.8652 7.07031 16.5732C7.19913 16.4778 7.32514 16.3781 7.44689 16.2754C10.4086 17.6601 13.6267 17.6601 16.5531 16.2754C16.6762 16.3781 16.8022 16.4778 16.9296 16.5732C16.4426 16.8666 15.9273 17.1181 15.3907 17.3219C15.6724 17.8856 15.9981 18.4233 16.3662 18.9277C17.8527 18.4652 19.3647 17.7584 20.9235 16.5934C21.2973 12.6374 20.285 9.20752 18.2477 6.16644ZM9.00988 14.4947C8.12079 14.4947 7.39166 13.6651 7.39166 12.6548C7.39166 11.6444 8.10522 10.8134 9.00988 10.8134C9.91457 10.8134 10.6437 11.643 10.6281 12.6548C10.6295 13.6651 9.91457 14.4947 9.00988 14.4947ZM14.9901 14.4947C14.101 14.4947 13.3718 13.6651 13.3718 12.6548C13.3718 11.6444 14.0854 10.8134 14.9901 10.8134C15.8947 10.8134 16.6238 11.643 16.6083 12.6548C16.6083 13.6651 15.8947 14.4947 14.9901 14.4947Z" fill="currentColor"></path></svg></div>Mapbox Developer Discord</a></div></div><div class="mb4"><div data-state="closed"><a href="https://labs.mapbox.com/developer-cheatsheet/" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M12.648 3C13.1022 3 13.4932 3.32847 13.5823 3.78479L14.0188 6.02089C14.0517 6.18936 14.1691 6.32636 14.3245 6.39088C14.5565 6.48721 14.7815 6.59752 14.9985 6.7208C15.1453 6.80418 15.3233 6.81157 15.4719 6.73166L17.4432 5.67169C17.8454 5.45545 18.3406 5.56011 18.6264 5.92176L19.4422 6.95387C19.728 7.31552 19.7249 7.8336 19.4349 8.1917L18.0135 9.94646C17.9064 10.0787 17.8765 10.2584 17.9253 10.4228C18.0025 10.6823 18.0638 10.9488 18.1082 11.2213C18.1359 11.3909 18.241 11.5383 18.3946 11.6078L20.4317 12.5288C20.8473 12.7167 21.0756 13.1789 20.9773 13.6332L20.6968 14.9298C20.5985 15.3842 20.2008 15.7042 19.7468 15.6946L17.5202 15.6472C17.3528 15.6436 17.1969 15.7313 17.1018 15.8725C16.95 16.0981 16.7844 16.313 16.6061 16.5161C16.494 16.6439 16.447 16.8198 16.4896 16.9859L17.0545 19.1939C17.1697 19.644 16.9587 20.1149 16.5505 20.3189L15.3855 20.9011C14.9773 21.1051 14.4853 20.9855 14.21 20.6154L12.8599 18.8002C12.7584 18.6637 12.5946 18.5933 12.4275 18.6048C12.1441 18.6244 11.856 18.6244 11.5726 18.6049C11.4055 18.5933 11.2417 18.6637 11.1402 18.8002L9.79008 20.6154C9.51479 20.9855 9.02279 21.1051 8.61458 20.9011L7.44958 20.3189C7.04136 20.1149 6.83043 19.6441 6.94561 19.1939L7.51049 16.9862C7.55301 16.82 7.50608 16.6441 7.39395 16.5164C7.21559 16.3132 7.04985 16.0982 6.89799 15.8726C6.80289 15.7313 6.64705 15.6436 6.47958 15.6472L4.25323 15.6946C3.79915 15.7042 3.40153 15.3842 3.30323 14.9298L3.02269 13.6332C2.92438 13.1789 3.15273 12.7167 3.56825 12.5288L5.60518 11.6079C5.75877 11.5384 5.86394 11.391 5.8916 11.2214C5.936 10.9489 5.99736 10.6823 6.07451 10.4228C6.12337 10.2584 6.09337 10.0787 5.98629 9.94647L4.56494 8.19171C4.27489 7.83361 4.27184 7.31553 4.55767 6.95388L5.37338 5.92177C5.65921 5.56012 6.15443 5.45546 6.5566 5.67171L8.52788 6.73167C8.67649 6.81158 8.85449 6.80419 9.00127 6.72081C9.21829 6.59752 9.4433 6.48721 9.67531 6.39088C9.83071 6.32636 9.94816 6.18936 9.98105 6.02089L10.4175 3.78479C10.5066 3.32847 10.8976 3 11.3518 3H12.648ZM11.9999 14.7149C13.3155 14.7149 14.3819 13.6222 14.3819 12.2743C14.3819 10.9264 13.3155 9.83369 11.9999 9.83369C10.6844 9.83369 9.61794 10.9264 9.61794 12.2743C9.61794 13.6222 10.6844 14.7149 11.9999 14.7149Z" fill="currentColor"></path></svg></div>Developer Cheatsheet</a></div></div><div class="mb4"><div data-state="closed"><a href="https://support.mapbox.com/hc/en-us" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M8.32686 20C8.63025 20 8.85418 19.8582 9.21535 19.5392L11.8808 17.1786L16.605 17.1857C18.7792 17.1857 20 15.9523 20 13.8469V8.33885C20 6.23346 18.7792 5 16.605 5H7.39503C5.22799 5 4 6.23346 4 8.33885V13.8469C4 15.9594 5.26411 17.1786 7.34447 17.1786H7.63341V19.2344C7.63341 19.7023 7.88623 20 8.32686 20ZM8.37743 12.1881C7.75621 12.1881 7.25056 11.699 7.25056 11.0893C7.25056 10.4797 7.75621 9.98346 8.37743 9.98346C8.99865 9.98346 9.50429 10.4797 9.50429 11.0893C9.50429 11.699 8.99865 12.1881 8.37743 12.1881ZM12.0108 12.1881C11.3824 12.1881 10.884 11.699 10.884 11.0893C10.884 10.4797 11.3824 9.98346 12.0108 9.98346C12.6321 9.98346 13.1305 10.4797 13.1305 11.0893C13.1305 11.699 12.6321 12.1881 12.0108 12.1881ZM15.637 12.1881C15.0158 12.1881 14.5102 11.699 14.5102 11.0893C14.5102 10.4797 15.0158 9.98346 15.637 9.98346C16.2582 9.98346 16.7639 10.4797 16.7639 11.0893C16.7639 11.699 16.2582 12.1881 15.637 12.1881Z" fill="currentColor"></path></svg></div>Mapbox Support</a></div></div><div class="mb4"><div data-state="closed"><a href="https://docs.mapbox.com/ask-ai/" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.43222 4.32368C9.83276 4.32368 10.1646 4.61909 10.1996 4.99997C10.5087 8.35823 11.1285 10.46 12 10.46C12.8715 10.46 13.4913 8.35823 13.8004 4.99997C13.8354 4.61909 14.1672 4.32368 14.5678 4.32368C14.9713 4.32368 15.3041 4.62265 15.3445 5.00592C15.6269 7.68302 16.5649 11.1419 17.7143 11.1419C18.2142 11.1419 18.8695 10.2514 19.1581 8.74736C19.1945 8.55736 19.3648 8.41459 19.5672 8.41459C19.7655 8.41459 19.9346 8.55209 19.9688 8.73858C20.2891 10.4859 20.6178 11.4068 21.823 11.6267C21.9232 11.645 22 11.7263 22 11.8237C22 11.9211 21.9232 12.0024 21.823 12.0207C20.6178 12.2406 20.2891 13.1615 19.9688 14.9088C19.9346 15.0953 19.7655 15.2328 19.5672 15.2328C19.3648 15.2328 19.1945 15.09 19.1581 14.9C18.8695 13.396 18.2142 12.5055 17.7143 12.5055C16.5649 12.5055 15.6269 15.9643 15.3445 18.6414C15.3041 19.0247 14.9713 19.3237 14.5678 19.3237C14.1672 19.3237 13.8354 19.0283 13.8004 18.6474C13.4913 15.2891 12.8715 13.1873 12 13.1873C11.1285 13.1873 10.5087 15.2891 10.1996 18.6474C10.1646 19.0283 9.83276 19.3237 9.43222 19.3237C9.02867 19.3237 8.69592 19.0247 8.6555 18.6414C8.37311 15.9643 7.4351 12.5055 6.28571 12.5055C5.78583 12.5055 5.13046 13.396 4.84192 14.9C4.80546 15.09 4.63516 15.2328 4.43281 15.2328C4.23446 15.2328 4.06542 15.0953 4.03123 14.9088C3.71085 13.1615 3.38216 12.2406 2.17699 12.0207C2.07679 12.0024 2 11.9211 2 11.8237C2 11.7263 2.07679 11.645 2.17699 11.6267C3.38216 11.4068 3.71085 10.4859 4.03123 8.73859C4.06542 8.55209 4.23446 8.41459 4.43281 8.41459C4.63516 8.41459 4.80546 8.55736 4.84192 8.74736C5.13046 10.2514 5.78583 11.1419 6.28571 11.1419C7.4351 11.1419 8.37311 7.68302 8.6555 5.00592C8.69592 4.62265 9.02867 4.32368 9.43222 4.32368Z" fill="currentColor"></path></svg></div>Ask AI</a></div></div></div></div></div></div></div></div><div class="col col--auto w-2/3-mxl w-full pb18 prose"><div class="flex round-bold mb18 overflow-hidden" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px"><div class="flex-child-no-shrink bg-gray w6"></div><div class="py24 px24 flex-child-grow bg-gray-faint"><div class="txt-fancy txt-l flex flex--start-cross mb12"><div class="mr12" style="margin-top:1px"><svg class="block color-gray" width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg" color="gray"><rect width="28" height="28" rx="6" fill="currentColor"></rect><path fill-rule="evenodd" clip-rule="evenodd" d="M5 14C5 9.0293 9.0293 5 14 5C18.9707 5 23 9.0293 23 14C23 18.9707 18.9707 23 14 23C9.0293 23 5 18.9707 5 14ZM14 9C14.552 9 15 9.448 15 10C15 10.552 14.552 11 14 11C13.448 11 13 10.552 13 10C13 9.448 13.448 9 14 9ZM13 12H14C14.631 12 15.093 12.569 14.969 13.188L14.219 17H15C15.552 17 16 17.448 16 18C16 18.552 15.552 19 15 19H14C12.817 19 11.987 17.973 12.219 16.812L12.812 13.938C12.359 13.842 12 13.482 12 13C12 12.448 12.448 12 13 12Z" fill="white"></path></svg></div>Map Matching API version</div><div class="color-gray-deep"> <p>This documentation is for <code>v5</code> of the Map Matching API. For information about the earlier version, see the <a target="_self" href="/api/legacy/map-matching-v4/"><code>v4</code> documentation</a> or <a target="_self" href="/api/navigation/changelog/#map-matching-api">view the changelog</a>. </p></div></div></div>   <p>The <strong>Mapbox Map Matching API</strong> snaps fuzzy, inaccurate traces from a GPS unit or a phone to the OpenStreetMap road and path network using the Directions API. This produces clean paths that can be displayed on a map or used for other analysis.</p>   <div class="flex round-bold mb18 overflow-hidden" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px"><div class="flex-child-no-shrink bg-gray w6"></div><div class="py24 px24 flex-child-grow bg-gray-faint"><div class="txt-fancy txt-l flex flex--start-cross mb12"><div class="mr12" style="margin-top:1px"><svg class="block color-gray" width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg" color="gray"><rect width="28" height="28" rx="6" fill="currentColor"></rect><path fill-rule="evenodd" clip-rule="evenodd" d="M5 14C5 9.0293 9.0293 5 14 5C18.9707 5 23 9.0293 23 14C23 18.9707 18.9707 23 14 23C9.0293 23 5 18.9707 5 14ZM14 9C14.552 9 15 9.448 15 10C15 10.552 14.552 11 14 11C13.448 11 13 10.552 13 10C13 9.448 13.448 9 14 9ZM13 12H14C14.631 12 15.093 12.569 14.969 13.188L14.219 17H15C15.552 17 16 17.448 16 18C16 18.552 15.552 19 15 19H14C12.817 19 11.987 17.973 12.219 16.812L12.812 13.938C12.359 13.842 12 13.482 12 13C12 12.448 12.448 12 13 12Z" fill="white"></path></svg></div>Turn-by-turn directions in the Map Matching API</div><div class="color-gray-deep"> <p>The Map Matching API can also return a full directions response to queries using the optional <code>steps</code> parameter. If you plan use the Map Matching API to return turn-by-turn directions, note that it does not consider all road rules and traffic conditions. To access up-to-date traffic and road conditions for navigation purposes, use the <a target="_self" href="/api/navigation/directions/">Mapbox Directions API</a>. </p></div></div></div>   <div class="pt18"><a href="https://docs.mapbox.com/help/tutorials/get-started-map-matching-api/" target="_blank" rel="noopener noreferrer" class="unprose block cursor-pointer color-gray-deep mb18 w-full"><div class="round-bold overflow-hidden border border--gray-lighter border--gray-light-on-hover transition" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px"><div class="flex flex--column px24 py18"><div class="flex flex--center-cross"><div class="flex flex--center-cross mr18"><div style="padding-top:1px;letter-spacing:0.07em" class="txt-fancy-medium round inline-block cursor-default color-gray-dark bg-green-light color-white txt-s px6 txt-bold">TUTORIAL</div></div><div class="color-black txt-bold txt-fancy">Get started with the Map Matching API</div><svg class="transition flex-child-no-shrink" style="margin-left:10px;margin-right:15px;opacity:1" width="11" height="11" viewBox="0 0 11 11" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M5.292 0L10.314 5.022V5.49L5.292 10.494L3.87 9.072L6.732 6.21L5.508 6.264H0V4.212H5.508L6.696 4.266L3.87 1.44L5.292 0Z" fill="black"></path></svg></div><div class="mt12"><p>Create a web app that uses the Map Matching API to allow users to specify their own driving route.</p></div></div></div></a></div> <h2 class="anchor" id="retrieve-a-match">Retrieve a match<a href="#retrieve-a-match" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Retrieve a match" title="Direct link to Retrieve a match"></a></h2>   <div class="mt24 mb12 bg-gray-lighter flex border border--gray txt-mono txt-s round"><div class="bg-gray color-white txt-uppercase txt-bold px12 py6 flex-child-no-shrink">get</div><div class="flex-child-grow px12 py6 txt-break-word">https://api.mapbox.com/matching/v5/<span class="txt-bold">{profile}</span>/<span class="txt-bold">{coordinates}</span>.json</div><div class="flex-child-no-shrink"><div role="button" aria-label="Copy" data-testid="copy-button" data-clipboard-text="https://api.mapbox.com/matching/v5/{profile}/{coordinates}.json"><span style="display:contents"><div type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R69jatalaqh:" data-state="closed"><button type="button" class="px12 py6 align-r" data-state="closed"><svg class="events-none icon" data-testid="icon-clipboard" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-clipboard"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">clipboard</span></button></div></span></div></div></div> <p>Return a path on the road and path network that is closest to the input traces.</p> <div class="overflow-auto mb18"><table><thead><tr><th>Required parameters</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>profile</code></td><td><code>string</code></td><td>A Mapbox Directions <a target="_self" href="/api/navigation/directions/#routing-profiles">routing profile</a> ID. <table class="mt12"><tr><th>Profile ID</th><th>Description</th></tr><tr><td><code>mapbox/driving</code></td><td>Car travel times, distances, or both.</td></tr><tr><td><code>mapbox/walking</code></td><td>Pedestrian and hiking travel times, distances, or both</td></tr><tr><td><code>mapbox/cycling</code></td><td>Bicycle travel times, distances, or both</td></tr><tr><td><code>mapbox/driving-traffic</code></td><td>Car travel times, distances, or both as informed by traffic data</td></tr></table></td></tr><tr><td><code>coordinates</code></td><td><code>number</code> or <code>string</code></td><td>A semicolon-separated list of <code>{longitude},{latitude}</code> coordinate pairs to visit in order. <br>Or OpenLR encoded string where <code>openlr_spec</code> describes the used specification and <code>openlr_format</code> describes the binary format. OpenLR strings are useful when using routes built on platforms outside of Mapbox.<br><em>If specified as coordinate pairs there can be between <code>2</code> and <code>100</code> coordinates.</em> <br><em>If specified as OpenLR string length, the OpenLR string can be not greater than 500 (which is 50 coordinates)</em></td></tr></tbody></table></div> <p>You can further refine the results from this endpoint with the following optional parameters:</p> <div class="overflow-auto mb18"><table><thead><tr><th>Optional parameters</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>annotations</code></td><td><code>string</code></td><td>Return additional metadata along the route. You can include several annotations as a comma-separated list. <strong>Must be used in combination with <code>overview=full</code>.</strong> <table class="mt12"><tr><th>Possible values</th><th>Description</th></tr><tr><td><code>distance</code></td><td>The distance between each pair of coordinates, in meters.</td></tr><tr><td><code>duration</code></td><td>The duration between each pair of coordinates, in seconds.</td></tr><tr><td><code>speed</code></td><td>The speed between each pair of coordinates, in meters per second.</td></tr><tr><td><code>congestion</code></td><td>The level of congestion between each entry in the array of coordinate pairs in the route leg. This annotation is only available for the <code>mapbox/driving-traffic</code> profile.</td></tr><tr><td><code>congestion_numeric</code></td><td>The numeric level of congestion between each entry in the array of coordinate pairs in the route leg. This annotation is only available for the <code>mapbox/driving-traffic</code> profile.</td></tr><tr><td><code>maxspeed</code> <div style="padding-top:1px;letter-spacing:0.07em" class="txt-fancy-medium round inline-block cursor-default color-gray-dark bg-blue-lighter color-blue-dark txt-s px6" data-state="closed">BETA</div> </td><td>The maximum speed limit between the coordinates of a segment. This annotation is only available for the <code>mapbox/driving</code> and <code>mapbox/driving-traffic</code> profiles. </td></tr></table> See the <a target="_self" href="/api/navigation/directions/#route-leg-object">route leg object</a> for more details on what is included with annotations.</td></tr><tr><td><code>approaches</code></td><td><code>string</code></td><td>A semicolon-separated list indicating the side of the road from which to approach waypoints in a requested route. Accepts <code>unrestricted</code> (default, route can arrive at the waypoint from either side of the road) or <code>curb</code> (route will arrive at the waypoint on the <code>driving_side</code> of the region). If provided, the number of approaches must be the same as the number of waypoints. But, you can skip a coordinate and show its position in the list with the <code>;</code> separator. If <code>waypoints</code> is not specified (so all coordinates are treated as waypoints), the list of approaches must be the same length as the list of coordinates. Must be used in combination with <code>steps=true</code>.</td></tr><tr><td><code>geometries</code></td><td><code>string</code></td><td>The format of the returned geometry. Allowed values are: <code>geojson</code> (as <a href="https://tools.ietf.org/html/rfc7946#appendix-A.2" target="_blank" rel="noopener noreferrer">LineString</a>), <a href="https://developers.google.com/maps/documentation/utilities/polylinealgorithm" target="_blank" rel="noopener noreferrer"><code>polyline</code></a> (default, a polyline with precision 5), and <a href="https://developers.google.com/maps/documentation/utilities/polylinealgorithm" target="_blank" rel="noopener noreferrer"><code>polyline6</code></a> (a polyline with precision 6).</td></tr><tr><td><code>overview</code></td><td><code>string</code></td><td>The type of returned overview geometry. Can be <code>full</code> (the most detailed geometry available), <code>simplified</code> (default, a simplified version of the full geometry), or <code>false</code> (no overview geometry).</td></tr><tr><td><code>radiuses</code></td><td><code>number</code></td><td>A semicolon-separated list indicating the maximum distance a coordinate can be moved to snap to the road network, in meters. If provided, the number of radiuses must be the same as the number of coordinates. But, you can skip a coordinate and show its position in the list with the <code>;</code> separator. Values can be a number between <code>0.0</code> and <code>50.00</code>. Use higher numbers (<code>20</code>-<code>50</code>) for noisy traces and lower numbers (<code>1</code>-<code>10</code>) for clean traces. The default value is <code>5</code>. A <code>NoSegment</code> error is returned if no routable road is located within the radius.</td></tr><tr><td><code>steps</code></td><td><code>boolean</code></td><td>Whether to return steps and turn-by-turn instructions (<code>true</code>) or not (<code>false</code>, default).<br><br>Setting <code>steps</code> to true will make the following guidance-related parameters available: <code>banner_instructions</code>, <code>language</code>, <code>roundabout_exits</code>, <code>voice_instructions</code>, <code>voice_units</code>, <code>waypoint_names</code>, and <code>waypoints</code>.</td></tr><tr><td><code>banner_instructions</code></td><td><code>boolean</code></td><td>Whether to return banner objects associated with the route steps (<code>true</code>) or not (<code>false</code>, default). <strong>Must be used in conjunction with <code>steps=true</code>.</strong></td></tr><tr><td><code>language</code></td><td><code>string</code></td><td>The language of returned turn-by-turn text instructions. See <a target="_self" href="/api/navigation/directions/#instructions-languages">supported languages</a>. The default is <code>en</code> (English). <strong>Must be used in conjunction with <code>steps=true</code>.</strong></td></tr><tr><td><code>roundabout_exits</code></td><td><code>boolean</code></td><td>Whether to emit instructions at roundabout exits (<code>true</code>) or not (<code>false</code>, default). Without this parameter, roundabout maneuvers are a single instruction that includes both entering and exiting the roundabout. With <code>roundabout_exits=true</code>, this maneuver becomes two instructions, one for entering the roundabout and one for exiting it. <strong>Must be used in conjunction with <code>steps=true</code>.</strong></td></tr><tr><td><code>voice_instructions</code></td><td><code>boolean</code></td><td>Whether to return <a href="https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html" target="_blank" rel="noopener noreferrer">SSML</a> marked-up text for voice guidance along the route (<code>true</code>) or not (<code>false</code>, default). <strong>Must be used in conjunction with <code>steps=true</code>.</strong></td></tr><tr><td><code>voice_units</code></td><td><code>string</code></td><td>Specify which type of units to return in the text for voice instructions. Can be <code>imperial</code> (default) or <code>metric</code>. <strong>Must be used in conjunction with <code>steps=true</code> and <code>voice_instructions=true</code>.</strong></td></tr><tr><td><code>tidy</code></td><td><code>boolean</code></td><td>Whether to remove clusters and re-samples traces for improved map matching results (<code>true</code>) or not (<code>false</code>, default).</td></tr><tr><td><code>timestamps</code></td><td><code>number</code></td><td>A semicolon-separated list of numbers in <a href="https://en.wikipedia.org/wiki/Unix_time" target="_blank" rel="noopener noreferrer">Unix time</a> (in other words, seconds since 1/1/1970 UTC) that correspond to each input coordinate. If provided, the number of timestamps must be the same as the number of coordinates, no coordinates can be skipped, and the timestamps must occur in ascending order. For best results, timestamps should have a sample rate of about 5 seconds.</td></tr><tr><td><code>waypoint_names</code></td><td><code>string</code></td><td>A semicolon-separated list of custom names for waypoints. These names will be used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters (including semicolons) cannot exceed <code>500</code>. The list of <code>waypoint_names</code> must be the same length as the list of waypoints, but you can skip a waypoint and show its position with the <code>;</code> separator. If <code>waypoints</code> is not specified (so all coordinates are treated as waypoints), the list of <code>waypoint_names</code> must be the same length as the list of coordinates.</td></tr><tr><td><code>waypoints</code></td><td><code>integer</code></td><td>A semicolon-separated list indicating which input coordinates should be treated as waypoints. If a coordinate is treated as a waypoint, it receives arrival and departure events in the <a href="#match-object" target="_self">match object's</a> route. If a list of waypoints is not provided, all coordinates are treated as waypoints. Each item in the list must be the zero-based index of an input coordinate, and the list must include <code>0</code> (the index of the first coordinate) and the index of the last coordinate. Waypoints are most useful in combination with <code>steps=true</code> and requests based on traces with high sample rates.</td></tr><tr><td><code>ignore</code></td><td><code>string</code></td><td>Ignore certain routing restrictions when map matching. You can include several <code>ignore</code> options as a comma-separated list (for example, <code>ignore=access,oneways,restrictions</code>). <table class="mt12"><tr><th>Possible values</th><th>Description</th></tr><tr> <td><code>access</code></td><td>Ignore access restrictions related to mode of travel.</td></tr><tr> <td><code>oneways</code></td><td>Ignore one-way restrictions.</td></tr><tr><td><code>restrictions</code></td><td>Ignore other restrictions, such as time-based or turn restrictions.</td></tr> </table> This option is only available for the <code>mapbox/driving</code> profile.</td></tr><tr><td><code>linear_references</code></td><td><code>boolean</code></td><td>Returns map-agnostic location identifiers of the roads along a route. When <code>true</code>, a successful response will include a key <code>linear_references</code>, the value of which is an array of base64-encoded <a href="https://download.tomtom.com/open/banners/openlr-whitepaper_v1.5.pdf" target="_blank" rel="noopener noreferrer">OpenLR location references</a>, matched by the input trace. This option is only available for <code>driving</code> and <code>driving-traffic</code> profile.</td></tr><tr><td><code>openlr_spec</code></td><td><code>string</code></td><td>The logical format for OpenLR encoded <code>coordinates</code> translates to how OpenLR attributes are being interpreted. Some data providers may use a different logical data format, as in the same attributes (FRC, FOW) may be interpreted differently. <table class="mt12"><tr><th>Possible values</th><th>Description</th></tr><tr> <td><code>tomtom</code></td><td>Based on <a href="https://download.tomtom.com/open/banners/openlr-whitepaper_v1.5.pdf" target="_blank" rel="noopener noreferrer"><code>TomTom</code> OpenLR location references,</a>. Read p. 31-40 to learn more about the specification.</td></tr><tr> <td><code>here</code></td><td>Based on <a href="https://www.iso.org/obp/ui/#iso:std:iso:ts:21219:-22:ed-1:v1:en" target="_blank" rel="noopener noreferrer">HERE/TPEG2 specification</a></td></tr></table> The default is <code>tomtom</code>.<br>This option is only available if <code>coordinates</code> are provided as OpenLR encoded string.</td></tr><tr><td><code>openlr_format</code></td><td><code>string</code></td><td>Binary format for OpenLR encoded <code>coordinates</code> translates to how an OpenLR input is encoded. <table class="mt12"><tr><th>Possible values</th><th>Description</th></tr><tr> <td><code>tomtom</code></td><td>Based on <a href="https://download.tomtom.com/open/banners/openlr-whitepaper_v1.5.pdf" target="_blank" rel="noopener noreferrer"><code>TomTom</code> OpenLR location references,</a>. Read p. 43-52 to learn more about the binary format.</td></tr></table> The default is <code>tomtom</code>.<br> This option is only available if <code>coordinates</code> are provided as OpenLR encoded string.</td></tr><tr><td><code>depart_at</code></td><td><code>string</code></td><td>The departure time from the first coordinates, formatted in one of three <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener noreferrer">ISO 8601</a> formats: <code>YYYY-MM-DDThh:mm:ssZ</code>, <code>YYYY-MM-DDThh:mmss±hh:mm</code>, or <code>YYYY-MM-DDThh:mm</code>. In the last format, the timezone is calculated from the first coordinates. If not provided then <code>depart_at</code> is considered to be the present time in the local timezone of the first coordinates. The map-matched route and duration will reflect traffic conditions based on the <code>depart_at</code> time.</td></tr></tbody></table></div> <p>Some processing tips to achieve the best results:</p> <ul> <li>Timestamps improve the quality of the matching and are highly recommended.</li> <li>The Map Matching API is limited to processing traces with up to 100 coordinates. If you need to process longer traces, you can split the trace and make multiple requests.  </li> <li>Clusters of points (like a person waiting at a train crossing for a few minutes) often don't add more information to a trace and can negatively impact map-matching quality. We recommend that you tidy the trace (remove clusters and provide a uniform sample rate). You can use the <code>tidy=true</code> query parameter or process your traces with external tools like <a href="https://github.com/mapbox/geojson-tidy" target="_blank" rel="noopener noreferrer">geojson-tidy</a>.</li> <li>Map matching works best with a sample rate of 5 seconds between points. If your trace has a higher sample rate, you may want to downsample your trace.</li> <li>With the <code>waypoints</code> parameter specified, traces that would normally return with sub-matches will error. We recommend tidying traces before using them with the <code>waypoints</code> parameter.</li> </ul> <h3 class="anchor" id="example-request-retrieve-a-match">Example request: Retrieve a match<a href="#example-request-retrieve-a-match" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Example request: Retrieve a match" title="Direct link to Example request: Retrieve a match"></a></h3> <div as="div" class="language-bash round-bold mb24 overflow-hidden relative" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px;background-color:#f6f8fa"><div class="relative round-bold"><pre tabindex="0" class="prism-code language-bash round-bold thin-scrollbar my0 px0 py0" style="color:#393A34;background-color:#f6f8fa;max-height:auto"><code class="wmin-full fl" style="padding:16px"><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token comment" style="color:#999988;font-style:italic"># Basic request that returns a match object with route legs between each waypoint</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="inline mr12" style="user-select:none;pointer-events:none;color:#999888">$</span><span class="token plain"></span><span class="token function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://api.mapbox.com/matching/v5/mapbox/driving/-117.17282,32.71204;-117.17288,32.71225;-117.17293,32.71244;-117.17292,32.71256;-117.17298,32.712603;-117.17314,32.71259;-117.17334,32.71254?access_token=YOUR_MAPBOX_ACCESS_TOKEN"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># Request to access speed limit information using the maxspeed annotation</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="inline mr12" style="user-select:none;pointer-events:none;color:#999888">$</span><span class="token plain"></span><span class="token function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://api.mapbox.com/matching/v5/mapbox/driving/-122.39636,37.79129;-122.39732,37.79283;-122.39606,37.79349?annotations=maxspeed&overview=full&geometries=geojson&access_token=YOUR_MAPBOX_ACCESS_TOKEN"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># Request with the approaches parameter set to 'curb' for each waypoint</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="inline mr12" style="user-select:none;pointer-events:none;color:#999888">$</span><span class="token plain"></span><span class="token function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://api.mapbox.com/matching/v5/mapbox/driving/-117.17282,32.71204;-117.17288,32.71225;-117.17293,32.71244;-117.17292,32.71256?approaches=curb;curb;curb;curb&access_token=YOUR_MAPBOX_ACCESS_TOKEN"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># Request with various parameters, returns a match object with one route leg between the first and last waypoints</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="inline mr12" style="user-select:none;pointer-events:none;color:#999888">$</span><span class="token plain"></span><span class="token function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://api.mapbox.com/matching/v5/mapbox/driving/2.344003,48.85805;2.34675,48.85727;2.34868,48.85936;2.34955,48.86084;2.34955,48.86088;2.34962,48.86102;2.34982,48.86125?steps=true&tidy=true&waypoints=0;6&waypoint_names=Home;Work&banner_instructions=true&access_token=YOUR_MAPBOX_ACCESS_TOKEN"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># Request with openlr encoded string as coordinates used `tomtom` specification, return the same response the same as for regular coordinates</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="inline mr12" style="user-select:none;pointer-events:none;color:#999888">$</span><span class="token plain"></span><span class="token function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://api.mapbox.com/matching/v5/mapbox/driving/CwOiYCUMoBNWAv9P%2F%2BMSBg%3D%3D?openlr_spec=tomtom&openlr_format=tomtom&access_token=YOUR_MAPBOX_ACCESS_TOKEN"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># Request with openlr encoded string as coordinates used `here` specification</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="inline mr12" style="user-select:none;pointer-events:none;color:#999888">$</span><span class="token plain"></span><span class="token function" style="color:#d73a49">curl</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://api.mapbox.com/matching/v5/mapbox/driving/Cwe2%2BiJmURNhMPlvCBAbbAAA?openlr_spec=here&access_token=YOUR_MAPBOX_ACCESS_TOKEN"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="absolute z1 top right color-white flex" style="margin-top:11px;margin-right:11px;opacity:0;transition:opacity 200ms ease-in-out"><div role="button" aria-label="Copy" data-testid="copy-button" data-clipboard-text="# Basic request that returns a match object with route legs between each waypoint curl "https://api.mapbox.com/matching/v5/mapbox/driving/-117.17282,32.71204;-117.17288,32.71225;-117.17293,32.71244;-117.17292,32.71256;-117.17298,32.712603;-117.17314,32.71259;-117.17334,32.71254?access_token=YOUR_MAPBOX_ACCESS_TOKEN" # Request to access speed limit information using the maxspeed annotation curl "https://api.mapbox.com/matching/v5/mapbox/driving/-122.39636,37.79129;-122.39732,37.79283;-122.39606,37.79349?annotations=maxspeed&overview=full&geometries=geojson&access_token=YOUR_MAPBOX_ACCESS_TOKEN" # Request with the approaches parameter set to 'curb' for each waypoint curl "https://api.mapbox.com/matching/v5/mapbox/driving/-117.17282,32.71204;-117.17288,32.71225;-117.17293,32.71244;-117.17292,32.71256?approaches=curb;curb;curb;curb&access_token=YOUR_MAPBOX_ACCESS_TOKEN" # Request with various parameters, returns a match object with one route leg between the first and last waypoints curl "https://api.mapbox.com/matching/v5/mapbox/driving/2.344003,48.85805;2.34675,48.85727;2.34868,48.85936;2.34955,48.86084;2.34955,48.86088;2.34962,48.86102;2.34982,48.86125?steps=true&tidy=true&waypoints=0;6&waypoint_names=Home;Work&banner_instructions=true&access_token=YOUR_MAPBOX_ACCESS_TOKEN" # Request with openlr encoded string as coordinates used `tomtom` specification, return the same response the same as for regular coordinates curl "https://api.mapbox.com/matching/v5/mapbox/driving/CwOiYCUMoBNWAv9P%2F%2BMSBg%3D%3D?openlr_spec=tomtom&openlr_format=tomtom&access_token=YOUR_MAPBOX_ACCESS_TOKEN" # Request with openlr encoded string as coordinates used `here` specification curl "https://api.mapbox.com/matching/v5/mapbox/driving/Cwe2%2BiJmURNhMPlvCBAbbAAA?openlr_spec=here&access_token=YOUR_MAPBOX_ACCESS_TOKEN" "><span style="display:contents"><div type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R76hjatalaqh:" data-state="closed"><button type="button" class="btn btn--xs py3 px3 round" data-state="closed"><svg class="events-none icon" data-testid="icon-clipboard" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-clipboard"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">clipboard</span></button></div></span></div></div></div></div>   <div class="flex round-bold mb18 overflow-hidden" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px"><div class="flex-child-no-shrink bg-gray w6"></div><div class="py24 px24 flex-child-grow bg-gray-faint"><div class="txt-fancy txt-l flex flex--start-cross mb12"><div class="mr12" style="margin-top:1px"><svg class="block color-gray" width="28" height="28" viewBox="0 0 28 28" fill="none" xmlns="http://www.w3.org/2000/svg" color="gray"><rect width="28" height="28" rx="6" fill="currentColor"></rect><path fill-rule="evenodd" clip-rule="evenodd" d="M5 14C5 9.0293 9.0293 5 14 5C18.9707 5 23 9.0293 23 14C23 18.9707 18.9707 23 14 23C9.0293 23 5 18.9707 5 14ZM14 9C14.552 9 15 9.448 15 10C15 10.552 14.552 11 14 11C13.448 11 13 10.552 13 10C13 9.448 13.448 9 14 9ZM13 12H14C14.631 12 15.093 12.569 14.969 13.188L14.219 17H15C15.552 17 16 17.448 16 18C16 18.552 15.552 19 15 19H14C12.817 19 11.987 17.973 12.219 16.812L12.812 13.938C12.359 13.842 12 13.482 12 13C12 12.448 12.448 12 13 12Z" fill="white"></path></svg></div>URL encoding of OpenLR references</div><div class="color-gray-deep"> <p>When submitting API requests containing OpenLR references, you must URL encode the reference before passing it in as a parameter. OpenLR references contain unsafe ASCII characters like <code>/</code>, <code>+</code>, and <code>=</code> which must be encoded to produce a valid URL. See <a href="https://www.w3schools.com/tags/ref_urlencode.ASP" target="_blank" rel="noopener noreferrer">W3Schools' page on URL encoding</a> for help with encoding unsafe ASCII characters. </p></div></div></div>   <h3 class="anchor" id="supported-libraries-retrieve-a-match">Supported libraries: Retrieve a match<a href="#supported-libraries-retrieve-a-match" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Supported libraries: Retrieve a match" title="Direct link to Supported libraries: Retrieve a match"></a></h3> <p>Mapbox wrapper libraries help you integrate Mapbox APIs into your existing application. The following SDKs support this endpoint:</p> <ul> <li><a href="https://github.com/mapbox/mapbox-directions-swift/#matching-a-trace-to-the-road-network" target="_blank" rel="noopener noreferrer">Mapbox Directions for Swift</a></li> <li><a href="https://docs.mapbox.com/android/java/api/libjava-services/5.8.0/com/mapbox/api/matching/v5/package-frame.html" target="_self" rel="noopener noreferrer">Mapbox Java SDK</a></li> <li><a href="https://github.com/mapbox/mapbox-sdk-js/blob/main/docs/services.md#getmatch" target="_blank" rel="noopener noreferrer">Mapbox JavaScript SDK</a></li> </ul> <p>See the SDK documentation for details and examples of how to use the relevant methods to query this endpoint.</p> <h3 class="anchor" id="response-retrieve-a-match">Response: Retrieve a match<a href="#response-retrieve-a-match" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Response: Retrieve a match" title="Direct link to Response: Retrieve a match"></a></h3> <p>The <strong>match response object</strong> contains one or more <a href="#match-object" target="_self">match objects</a>, as well as one or more <a href="#tracepoint-object" target="_self">tracepoint objects</a>.</p> <div class="overflow-auto mb18"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>code</code></td><td><code>string</code></td><td>A string indicating the state of the response. The potential values are listed in the <a href="#map-matching-api-errors" target="_self">Map Matching status codes section</a>.</td></tr><tr><td><code>matchings</code></td><td><code>array</code></td><td>An array of <a href="#match-object" target="_self">match objects</a>.</td></tr><tr><td><code>tracepoints</code></td><td><code>array</code></td><td>An array of <a href="#tracepoint-object" target="_self">tracepoint objects</a> that represent the location an input point was matched with, in the order in which they were matched. If a trace point is omitted by the Map Matching API because it is an outlier, the entry will be <code>null</code>.</td></tr></tbody></table></div> <p>With clean matches, only one match object is returned. When the algorithm cannot decide the correct match between two points, it will omit that line and return several sub-matches as match objects. The higher the number of sub-match match objects, the more likely it is that the input traces are poorly aligned to the road network.</p> <h4 class="anchor" id="example-response-retrieve-a-match">Example response: Retrieve a match<a href="#example-response-retrieve-a-match" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Example response: Retrieve a match" title="Direct link to Example response: Retrieve a match"></a></h4> <div as="div" class="language-json round-bold mb24 overflow-hidden relative" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px;background-color:#f6f8fa"><div class="relative round-bold"><pre tabindex="0" class="prism-code language-json round-bold thin-scrollbar my0 px0 py0" style="color:#393A34;background-color:#f6f8fa;max-height:auto"><code class="wmin-full fl" style="padding:16px"><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"matchings"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"confidence"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">4.615758886217236e-10</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"geometry"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"coordinates"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.397484</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792809</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.39746</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792693</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.39745</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792645</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.397437</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792586</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.397431</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792558</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.39741</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792466</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.397404</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.79244</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.397225</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792579</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.396623</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.793057</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.39636</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.793276</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.396075</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.793502</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"type"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"LineString"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"legs"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"annotation"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"maxspeed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unknown"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unknown"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unknown"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unknown"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"summary"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">""</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"weight"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">153.6</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"duration"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">73.6</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"steps"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"distance"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">207.8</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"weight_name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"routability"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"weight"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">153.6</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"duration"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">73.6</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"distance"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">207.8</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"tracepoints"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token null keyword" style="color:#00009f">null</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"alternatives_count"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"waypoint_index"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"matchings_index"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"distance"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">14.635568381812668</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"Davis Street"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"location"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.397484</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.792809</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"maxspeed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"speed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">48</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"km/h"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"alternatives_count"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"waypoint_index"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"matchings_index"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"distance"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.8762601659793365</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"Market Street"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"location"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-122.396075</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">37.793502</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"maxspeed"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"unknown"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"code"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"Ok"</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="absolute z1 top right color-white flex" style="margin-top:11px;margin-right:11px;opacity:0;transition:opacity 200ms ease-in-out"><div role="button" aria-label="Copy" data-testid="copy-button" data-clipboard-text="{ "matchings": [ { "confidence": 4.615758886217236e-10, "geometry": { "coordinates": [ [-122.397484, 37.792809], [-122.39746, 37.792693], [-122.39745, 37.792645], [-122.397437, 37.792586], [-122.397431, 37.792558], [-122.39741, 37.792466], [-122.397404, 37.79244], [-122.397225, 37.792579], [-122.396623, 37.793057], [-122.39636, 37.793276], [-122.396075, 37.793502] ], "type": "LineString" }, "legs": [ { "annotation": { "maxspeed": [ { "speed": 48, "unit": "km/h" }, { "speed": 48, "unit": "km/h" }, { "speed": 48, "unit": "km/h" }, { "speed": 48, "unit": "km/h" }, { "speed": 48, "unit": "km/h" }, { "speed": 48, "unit": "km/h" }, { "unknown": true }, { "unknown": true }, { "unknown": true }, { "unknown": true } ] }, "summary": "", "weight": 153.6, "duration": 73.6, "steps": [], "distance": 207.8 } ], "weight_name": "routability", "weight": 153.6, "duration": 73.6, "distance": 207.8 } ], "tracepoints": [ null, { "alternatives_count": 0, "waypoint_index": 0, "matchings_index": 0, "distance": 14.635568381812668, "name": "Davis Street", "location": [-122.397484, 37.792809], "maxspeed": { "speed": 48, "unit": "km/h" } }, { "alternatives_count": 1, "waypoint_index": 1, "matchings_index": 0, "distance": 1.8762601659793365, "name": "Market Street", "location": [-122.396075, 37.793502], "maxspeed": { "unknown": true } } ], "code": "Ok" }"><span style="display:contents"><div type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R76ujatalaqh:" data-state="closed"><button type="button" class="btn btn--xs py3 px3 round" data-state="closed"><svg class="events-none icon" data-testid="icon-clipboard" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-clipboard"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">clipboard</span></button></div></span></div></div></div></div> <h2 class="anchor" id="use-http-post-to-retrieve-a-match">Use HTTP POST to retrieve a match<a href="#use-http-post-to-retrieve-a-match" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Use HTTP POST to retrieve a match" title="Direct link to Use HTTP POST to retrieve a match"></a></h2> <p>The Map Matching API also supports access using the HTTP <code>POST</code> method. HTTP <code>POST</code> should be used for large requests, since the Map Matching API has a size limit of approximately 8100 bytes on <code>GET</code> request URLs. <code>POST</code> requests are still subject to your account's request size limits.</p> <p>Learn more about this process in the <a target="_self" href="/api/navigation/http-post/">Using HTTP POST</a> section.</p> <h2 class="anchor" id="match-object">Match object<a href="#match-object" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Match object" title="Direct link to Match object"></a></h2> <p>A <strong>match object</strong> is a <a target="_self" href="/api/navigation/directions/#route-object">route object</a> with an additional confidence field:</p> <div class="overflow-auto mb18"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>confidence</code></td><td><code>number</code></td><td>The level of confidence in the returned match, from <code>0</code> (low) to <code>1</code> (high).</td></tr><tr><td><code>distance</code></td><td><code>number</code></td><td>The distance traveled, in meters.</td></tr><tr><td><code>duration</code></td><td><code>number</code></td><td>The estimated travel time, in seconds.</td></tr><tr><td><code>weight</code></td><td><code>number</code></td><td>The weight in units described by <code>weight_name</code>.</td></tr><tr><td><code>weight_name</code></td><td><code>string</code></td><td>The weight used. The default is <code>routability</code>, which is duration-based, with additional penalties for less desirable maneuvers.</td></tr><tr><td><code>geometry</code></td><td><code>string</code></td><td>Depending on the <code>geometries</code> parameter in the request, this is a <a href="https://tools.ietf.org/html/rfc7946#appendix-A.2" target="_blank" rel="noopener noreferrer">GeoJSON LineString</a> or a <a href="https://developers.google.com/maps/documentation/utilities/polylinealgorithm" target="_blank" rel="noopener noreferrer">Polyline string</a>. Depending on the <code>overview</code> parameter in the request, this is the complete route geometry (<code>full</code>), a simplified geometry to the zoom level at which the route can be displayed in full (<code>simplified</code>), or is not included (<code>false</code>).</td></tr><tr><td><code>legs</code></td><td><code>array</code></td><td>An array of <a target="_self" href="/api/navigation/directions/#route-leg-object">route leg objects</a>.</td></tr><tr><td><code>voice_locale</code><br><br>(Requires <code>steps=true</code>)</td><td><code>string</code></td><td>The locale used for voice instructions. Defaults to <code>en</code> (English). See <a target="_self" href="/api/navigation/directions/#instructions-languages">supported languages</a>.</td></tr><tr><td><code>linear_references</code></td><td><code>array</code></td><td>An array of base64-encoded <a href="https://download.tomtom.com/open/banners/openlr-whitepaper_v1.5.pdf" target="_blank" rel="noopener noreferrer">OpenLR location references</a>, one for each graph edge of the road network matched by the input trace. This key is optional, and present only when <code>linear_references=true</code> in the request.</td></tr></tbody></table></div> <h3 class="anchor" id="example-match-object">Example match object<a href="#example-match-object" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Example match object" title="Direct link to Example match object"></a></h3> <div as="div" class="language-json round-bold mb24 overflow-hidden relative" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px;background-color:#f6f8fa"><div class="relative round-bold"><pre tabindex="0" class="prism-code language-json round-bold thin-scrollbar my0 px0 py0" style="color:#393A34;background-color:#f6f8fa;max-height:auto"><code class="wmin-full fl" style="padding:16px"><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"confidence"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.9548844020537051</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"distance"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">103.7</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"duration"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">16.4</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"geometry"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"gatfEfidjUi@Le@@Y?E??J?^Hf@"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"legs"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="absolute z1 top right color-white flex" style="margin-top:11px;margin-right:11px;opacity:0;transition:opacity 200ms ease-in-out"><div role="button" aria-label="Copy" data-testid="copy-button" data-clipboard-text="{ "confidence": 0.9548844020537051, "distance": 103.7, "duration": 16.4, "geometry": "gatfEfidjUi@Le@@Y?E??J?^Hf@", "legs": [] }"><span style="display:contents"><div type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R776jatalaqh:" data-state="closed"><button type="button" class="btn btn--xs py3 px3 round" data-state="closed"><svg class="events-none icon" data-testid="icon-clipboard" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-clipboard"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">clipboard</span></button></div></span></div></div></div></div> <h2 class="anchor" id="tracepoint-object">Tracepoint object<a href="#tracepoint-object" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Tracepoint object" title="Direct link to Tracepoint object"></a></h2> <p>A <strong>tracepoint object</strong> is a <a target="_self" href="/api/navigation/directions/#waypoint-object">waypoint object</a> with three additional fields: <code>matchings_index</code>, <code>waypoint_index</code>, and <code>alternatives_count</code>.</p> <div class="overflow-auto mb18"><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>matchings_index</code></td><td><code>integer</code></td><td>The index of the match object in <code>matchings</code> that the sub-trace was matched to.</td></tr><tr><td><code>waypoint_index</code></td><td><code>integer</code></td><td>The index of the waypoint inside the matched route.</td></tr><tr><td><code>alternatives_count</code></td><td><code>integer</code></td><td> The number of probable alternative matchings for this trace point. A value of <code>0</code> indicates that this point was matched unambiguously. Split the trace at these points for incremental map matching.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>The name of the road or path the coordinate snapped to.</td></tr><tr><td><code>location</code></td><td><code>array</code></td><td>An array that contains the location of the snapped coordinate, in the format <code>[longitude, latitude]</code>.</td></tr></tbody></table></div> <h3 class="anchor" id="example-tracepoint-object">Example tracepoint object<a href="#example-tracepoint-object" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Example tracepoint object" title="Direct link to Example tracepoint object"></a></h3> <div as="div" class="language-json round-bold mb24 overflow-hidden relative" style="box-shadow:rgba(0, 0, 0, 0.1) 0px 1px 2px 0px;background-color:#f6f8fa"><div class="relative round-bold"><pre tabindex="0" class="prism-code language-json round-bold thin-scrollbar my0 px0 py0" style="color:#393A34;background-color:#f6f8fa;max-height:auto"><code class="wmin-full fl" style="padding:16px"><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"waypoint_index"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"location"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token number" style="color:#36acaa">-117.172836</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">32.71204</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"North Harbor Drive"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"matchings_index"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"> </span><span class="token property" style="color:#36acaa">"alternatives_count"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token plain"></span><br></span><span class="token-line" style="line-height:1.7em;position:relative;text-wrap:nowrap"><div style="position:absolute;left:0" class="bg-gray-faint"></div><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="absolute z1 top right color-white flex" style="margin-top:11px;margin-right:11px;opacity:0;transition:opacity 200ms ease-in-out"><div role="button" aria-label="Copy" data-testid="copy-button" data-clipboard-text="{ "waypoint_index": 0, "location": [-117.172836, 32.71204], "name": "North Harbor Drive", "matchings_index": 0, "alternatives_count": 0 }"><span style="display:contents"><div type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R77bjatalaqh:" data-state="closed"><button type="button" class="btn btn--xs py3 px3 round" data-state="closed"><svg class="events-none icon" data-testid="icon-clipboard" style="width:18px;height:18px" aria-hidden="true" focusable="false"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#icon-clipboard"></use></svg><span style="position:absolute;border:0;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;word-wrap:normal">clipboard</span></button></div></span></div></div></div></div> <h2 class="anchor" id="map-matching-api-errors">Map Matching API errors<a href="#map-matching-api-errors" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Map Matching API errors" title="Direct link to Map Matching API errors"></a></h2> <p>On error, the server responds with different HTTP status codes:</p> <ul> <li>For responses with HTTP status codes lower than <code>500</code>, the JSON response body includes the code property, which may be used by client programs to manage control flow. The response body may also include a message property, with a human-readable explanation of the error.</li> <li>If a server error occurs, the HTTP status code will be <code>500</code> or higher and the response will not include a <code>code</code> property.</li> </ul> <div class="overflow-auto mb18"><table><thead><tr><th>Response body <code>code</code></th><th>HTTP status code</th><th>Description</th></tr></thead><tbody><tr><td><code>Ok</code></td><td><code>200</code></td><td>Normal case</td></tr><tr><td><code>NoMatch</code></td><td><code>200</code></td><td>The input did not produce any matches, or the <code>waypoints</code> requested were not found in the resulting match. <code>features</code> will be an empty array.</td></tr><tr><td><code>NoSegment</code></td><td><code>200</code></td><td>No road segment could be matched for one or more coordinates within the supplied <code>radiuses</code>. Check for coordinates that are too far away from a road.</td></tr><tr><td><code>Not Authorized - No Token</code></td><td><code>401</code></td><td>No token was used in the query.</td></tr><tr><td><code>Not Authorized - Invalid Token</code></td><td><code>401</code></td><td>Check the access token you used in the query.</td></tr><tr><td><code>Forbidden</code></td><td><code>403</code></td><td>There may be an issue with your account. Check your <a href="https://account.mapbox.com/" target="_blank" rel="noopener noreferrer">Account page</a> for more details.<br><br>In some cases, using an access tokens with URL restrictions can also result in a <code>403</code> error. For more information, see our <a href="https://docs.mapbox.com/accounts/guides/tokens/#url-restrictions" target="_self" rel="noopener noreferrer">Token management guide</a>.</td></tr><tr><td><code>TooManyCoordinates</code></td><td><code>422</code></td><td>There are more than 100 points in the regular request, or more than 50 points for OpenLR input.</td></tr><tr><td><code>ProfileNotFound</code></td><td><code>404</code></td><td>Needs to be a valid profile (<code>mapbox/driving</code>, <code>mapbox/driving-traffic</code>, <code>mapbox/walking</code>, or <code>mapbox/cycling</code>).</td></tr><tr><td><code>InvalidInput</code></td><td><code>422</code></td><td><code>message</code> will hold an explanation of the invalid input.</td></tr></tbody></table></div> <h2 class="anchor" id="map-matching-api-restrictions-and-limits">Map Matching API restrictions and limits<a href="#map-matching-api-restrictions-and-limits" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Map Matching API restrictions and limits" title="Direct link to Map Matching API restrictions and limits"></a></h2> <ul> <li>The Map Matching API is limited to 300 requests per minute.</li> <li>Each regular request can have a maximum of 100 coordinates.</li> <li>Each OpenLR request can have a maximum of 50 coordinates.</li> <li>Results must be displayed on a Mapbox map using one of the Mapbox <a href="https://mapbox.com/documentation" target="_blank" rel="noopener noreferrer">libraries or SDKs</a>.</li> </ul> <span>If you require a higher rate limit,<a href="https://www.mapbox.com/contact/sales/" target="_blank" rel="noopener noreferrer">contact us</a>.</span> <h2 class="anchor" id="map-matching-api-pricing">Map Matching API pricing<a href="#map-matching-api-pricing" class="hash-link unprose color-blue-on-hover" aria-label="Direct link to Map Matching API pricing" title="Direct link to Map Matching API pricing"></a></h2> <div class="mb24"><ul class="list-check"><li>Billed by <strong>requests</strong></li><li>See rates and discounts per Map Matching API request  in the pricing page's <strong><a href="https://www.mapbox.com/pricing/#matching" target="_blank" rel="noopener noreferrer">Navigation</a></strong> section</li></ul></div> <p>Usage of the Map Matching API is measured in <strong>API requests</strong>. A request that contains multiple waypoints is billed as a single API request. Details about the number of Map Matching API requests included in the free tier and the cost per request beyond what is included in the free tier are available on the <a href="https://www.mapbox.com/pricing/#matching" target="_blank" rel="noopener noreferrer">pricing page</a>.</p><div class="my36 color-text block none-mxl"><div class="flex mx-neg6 flex--wrap"><div class="w-full w-1/2-ml px6 flex-child-no-shrink mb18"><div class="dr-ui--signup-banner py18 px18 mb12 round-bold flex bg-gray-faint color-text mb18"><div class="w-full prose flex flex--wrap" style="row-gap:10px"><div class="flex-child-grow mr12"><div class="txt-bold mb6">Ready to get started?</div><div class="txt-ms mb18-mxl">Create a free account to start building with Mapbox.</div></div><div class="flex flex--center-cross flex-child-no-shrink"><a href="https://account.mapbox.com/auth/signup" target="_blank" rel="noopener noreferrer" class="btn btn--blue round-full unprose">Sign Up</a></div></div></div></div><div class="w-full w-1/2-ml px6 flex-child-no-shrink mb18"><div class="py18 px18 round-bold flex bg-gray-faint color-text"><div class="w-full prose flex flex--wrap" style="row-gap:10px"><div class="flex-child-grow mr12"><div class="txt-bold mb12">Additional Developer Resources</div><div class="mb4"><div data-state="closed"><a href="https://discord.gg/uMpcC5RmJh" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M18.2477 6.16644C17.0825 5.62152 15.8367 5.2255 14.5342 5C14.3742 5.28908 14.1873 5.67791 14.0585 5.98721C12.6739 5.77908 11.302 5.77908 9.94287 5.98721C9.81404 5.67791 9.62292 5.28908 9.46152 5C8.15761 5.2255 6.91032 5.62298 5.74514 6.16933C3.39498 9.7192 2.75789 13.1809 3.07644 16.5934C4.63519 17.757 6.14581 18.4638 7.63093 18.9263C7.99762 18.4218 8.32465 17.8856 8.60638 17.3205C8.06981 17.1167 7.5559 16.8652 7.07031 16.5732C7.19913 16.4778 7.32514 16.3781 7.44689 16.2754C10.4086 17.6601 13.6267 17.6601 16.5531 16.2754C16.6762 16.3781 16.8022 16.4778 16.9296 16.5732C16.4426 16.8666 15.9273 17.1181 15.3907 17.3219C15.6724 17.8856 15.9981 18.4233 16.3662 18.9277C17.8527 18.4652 19.3647 17.7584 20.9235 16.5934C21.2973 12.6374 20.285 9.20752 18.2477 6.16644ZM9.00988 14.4947C8.12079 14.4947 7.39166 13.6651 7.39166 12.6548C7.39166 11.6444 8.10522 10.8134 9.00988 10.8134C9.91457 10.8134 10.6437 11.643 10.6281 12.6548C10.6295 13.6651 9.91457 14.4947 9.00988 14.4947ZM14.9901 14.4947C14.101 14.4947 13.3718 13.6651 13.3718 12.6548C13.3718 11.6444 14.0854 10.8134 14.9901 10.8134C15.8947 10.8134 16.6238 11.643 16.6083 12.6548C16.6083 13.6651 15.8947 14.4947 14.9901 14.4947Z" fill="currentColor"></path></svg></div>Mapbox Developer Discord</a></div></div><div class="mb4"><div data-state="closed"><a href="https://labs.mapbox.com/developer-cheatsheet/" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M12.648 3C13.1022 3 13.4932 3.32847 13.5823 3.78479L14.0188 6.02089C14.0517 6.18936 14.1691 6.32636 14.3245 6.39088C14.5565 6.48721 14.7815 6.59752 14.9985 6.7208C15.1453 6.80418 15.3233 6.81157 15.4719 6.73166L17.4432 5.67169C17.8454 5.45545 18.3406 5.56011 18.6264 5.92176L19.4422 6.95387C19.728 7.31552 19.7249 7.8336 19.4349 8.1917L18.0135 9.94646C17.9064 10.0787 17.8765 10.2584 17.9253 10.4228C18.0025 10.6823 18.0638 10.9488 18.1082 11.2213C18.1359 11.3909 18.241 11.5383 18.3946 11.6078L20.4317 12.5288C20.8473 12.7167 21.0756 13.1789 20.9773 13.6332L20.6968 14.9298C20.5985 15.3842 20.2008 15.7042 19.7468 15.6946L17.5202 15.6472C17.3528 15.6436 17.1969 15.7313 17.1018 15.8725C16.95 16.0981 16.7844 16.313 16.6061 16.5161C16.494 16.6439 16.447 16.8198 16.4896 16.9859L17.0545 19.1939C17.1697 19.644 16.9587 20.1149 16.5505 20.3189L15.3855 20.9011C14.9773 21.1051 14.4853 20.9855 14.21 20.6154L12.8599 18.8002C12.7584 18.6637 12.5946 18.5933 12.4275 18.6048C12.1441 18.6244 11.856 18.6244 11.5726 18.6049C11.4055 18.5933 11.2417 18.6637 11.1402 18.8002L9.79008 20.6154C9.51479 20.9855 9.02279 21.1051 8.61458 20.9011L7.44958 20.3189C7.04136 20.1149 6.83043 19.6441 6.94561 19.1939L7.51049 16.9862C7.55301 16.82 7.50608 16.6441 7.39395 16.5164C7.21559 16.3132 7.04985 16.0982 6.89799 15.8726C6.80289 15.7313 6.64705 15.6436 6.47958 15.6472L4.25323 15.6946C3.79915 15.7042 3.40153 15.3842 3.30323 14.9298L3.02269 13.6332C2.92438 13.1789 3.15273 12.7167 3.56825 12.5288L5.60518 11.6079C5.75877 11.5384 5.86394 11.391 5.8916 11.2214C5.936 10.9489 5.99736 10.6823 6.07451 10.4228C6.12337 10.2584 6.09337 10.0787 5.98629 9.94647L4.56494 8.19171C4.27489 7.83361 4.27184 7.31553 4.55767 6.95388L5.37338 5.92177C5.65921 5.56012 6.15443 5.45546 6.5566 5.67171L8.52788 6.73167C8.67649 6.81158 8.85449 6.80419 9.00127 6.72081C9.21829 6.59752 9.4433 6.48721 9.67531 6.39088C9.83071 6.32636 9.94816 6.18936 9.98105 6.02089L10.4175 3.78479C10.5066 3.32847 10.8976 3 11.3518 3H12.648ZM11.9999 14.7149C13.3155 14.7149 14.3819 13.6222 14.3819 12.2743C14.3819 10.9264 13.3155 9.83369 11.9999 9.83369C10.6844 9.83369 9.61794 10.9264 9.61794 12.2743C9.61794 13.6222 10.6844 14.7149 11.9999 14.7149Z" fill="currentColor"></path></svg></div>Developer Cheatsheet</a></div></div><div class="mb4"><div data-state="closed"><a href="https://support.mapbox.com/hc/en-us" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M8.32686 20C8.63025 20 8.85418 19.8582 9.21535 19.5392L11.8808 17.1786L16.605 17.1857C18.7792 17.1857 20 15.9523 20 13.8469V8.33885C20 6.23346 18.7792 5 16.605 5H7.39503C5.22799 5 4 6.23346 4 8.33885V13.8469C4 15.9594 5.26411 17.1786 7.34447 17.1786H7.63341V19.2344C7.63341 19.7023 7.88623 20 8.32686 20ZM8.37743 12.1881C7.75621 12.1881 7.25056 11.699 7.25056 11.0893C7.25056 10.4797 7.75621 9.98346 8.37743 9.98346C8.99865 9.98346 9.50429 10.4797 9.50429 11.0893C9.50429 11.699 8.99865 12.1881 8.37743 12.1881ZM12.0108 12.1881C11.3824 12.1881 10.884 11.699 10.884 11.0893C10.884 10.4797 11.3824 9.98346 12.0108 9.98346C12.6321 9.98346 13.1305 10.4797 13.1305 11.0893C13.1305 11.699 12.6321 12.1881 12.0108 12.1881ZM15.637 12.1881C15.0158 12.1881 14.5102 11.699 14.5102 11.0893C14.5102 10.4797 15.0158 9.98346 15.637 9.98346C16.2582 9.98346 16.7639 10.4797 16.7639 11.0893C16.7639 11.699 16.2582 12.1881 15.637 12.1881Z" fill="currentColor"></path></svg></div>Mapbox Support</a></div></div><div class="mb4"><div data-state="closed"><a href="https://docs.mapbox.com/ask-ai/" target="_blank" rel="noopener noreferrer" class="unprose flex justify-start txt-ms color-gray color-blue-on-hover"><div class="mr6"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.43222 4.32368C9.83276 4.32368 10.1646 4.61909 10.1996 4.99997C10.5087 8.35823 11.1285 10.46 12 10.46C12.8715 10.46 13.4913 8.35823 13.8004 4.99997C13.8354 4.61909 14.1672 4.32368 14.5678 4.32368C14.9713 4.32368 15.3041 4.62265 15.3445 5.00592C15.6269 7.68302 16.5649 11.1419 17.7143 11.1419C18.2142 11.1419 18.8695 10.2514 19.1581 8.74736C19.1945 8.55736 19.3648 8.41459 19.5672 8.41459C19.7655 8.41459 19.9346 8.55209 19.9688 8.73858C20.2891 10.4859 20.6178 11.4068 21.823 11.6267C21.9232 11.645 22 11.7263 22 11.8237C22 11.9211 21.9232 12.0024 21.823 12.0207C20.6178 12.2406 20.2891 13.1615 19.9688 14.9088C19.9346 15.0953 19.7655 15.2328 19.5672 15.2328C19.3648 15.2328 19.1945 15.09 19.1581 14.9C18.8695 13.396 18.2142 12.5055 17.7143 12.5055C16.5649 12.5055 15.6269 15.9643 15.3445 18.6414C15.3041 19.0247 14.9713 19.3237 14.5678 19.3237C14.1672 19.3237 13.8354 19.0283 13.8004 18.6474C13.4913 15.2891 12.8715 13.1873 12 13.1873C11.1285 13.1873 10.5087 15.2891 10.1996 18.6474C10.1646 19.0283 9.83276 19.3237 9.43222 19.3237C9.02867 19.3237 8.69592 19.0247 8.6555 18.6414C8.37311 15.9643 7.4351 12.5055 6.28571 12.5055C5.78583 12.5055 5.13046 13.396 4.84192 14.9C4.80546 15.09 4.63516 15.2328 4.43281 15.2328C4.23446 15.2328 4.06542 15.0953 4.03123 14.9088C3.71085 13.1615 3.38216 12.2406 2.17699 12.0207C2.07679 12.0024 2 11.9211 2 11.8237C2 11.7263 2.07679 11.645 2.17699 11.6267C3.38216 11.4068 3.71085 10.4859 4.03123 8.73859C4.06542 8.55209 4.23446 8.41459 4.43281 8.41459C4.63516 8.41459 4.80546 8.55736 4.84192 8.74736C5.13046 10.2514 5.78583 11.1419 6.28571 11.1419C7.4351 11.1419 8.37311 7.68302 8.6555 5.00592C8.69592 4.62265 9.02867 4.32368 9.43222 4.32368Z" fill="currentColor"></path></svg></div>Ask AI</a></div></div></div></div></div></div></div></div><div class="pt60 pb30"><div class="txt-fancy txt-m flex flex--center-cross">Was this page helpful?<span class="ml18" style="line-height:0"><button type="button" class="btn btn--blue round py6 px12 txt-s" aria-label="primary" id="feedback-button-yes"><span class="flex flex--center-cross"><span class="mr6"><svg class="icon" style="height:16px;width:16px" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M4.11117 12.3172L2.55561 12.3172C2.12613 12.3172 1.77783 11.9762 1.77783 11.5767L1.77783 7.27998C1.77783 6.85927 2.12613 6.5395 2.55561 6.5395L4.11116 6.5395C4.54064 6.5395 4.88894 6.88069 4.88894 7.27998L4.88894 11.5555C4.88894 11.9762 4.54137 12.3172 4.11117 12.3172ZM13.1358 8.37617C13.3254 8.57855 13.4445 8.8476 13.4445 9.14522C13.4445 9.70403 13.0345 10.1671 12.4932 10.2664C12.6011 10.4381 12.6667 10.6405 12.6667 10.8786C12.6667 11.3862 12.3264 11.8114 11.8586 11.9602C11.8768 12.0209 11.8889 12.1045 11.8889 12.1909C11.8889 12.8221 11.3664 13.3333 10.7223 13.3333L9.29578 13.3333C8.45457 13.3333 7.6362 13.0662 6.96318 12.5719L6.13339 11.9626C5.83929 11.7469 5.66672 11.4071 5.66672 11.069L5.66933 7.2595C5.67104 6.92641 5.81815 6.59427 6.10464 6.36998L6.50082 6.05974C8.49103 4.47855 7.59658 2.66665 9.13026 2.66665C9.88276 2.66665 10.3327 3.25046 10.3327 3.81212C10.3327 4.17284 10.0468 5.19593 9.49363 6.09831L13.0556 6.09831C13.7002 6.09831 14.2223 6.6095 14.2223 7.24069C14.2223 7.84522 13.741 8.33569 13.1358 8.37617Z" fill="white"></path></svg></span>Yes</span></button></span><span class="ml12" style="line-height:0"><button type="button" class="btn btn--blue round py6 px12 txt-s" aria-label="primary" id="feedback-button-no"><span class="flex flex--center-cross"><span class="mr6"><svg class="icon" style="height:16px;width:16px" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M11.8888 3.6828H13.4444C13.8739 3.6828 14.2222 4.02375 14.2222 4.42327L14.2222 8.72002C14.2222 9.14073 13.8739 9.4605 13.4444 9.4605H11.8888C11.4594 9.4605 11.1111 9.11931 11.1111 8.72002V4.44446C11.1111 4.02375 11.4586 3.6828 11.8888 3.6828ZM2.86418 7.62383C2.6746 7.42145 2.5555 7.1524 2.5555 6.85478C2.5555 6.29597 2.96554 5.83288 3.50682 5.73359C3.3989 5.56192 3.33328 5.35954 3.33328 5.12145C3.33328 4.61383 3.67356 4.18859 4.14144 4.03978C4.12321 3.97907 4.11106 3.8955 4.11106 3.80907C4.11106 3.17788 4.63363 2.66669 5.27772 2.66669H6.70422C7.54543 2.66669 8.3638 2.93383 9.03682 3.42812L9.86661 4.0374C10.1607 4.25312 10.3333 4.59288 10.3333 4.93097L10.3307 8.7405C10.329 9.07359 10.1818 9.40573 9.89536 9.63002L9.49918 9.94026C7.50897 11.5214 8.40342 13.3334 6.86974 13.3334C6.11724 13.3334 5.66734 12.7495 5.66734 12.1879C5.66734 11.8272 5.95317 10.8041 6.50637 9.90169H2.94439C2.29981 9.90169 1.77772 9.3905 1.77772 8.75931C1.77772 8.15478 2.25897 7.66431 2.86418 7.62383Z" fill="white"></path></svg></span>No</span></button></span></div></div></div></div></div></article></main></div></div></div></div><div class="flex-child-no-shrink shell-wrapper"><footer id="page-footer" class="bg-gray-faint flex flex--center-cross" data-swiftype-index="false" style="min-height:72px"><div class="wmax1800 w-11/12-mm w-11/12-ml mx-auto px24 px0-mm"><div id="page-footer-legal-social" class="txt-s color-gray py12 py0-ml flex flex--column flex--row-mm"><div class="col mt12 flex-child-grow flex flex--wrap"><a href="https://www.mapbox.com/" target="_blank" rel="noopener noreferrer" class="link color-gray-deep color-gray-dark-on-hover mr18 txt-nowrap mb6">© Mapbox All Rights Reserved</a><a href="https://www.mapbox.com/tos/" target="_blank" rel="noopener noreferrer" class="link color-gray-deep color-gray-dark-on-hover mr18 txt-nowrap mb6">Terms</a><a href="https://www.mapbox.com/privacy/" target="_blank" rel="noopener noreferrer" class="link color-gray-deep color-gray-dark-on-hover mr18 txt-nowrap mb6">Privacy</a><a href="https://www.mapbox.com/platform/security/" target="_blank" rel="noopener noreferrer" class="link color-gray-deep color-gray-dark-on-hover mr18 txt-nowrap mb6">Security</a><a href="https://www.mapbox.com/legal/cookies" target="_blank" rel="noopener noreferrer" class="link color-gray-deep color-gray-dark-on-hover txt-nowrap mb6">Your California Privacy Choices</a></div><div class="col my12 align-r-mm flex-child-no-shrink"><a href="https://github.com/mapbox" target="_blank" rel="noopener noreferrer" aria-label="Github" class="color-gray-deep color-gray-deep-dark-on-hover inline-block w36"><svg viewBox="0 0 14 14" style="height:15px;width:15px" class="icon inline"><path fill-rule="evenodd" clip-rule="evenodd" d="M14 7c0 3.9-3.1 7-7 7s-7-3.1-7-7 3.1-7 7-7 7 3.1 7 7zm-9 5.7V11h-.8C3 11 2.1 9.5 2.1 8.7c0-.5.6-.7.9-.2.1.1.6 1 1.2 1 .3 0 .6-.1.9-.2.1-.3.3-.6.6-.8h-.2C4.1 8.5 3 7.4 3 6c0-.7.3-1.3.7-1.7 0-.6.1-1.1.2-1.5.1-.2.3-.3.4-.3.4.1 1.2.3 1.8.9h1.6c.7-.6 1.4-.9 1.8-.9.2 0 .4.1.4.3.1.3.2.8.2 1.3.6.5.9 1.2.9 1.9 0 1.4-1.1 2.5-2.5 2.5h-.2c.4.4.7.9.7 1.5v2.7c2.3-.8 4-3 4-5.7 0-3.3-2.7-6-6-6S1 3.7 1 7c0 2.6 1.7 4.8 4 5.7z"></path></svg></a><a href="https://twitter.com/mapbox/" target="_blank" rel="noopener noreferrer" aria-label="Twitter" class="color-gray-deep color-gray-deep-dark-on-hover inline-block w36"><svg viewBox="0 0 12 10" style="height:15px;width:15px" class="icon inline"><path d="M12 1.2c-.4.2-.9.4-1.4.4.5-.3.9-.8 1.1-1.4-.5.3-1 .5-1.5.6C9.8.4 9.1 0 8.4 0 7 0 5.9 1.2 5.9 2.5c0 .2 0 .4.1.5C3.9 3.1 2.1 2 .9.5.6.9.5 1.3.5 1.8c0 .9.4 1.6 1.1 2.1-.4 0-.8-.1-1.1-.4 0 1.2.9 2.2 2 2.5-.2.1-.4.1-.7.1-.2 0-.3 0-.4-.1.3 1 1.2 1.7 2.3 1.8-.9.7-1.9 1-3.1 1H0c1.1.8 2.4 1.2 3.8 1.2 4.5 0 7-3.8 7-7.1v-.4c.4-.3.9-.7 1.2-1.3z"></path></svg></a><a href="https://www.linkedin.com/company/mapbox" target="_blank" rel="noopener noreferrer" aria-label="LinkedIn" class="color-gray-deep color-gray-deep-dark-on-hover inline-block w36"><svg viewBox="0 0 24 24" style="height:15px;width:15px" class="icon inline"><path d="M5.68801 6.31665H0.633606V23.9998H5.68801V6.31665Z"></path><path d="M17.6832 6.31665C14.16 6.31665 13.5504 7.60305 13.2624 8.84145V6.31665H8.21277V23.9998H13.2624V13.8959C13.2624 12.2591 14.1504 11.3711 15.7872 11.3711C17.424 11.3711 18.312 12.2399 18.312 13.8959V23.9998H23.3664V15.1582C23.3664 10.1039 22.7088 6.31665 17.6832 6.31665Z"></path><path d="M3.15841 5.0496C4.55281 5.0496 5.68321 3.91921 5.68321 2.5248C5.68321 1.13039 4.55281 0 3.15841 0C1.764 0 0.633606 1.13039 0.633606 2.5248C0.633606 3.91921 1.764 5.0496 3.15841 5.0496Z"></path></svg></a><a href="https://www.facebook.com/Mapbox" target="_blank" rel="noopener noreferrer" aria-label="Facebook" class="color-gray-deep color-gray-deep-dark-on-hover inline-block w36"><svg viewBox="0 0 50 50" style="height:15px;width:15px" class="icon inline"><g id="38f48a9c-03c5-4a1e-8aed-38100e1cd6a4" data-name="svg"><path id="c5d5da0e-6004-406b-ad77-825ffd134c21" data-name="f" d="M28.87,50V27.19h7.65l1.15-8.89h-8.8V12.63c0-2.57.71-4.33,4.41-4.33H38v-8A63.78,63.78,0,0,0,31.13,0C24.34,0,19.69,4.14,19.69,11.75V18.3H12v8.89h7.68V50Z"></path></g></svg></a><a href="https://www.instagram.com/Mapbox" target="_blank" rel="noopener noreferrer" aria-label="Instagram" class="color-gray-deep color-gray-deep-dark-on-hover inline-block w36"><svg viewBox="0 0 24 24" style="height:15px;width:15px" class="icon inline"><path d="M11.9968 7.9983C9.79333 7.9983 7.99515 9.79651 7.99515 12C7.99515 14.2035 9.79333 16.0017 11.9968 16.0017C14.2002 16.0017 15.9984 14.2035 15.9984 12C15.9984 9.79651 14.2002 7.9983 11.9968 7.9983ZM23.9987 12C23.9987 10.3429 24.0137 8.70077 23.9206 7.04665C23.8275 5.12536 23.3893 3.4202 21.9843 2.01525C20.5764 0.607302 18.8743 0.172008 16.953 0.0789456C15.2959 -0.0141173 13.6539 0.000892936 11.9998 0.000892936C10.3427 0.000892936 8.70061 -0.0141173 7.04652 0.0789456C5.12526 0.172008 3.42014 0.610305 2.01522 2.01525C0.607291 3.42321 0.172005 5.12536 0.0789442 7.04665C-0.014117 8.70377 0.000892919 10.3459 0.000892919 12C0.000892919 13.6541 -0.014117 15.2992 0.0789442 16.9533C0.172005 18.8746 0.610293 20.5798 2.01522 21.9847C3.42314 23.3927 5.12526 23.828 7.04652 23.9211C8.70361 24.0141 10.3457 23.9991 11.9998 23.9991C13.6569 23.9991 15.2989 24.0141 16.953 23.9211C18.8743 23.828 20.5794 23.3897 21.9843 21.9847C23.3923 20.5768 23.8275 18.8746 23.9206 16.9533C24.0167 15.2992 23.9987 13.6571 23.9987 12ZM11.9968 18.1572C8.58954 18.1572 5.83973 15.4073 5.83973 12C5.83973 8.5927 8.58954 5.84284 11.9968 5.84284C15.404 5.84284 18.1538 8.5927 18.1538 12C18.1538 15.4073 15.404 18.1572 11.9968 18.1572ZM18.406 7.02864C17.6105 7.02864 16.968 6.38621 16.968 5.59067C16.968 4.79513 17.6105 4.1527 18.406 4.1527C19.2015 4.1527 19.8439 4.79513 19.8439 5.59067C19.8442 5.77957 19.8071 5.96667 19.735 6.14124C19.6628 6.31581 19.5569 6.47442 19.4233 6.608C19.2897 6.74157 19.1311 6.84748 18.9565 6.91967C18.782 6.99185 18.5949 7.02888 18.406 7.02864Z"></path></svg></a><a href="https://discord.gg/uMpcC5RmJh" target="_blank" rel="noopener noreferrer" aria-label="Discord" class="color-gray-deep color-gray-deep-dark-on-hover inline-block w36"><svg viewBox="0 0 24 24" style="height:15px;width:15px" class="icon inline"><path d="M20.46,4.55c-1.58-.72-3.24-1.23-4.95-1.52-.23,.42-.45,.85-.63,1.29-1.82-.27-3.67-.27-5.5,0-.19-.44-.4-.87-.63-1.29-1.71,.29-3.38,.81-4.96,1.53C.65,9.19-.2,13.71,.23,18.17H.23c1.84,1.36,3.89,2.39,6.07,3.05,.49-.66,.93-1.36,1.3-2.1-.71-.27-1.4-.59-2.05-.98,.17-.12,.34-.25,.5-.38,3.85,1.81,8.3,1.81,12.14,0,.16,.13,.33,.26,.5,.38-.65,.39-1.34,.71-2.05,.98,.37,.73,.81,1.43,1.3,2.1,2.19-.66,4.24-1.69,6.08-3.05h0c.5-5.17-.85-9.65-3.57-13.62ZM8.14,15.43c-1.18,0-2.16-1.07-2.16-2.4s.94-2.4,2.16-2.4,2.18,1.08,2.16,2.4-.95,2.4-2.16,2.4Zm7.97,0c-1.19,0-2.16-1.07-2.16-2.4s.94-2.4,2.16-2.4,2.18,1.08,2.16,2.4-.95,2.4-2.16,2.4Z"></path></svg></a></div></div></div></footer></div></div></div></div> </body> </html>