Distances Calculation API

API ID 5240

Distances Calculation API calculates travel distances and durations between an origin and multiple destinations, providing essential information for planning routes effectively.

100% uptime 140 ms avg response

API Documentation

Endpoints

Request

To use this endpoint you must specify a source and one or more destinations in the parameters.

 

Endpoint ID: 6720
GET https://zylalabs.com/api/5240/distances+calculation+api/6720/distance+calculator
INPUT PARAMETERS

Distance Calculator — Endpoint Features

Object Description
origins Required Indicates a latitude and longitude of origin such as (40.748817%2C-73.985428)
destinations Required Indicates 1 or more latitudes and longitudes such as (40.760784%2C-73.974504%7C40.749825%2C-73.987963)

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

origins
destinations
API EXAMPLE RESPONSE
JSON
{
   "destination_addresses" : 
   [
      "7 E 54th St, New York, NY 10022, USA",
      "34 St-Herald Sq, New York, NY 10001, USA"
   ],
   "origin_addresses" : 
   [
      "569 Vermont St, Brooklyn, NY 11207, USA"
   ],
   "rows" : 
   [
      {
         "elements" : 
         [
            {
               "distance" : 
               {
                  "text" : "28.4 km",
                  "value" : 28415
               },
               "duration" : 
               {
                  "text" : "42 mins",
                  "value" : 2493
               },
               "status" : "OK"
            },
            {
               "distance" : 
               {
                  "text" : "27.4 km",
                  "value" : 27384
               },
               "duration" : 
               {
                  "text" : "38 mins",
                  "value" : 2251
               },
               "status" : "OK"
            }
         ]
      }
   ],
   "status" : "OK"
}
Distance Calculator — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/5240/distances+calculation+api/6720/distance+calculator?origins=Required&destinations=Required' --header 'Authorization: Bearer YOUR_API_KEY' 


    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Distances Calculation API simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Overview

About the API: 

The Distances Calculation API allows users to calculate distances and travel times between a specified origin and one or more destinations. By entering an origin address along with one or more destination addresses, users can retrieve essential information related to their travel needs.

Upon making a request to the API, users receive a structured response with detailed information about each trip. The response includes a series of destination addresses and the single origin address provided. In this way, users can easily see where they are going from their point of departure.

The API generates a matrix of “rows”, where each element corresponds to the queried destinations. For each trip, users receive important metrics such as the distance to each destination, provided both in textual format (e.g., “28.4 km”) and as a numeric value (in meters) for computational use. This flexibility is ideal for applications that need to display the information in user-friendly formats or for backend calculations.

In addition, the API includes the estimated travel time for each route in both text and numeric formats. This helps users to plan their trip efficiently, as they can compare the time required to reach different destinations. The status field confirms the success of the request, ensuring that users receive accurate and reliable data.

In summary, the Distances Calculation API is a complete solution for calculating distances and durations between multiple origins and destinations, making it an indispensable tool for navigation, logistics and travel planning applications. Its ability to provide accurate data in an easy-to-understand format makes it an essential resource for developers and end users alike.

Distances Calculation API FAQs

To use this API, users must provide a source latitude and longitude, as well as one or more destination latitudes and longitudes.

There are different plans suits everyone including a free trial for small amount of requests, but it’s rate is limit to prevent abuse of the service.

This API receives one origin latitude and longitude, along with multiple destination coordinates, and provides travel distances and durations for each route.

The Distances Calculation API calculates travel distances and durations between specified origin and destination coordinates, providing essential data for navigation and planning.

Besides the number of API calls per month, there are no other limitations.

Each endpoint returns a structured response containing travel distances and durations between a specified origin and multiple destinations. The data includes distance and duration metrics for each route, along with the corresponding addresses.

Key fields in the response include "destination_addresses," "origin_addresses," "rows," and "elements." Each "element" contains "distance," "duration," and "status," providing detailed travel information for each destination.

The response data is organized into a matrix format. Each "row" corresponds to the origin, while "elements" within each row represent the distances and durations to each destination, allowing for easy comparison.

Users must specify an "origin" address and one or more "destination" addresses as parameters. These can be provided in textual format, allowing for flexibility in input.

Users can extract distance and duration values from the "elements" array for calculations or display. The textual format is useful for user interfaces, while numeric values facilitate backend processing.

Typical use cases include route planning for logistics, travel itinerary creation, and navigation applications. The API helps users determine the best routes based on distance and travel time.

Data accuracy is maintained through regular updates and quality checks from reliable mapping sources. This ensures that the distances and durations reflect current road conditions and routes.

If users receive partial or empty results, they should check the input parameters for accuracy. Ensure that the origin and destination addresses are valid and formatted correctly to avoid "NOT_FOUND" statuses.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs