Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Tracking_Search

Bound Search

get/skynet/search/bound

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

boundstring latitude_1,longitude_2|latitude_1,longitude_2 required
Example:bounds=44.7664,-0.6941|44.9206,-0.4639

Specify two, pipe (|) delimited location coordinates which would act as corners of the bounding box area to be searched. The first one should be the southwest coordinate of the bounds and the second one should be the northeast coordinate of the bounds.

filterstring filter=tag:value_1,value_2...
Example:filter=tag:delivery,truck

tags parameter will be deprecated soon! Please use the include_any_of_attributes or include_all_of_attributes parameters to match assets based on their labels or markers.

Use this parameter to filter the assets found inside the specified area by their tags. Multiple tags can be separated using commas (,).

Please note the tags are case sensitive.

psinteger

Denotes number of search results per page. Use this along with the pn parameter to implement pagination for your searched results.

pninteger

Denotes page number. Use this along with the ps parameter to implement pagination for your searched results. This parameter does not have a maximum limit but would return an empty response in case a higher value is provided when the result-set itself is smaller.

include_any_of_attributesstring key1:value1|key2:value2|...
Example:include_any_of_attributes=vehicle_type:pickup_truck|driver_name:John

Use this parameter to filter the assets found inside the specified area by their attributes. Assets having at least one of the attributes added to this parameter, will be returned in the search results. Multiple attributes can be separated using pipes (|).

Please note the attributes are case sensitive. Also, this parameter can not be used in conjunction with include_all_of_attributes parameter.

include_all_of_attributesstring key_1:value_1|key_2:value_2
Example:include_all_of_attributes=vehicle_type:pickup_truck|driver_name:John

Use this parameter to filter the assets found inside the specified area by their attributes. Only the assets having all the attributes that are added to this parameter, will be returned in the search results. Multiple attributes can be separated using pipes (|).

Please note the attributes are case sensitive. Also, this parameter can not be used in conjunction with include_any_of_attributes parameter.

max_search_limitboolean

When true, the maximum limit is 20Km for around search API and 48000 Km2 for other search methods.

sort_by'distance' | 'duration' | 'straight_distance'
Example:sort_by=duration

Specify the metric to sort the assets returned in the search result. The valid values are:

  • distance : Sorts the assets by driving distance to the given sort_destination .

  • duration : Sorts the assets by travel time to the given sort_destination .

  • straight_distance : Sort the assets by straight-line distance to the given sort-destination .

sort_driving_mode'car' | 'truck'

Specifies the driving mode to be used for determining travel duration or driving distance for sorting the assets in search result.

sort_destinationstring latitude,lontitude
Example:sort_destination= 34.0241,-118.2550

Specifies the location coordinates of the point which acts as destination for sorting the assets in the search results. The service will sort each asset based on the driving distance or travel time to this destination, from its current location. Use the sort_by parameter to configure the metric that should be used for sorting the assets. Please note that sort_destination is required when sort_by is provided.

Response

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.

messagestring

Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.