This API can provide estimated distance calculation data in miles, kilometers, nautical miles, and travel time between two cities, addresses, zip codes, location or places.

Getting Started

To begin using this API, follow these steps and make your first API call: **Subscribe to a plan:** Visit our Pricing page and subscribe to one of the plans. If you are just starting, you can subscribe to the free BASIC plan of the API (hard-limited and no credit card required). **Make your first API call:** Visit the RapidAPI Playground - the Product Search endpoint should be selected and displayed on the main panel view. Since there is already a default query parameter value, just click the blue "Test endpoint" button to make a your first API call. The JSON response will be displayed on the right panel. **Documentation and Resources:** Refer to the detailed endpoint, parameter descriptions, and examples provided in the Endpoints tab under each endpoint. Code snippets are available for all popular programming languages and environments, including - Javascript, Python, Java, Shell, and many others, to help you easily integrate the API into your project or workflow. You should be good to go now!

Authentication

To authenticate with the API, send the X-RapidAPI-Host header value along with the X-RapidAPI-Key header set with your RapidAPI App API Key (as shown in the endpoint Code Snippets).

Input Parameters

The following query parameters are supported by the API: origin (required)
Starting point for calculating the driving distance.
This can be a city name, full address, or geographic coordinates.
Example: New York City, NY destination (required)
Ending point for calculating the driving distance.
This can be a city name, full address, or geographic coordinates.
Example: Jersey City, Hudson County

Response Structure

Here’s an example of a successful response: ``` { "origin_location": "City of New York, New York, United States", "destination_location": "Jersey City, Hudson County, New Jersey, United States", "distance_in_miles": "4.1", "distance_in_kilometers": "6.6", "distance_in_nautical_miles": "3.5", "travel_time": "11 minutes, 58 seconds", "origin_latitude": "40.7127281", "origin_longitude": "-74.0060152", "destination_latitude": "40.7215682", "destination_longitude": "-74.047455" } ``` Please note that some errors might be returned by the RapidAPI gateway and will have a different structure. Please refer to the Error Handling / Error Response Structure section for more details. In addition, RapidAPI gateway adds several headers to each response, for more information, please refer to https://docs.rapidapi.com/docs/response-headers.

Endpoints

For detailed endpoint parameters and responses documentation and examples, and to try the API, please refer to the Endpoints section of the API.

Rate Limiting

Each subscription plan of the API defines the maximum number of requests permitted per month or the quota, in addition to a rate limit expressed in RPS (Requests Per Second). Please note that all free plans of the API (e.g. BASIC) are rate limited to 1000 requests per hour. This is a RapidAPI requirement for any free plan.

Rate Limits Headers

All API responses include rate limit information in the following headers: **x-ratelimit-requests-limit:** Number of requests the plan you are currently subscribed to allows you to make before incurring overages. **x-ratelimit-requests-remaining:** The number of requests remaining (from your plan) before you reach the limit of requests your application is allowed to make. When this reaches zero, you will begin experiencing overage charges. This will reset each day or each month, depending on how the API pricing plan is configured. You can view these limits and quotas on the pricing page of the API in the API Hub. **x-ratelimit-requests-reset:** Indicates the number of seconds until the quota resets. This number of seconds would at most be as long as either a day or a month, depending on how the plan was configured.

Handling Limits

When hitting the rate limits of the API, the RapidAPI gateway will return a 429 Too Many Requests error. When that happens, wait until your rate limit resets, or consider upgrading your subscription plan for a higher limit. We can support almost any monthly quota and rate limit, contact us for more information. Here’s an example of a 429 Too Many Requests error: ``` { "message":"Too many requests" } ```

Code Examples

Code examples are available for all popular programming languages and environments (Javascript, Python, Java, Shell, etc) on the Endpoints tab, on the right panel, under “Code Snippets”.

Common HTTP Status Codes

**400 Bad Request:** This status is returned when your request is malformed or missing some required parameters. The response body might also include a “message” field, explaining the specific error. Ensure that all required fields are included and properly formatted before retrying your request. **403 Forbidden:** This error indicates that you are not subscribed to the API or that your API key is invalid. If you believe this is in error, please contact RapidAPI support - support@rapidapi.com. **404 Not Found:** This status is returned if the requested resource could not be found. This can occur with incorrect URL endpoints. Double-check the URL and try again. **429 Too Many Requests:** This error means you have hit the rate limit for your subscription plan. Wait until your rate limit resets, or consider upgrading your subscription plan for a higher limit. If you believe this is in error, please contact us. **5XX Server Error (500, 502, and 503):** This indicates a problem with our servers processing your request or an internal server timeout. This is a rare occurrence and should be temporary. If this error persists, please contact our technical support for assistance.

Support

If you encounter any issues that you are unable to resolve, or if you need further clarification on the errors you are seeing, please do not hesitate to contact us (see the Contact Us section below). Provide us with the error code, message, and the context in which the error occurred, and we will assist you promptly.

Contact Us

For custom plans / high tier plans, custom services or any other subject, feel free to start a live chat on website mentioned below or send an email and we will try to get back to you shortly. **Email:** alreadycoded@gmail.com **Website:** https://www.alreadycoded.com