GPS Utilities API v1.0

Calculate Distances (Each From Start)

This endpoint requires a Start Coordinate which is then used to measure the distance between it, and each of the GPS coordinates provided in the List of coordinates.

The Response gives back each of the coordinates together with the distance measured from the start coordinate and that particular coordinate, as well as, the total distance accummulated as it processes the coordinate List. You can elect to have the distance and total objects returned with all supported units of measurement.

The calculation uses the geodetic distance which takes into account the curvature of the earth. This is a 2d calculation which does not take elevation into consideration.

Marketplace: RapidAPI URL to this EndPoint

Authentication: Please see the requirements on the RapidAPI Portal.

Complete GPS Utils Endpoint List

Endpoint URL

POST [RapidAPI Base URL]/v1/distances-efs

Parameters

Parameter Required Description Data Type
startCoord.latitude Yes Starting coordinate latitude. Number (float)
startCoord.longitude Yes Starting coordinate longitude. Number (float)
coordinates Yes Array of coordinate objects. At least one object must be provided.
The item count is limited by the plan that is subscribed to on RapidAPI.		 Array of Objects
coordinates[].latitude Yes Latitude of a coordinate in the array. Number (float)
coordinates[].longitude Yes Longitude of a coordinate in the array. Number (float)
unit No Unit of measurement. Options: meters, miles, feet, km, nm, all. Default: meters. One can only request all of the units or one of the valid options. String
fmt No Format of returned data, Options: json (more coming soon). Default: json String
dec No Number of decimal places to use on the measurements. Options 0 to 6 Default: 5 Integer

POST [RapidAPI Base URL]/v1/distances-efs

Headers:

Please see the RapidAPI documentation

Body:


    {
        "startCoord": {
            "latitude": -33.991838,
            "longitude": 22.7369
        },
        "coordinates": [
        {
            "latitude": -33.988444,
            "longitude": 22.749813
        },
        {
            "latitude": -34.005652,
            "longitude": 22.758734
        }
        ],
        "unit": "meters",
        "fmt": "json",
        "dec": 5
    }
                                                


    {
        "startCoord": {
            "latitude": -33.991838,
            "longitude": 22.7369
        },
        "coordinates": [
            {
                "latitude": -33.988444,
                "longitude": 22.749813,
                "distance": {
                    "meters": 1251.08886
                },
                "total": {
                    "meters": 1251.08886
                }
            },
            {
                "latitude": -34.005652,
                "longitude": 22.758734,
                "distance": {
                    "meters": 2533.14377
                },
                "total": {
                    "meters": 3784.23263
                }
            }
        ],
        "unit": "meters"
    }
Or, with the "unit": "all" parameter:- 

    {
        "startCoord": {
            "latitude": -33.991838,
            "longitude": 22.7369
        },
        "coordinates": [
            {
                "latitude": -33.988444,
                "longitude": 22.749813,
                "distance": {
                    "meters": 1251.08886,
                    "kilometers": 1.25109,
                    "nautical": 0.67553,
                    "miles": 0.77756,
                    "feet": 4104.62238
                },
                "total": {
                    "meters": 1251.08886,
                    "kilometers": 1.25109,
                    "nautical": 0.67553,
                    "miles": 0.77756,
                    "feet": 4104.62238
                }
            },
            {
                "latitude": -34.005652,
                "longitude": 22.758734,
                "distance": {
                    "meters": 2533.14377,
                    "kilometers": 2.53314,
                    "nautical": 1.36779,
                    "miles": 1.57436,
                    "feet": 8310.83941
                },
                "total": {
                    "meters": 3784.23263,
                    "kilometers": 3.78423,
                    "nautical": 2.04332,
                    "miles": 2.35192,
                    "feet": 12415.46178
                }
            }
        ],
        "unit": "all"
      }