GEgeocod
distance-jobs

Create async distance matrix or one-to-one pairs job

Changed on
post/distance-jobs

Request

  • Base URL
    https://api.geocod.io/v2
  • URL
    https://api.geocod.io/v2/distance-jobs
  • Auth
    API key in query parameter api_key

Request body

namestring required
originsstring required
destinationsstring required
distance_mode'"driving"' | '"haversine"' | '"straightline"' nullable
calculation_type'"matrix"' | '"pairs"' nullable
units'"miles"' | '"km"' nullable
max_resultsinteger nullable
max_distancenumber nullable
max_durationinteger nullable
min_distancenumber nullable
min_durationinteger nullable
order_by'"distance"' | '"duration"' nullable
sort_order'"asc"' | '"desc"' nullable
fieldsstring nullable
callback_urlstring uri nullable

Response

Successful response

idinteger
identifierstring
statusstring
namestring
created_atstring
origins_countinteger
destinations_countinteger
calculation_typestring
total_calculationsinteger
_warningsstring[]

Non-fatal advisories about the request — an unrecognized parameter or field name, a superseded API version, or an append that was skipped. Present only when at least one warning was raised.

Changes

  • 05b3bef45842Revision changes
    • info

      added the optional property to the response with the status

  • 70b050988e01Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status