Sign in

v1

latestOpenAPI 3.1.22026-08-063221.7 KB
Distance Retriever

Get distance in batch

Submit a batch request to find the distance and general drive time between two points.

post/getDistance

Headers

Accept'application/json' | '*/*' required

Format of the response.

Content-Type'application/json' | 'application/xml' required

Format of the request.

Request body

CustomerIDstring required

Required. The License Key issued by Melissa.

Optionsstring

Options - List options in the following format, with multiple options delimited with a ,. For example: optionName:parameter,optionName:parameter. These options are case-sensitive and camel case.

  • arriveAt:< yyyy-mm-ddThh:mm:ss.mmmZ > - Specify the arrival time ISO 8601 UTC.

  • avoid:< borderCrossings | ferries | tollRoads | tunnels | unpavedRoads > - Specify the types of transport obstacles to avoid.

  • departAt:< yyyy-mm-ddThh:mm:ss.mmmZ | now > - Specify the departure date and time in ISO 8601 UTC. Default is now - departs immediately.

  • routeType:< eco | fastest | shortest | thrilling > - Specify the type of route.

    • eco - Balances travel time and fuel efficiency.
    • fastest - Optimizes for fastest travel time.
    • shortest - Optimizes for shortest travel distance.
    • thrilling - Optimized for challenging, hilly, or winding routes.

  • traffic:< false | true > - Considers current traffic conditions. Default is true.

  • travelMode:< bicycle | car | pedestrian > - Specify the type of vehicle used for the travel mode. Default is car.

  • vehicleCommercial:< false | true > - Indicates if the vehicle is a commercial vehicle. Default is false.

  • vehicleHeight:< [float] | 0 > - Specifies the vehicle height in meters. There are no height restrictions. Default is 0.

  • vehicleLength:< [float] | 0 > - Specifies the vehicle length in meters. Default is 0.

  • vehicleMaxSpeed:< [integer] | 0 > - Specifies the maximum vehicle speed in km/hr. Default is 0.

  • vehicleWeight:< [integer] | 0 > - Specifies the vehicle weight in kilograms. Minimum value is 1.

TransmissionReferencestring

Transmission Reference - Serves as a unique request identifier. It is returned as sent.

Units'mi' | 'km'

Units - This specifies the returned distance unit scale. Use mi for miles and km for kilometers.

Example request

{
  "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
  "Options": "avoid:tunnels,routeType:shortest",
  "TransmissionReference": "Test",
  "Units": "mi"
}

Response

Default response from a POST request

Versionstring

The current service version number.

Unitsstring

This is a string value that is the set unit of measurement for the TotalDrivingDistance field.

TransmissionReferencestring

A pass-through of the input TransmissionReference field.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Street Route Result Codes.

TotalRecordsstring

Total number of records.