1. Matrix With Traffic

Curl request

$ curl 'https://utils.limosys.net/geo/matrix?key=YOUR_GEO_API_KEY&origin=VALID_ORIGIN_1&destinations=VALID_DESTINATION_1&traffic=yes' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json'

HTTP request

GET /geo/matrix?key=YOUR_GEO_API_KEY&origin=VALID_ORIGIN_1&destinations=VALID_DESTINATION_1&traffic=yes HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: utils.limosys.net

HTTP response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: origin, content-type, accept, authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Set-Cookie
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 196

{"matrix":[{"dist_meters":5000,"dist":3.1068559611866697,"time":5,"timeSeconds":300,"src":"LOCAL","brackets":[4,7],"lat1":25.5,"lon1":-25.5,"lat2":25.5,"lon2":-25.5}],"traffic":true,"status":"OK"}

HTTPie request

$ http GET 'https://utils.limosys.net/geo/matrix?key=YOUR_GEO_API_KEY&origin=VALID_ORIGIN_1&destinations=VALID_DESTINATION_1&traffic=yes' \
    'Content-Type:application/json;charset=UTF-8' \
    'Accept:application/json'

Request body

Request parameters

Parameter Description

key

Limosys API Key

origin

Origin list, semi colon separated

destinations

Destinations list, semi colon separated

traffic

Use traffic - 'yes' or 'no'

highways

Select 'no' to Avoid highways

trafficModel

Traffic model to use - 'optimistic', 'pessimistic', 'best_guess'

fetch

If 'yes' then thirdparty is prioritized

useOneYearHack

Use one year hack where applicable

usedFor

What is result used for - code (e.g. "BID") - for logging purposes

adjustment

[For Testing] Use prediction for result and brackets - default "yes"

cache

Use cache if available - default "yes"

Response body

{"matrix":[{"dist_meters":5000,"dist":3.1068559611866697,"time":5,"timeSeconds":300,"src":"LOCAL","brackets":[4,7],"lat1":25.5,"lon1":-25.5,"lat2":25.5,"lon2":-25.5}],"traffic":true,"status":"OK"}

Response fields

Path Type Description

matrix

Array

Distance matrix results

traffic

Boolean

Whether traffic was used

oneYearHack

Boolean

Used oneYearHack param - boolean

status

String

OK or ERROR for whole result

matrix[].dist

Number

Distance in miles

matrix[].time

Number

Time in minutes

matrix[].timeSeconds

Number

Time in seconds

matrix[].src

String

Source of data (provider)

matrix[].algorithm

String

Algorithm used for ETA

matrix[].traffic

String

Traffic mode

matrix[].cache

String

Result CACHED or NEW

matrix[].dist_meters

Number

Distance in meters

matrix[].brackets

class [I

Estimated data from X to Y minutes

matrix[].status

String

Blank if OK, ERROR if single item failed

matrix[].lat1

Number

Origin Latitude coordinate used

matrix[].lon1

Number

Origin Longitude coordinate used

matrix[].lat2

Number

Destination Latitude coordinate used

matrix[].lon2

Number

Destination Longitude coordinate used

matrix[].location1

String

Origin location string if available (Optional)

matrix[].location2

String

Destination location string if available (Optional)

2. Matrix No Traffic

Curl request

$ curl 'https://utils.limosys.net/geo/matrix?key=YOUR_GEO_API_KEY&origin=VALID_ORIGIN_1&destinations=VALID_DESTINATION_1' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json'

HTTP request

GET /geo/matrix?key=YOUR_GEO_API_KEY&origin=VALID_ORIGIN_1&destinations=VALID_DESTINATION_1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: utils.limosys.net

HTTP response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: origin, content-type, accept, authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Set-Cookie
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 197

{"matrix":[{"dist_meters":5000,"dist":3.1068559611866697,"time":5,"timeSeconds":300,"src":"LOCAL","brackets":[4,7],"lat1":25.5,"lon1":-25.5,"lat2":25.5,"lon2":-25.5}],"traffic":false,"status":"OK"}

HTTPie request

$ http GET 'https://utils.limosys.net/geo/matrix?key=YOUR_GEO_API_KEY&origin=VALID_ORIGIN_1&destinations=VALID_DESTINATION_1' \
    'Content-Type:application/json;charset=UTF-8' \
    'Accept:application/json'

Request body

Request parameters

Parameter Description

key

Limosys API Key

origin

Origin list, semi colon separated

destinations

Destinations list, semi colon separated

traffic

Use traffic - 'yes' or 'no'

highways

Select 'no' to Avoid highways

trafficModel

Traffic model to use - 'optimistic', 'pessimistic', 'best_guess'

fetch

If 'yes' then thirdparty is prioritized

useOneYearHack

Use one year hack where applicable

usedFor

What is result used for - code (e.g. "BID") - for logging purposes

adjustment

[For Testing] Use prediction for result and brackets - default "yes"

cache

Use cache if available - default "yes"

Response body

{"matrix":[{"dist_meters":5000,"dist":3.1068559611866697,"time":5,"timeSeconds":300,"src":"LOCAL","brackets":[4,7],"lat1":25.5,"lon1":-25.5,"lat2":25.5,"lon2":-25.5}],"traffic":false,"status":"OK"}

Response fields

Path Type Description

matrix

Array

Distance matrix results

traffic

Boolean

Whether traffic was used

oneYearHack

Boolean

Used oneYearHack param - boolean

status

String

OK or ERROR for whole result

matrix[].dist

Number

Distance in miles

matrix[].time

Number

Time in minutes

matrix[].timeSeconds

Number

Time in seconds

matrix[].src

String

Source of data (provider)

matrix[].algorithm

String

Algorithm used for ETA

matrix[].traffic

String

Traffic mode

matrix[].cache

String

Result CACHED or NEW

matrix[].dist_meters

Number

Distance in meters

matrix[].brackets

class [I

Estimated data from X to Y minutes

matrix[].status

String

Blank if OK, ERROR if single item failed

matrix[].lat1

Number

Origin Latitude coordinate used

matrix[].lon1

Number

Origin Longitude coordinate used

matrix[].lat2

Number

Destination Latitude coordinate used

matrix[].lon2

Number

Destination Longitude coordinate used

matrix[].location1

String

Origin location string if available (Optional)

matrix[].location2

String

Destination location string if available (Optional)