---
title: "Bound Search"
method: GET
path: "/skynet/search/bound"
tags: ["Tracking_Search"]
---

# Bound Search

`GET /skynet/search/bound`

## Query parameters

- `key` string, 32 character alphanumeric string, required
- `bound` string, latitude_1,longitude_2|latitude_1,longitude_2, required
- `filter` string, filter=tag:value_1,value_2...
- `ps` integer
- `pn` integer
- `include_any_of_attributes` string, key1:value1|key2:value2|...
- `include_all_of_attributes` string, key_1:value_1|key_2:value_2
- `max_search_limit` boolean — When true, the maximum limit is 20Km for around search API and 48000 Km2 for other search methods.
- `sort_by` 'distance' | 'duration' | 'straight_distance'
- `sort_driving_mode` 'car' | 'truck'
- `sort_destination` string, latitude,lontitude

## Response `200`

- SearchResponse
  - `status` string — 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](#api-error-codes) section below for more information.
  - `message` string — Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.
  - `data` object — A data object containing the search result.
    - `assets` AssetSearchResult[] — An array of objects with details of the asset(s) returned in the search result. Each object represents one asset
      - `id` string — ID of asset which was last located inside the specified area in the input request. This is the same ID that was generated/provided at the time of creating the asset.
      - `name` string — Name of asset. The value would be the same as that provided for the name parameter at the time of creating or updating the asset.
      - `description` string — Description of the asset. The value would be the same as that provided for the description parameter at the time of creating or updating the asset.
      - `latest_location` DtoTrackLocation — An object with details of the tracked location. Please note that if there are no tracking records for an asset, no location data will be returned.
        - `accuracy` number — If available, this property returns the accuracy of the GPS information received at the tracked location. It is represented as an estimated horizontal accuracy radius, in meters, at the 68th percentile confidence level.
        - `altitude` number — If available in the GPS information, this property returns the altitude of the asset at the tracked location. It is represented as height, in meters, above the WGS84 reference ellipsoid.
        - `bearing` number — If available in the GPS information, this property returns the heading of the asset calculated from true north in clockwise direction at the tracked location. Please note that the bearing is not affected by the device orientation. The bearing will always be in the range of [0, 360).
        - `location` object — An object with the coordinates of the last tracked location.
          - `lat` number — Latitude of the tracked location of the asset.
          - `lon` number — Longitude of the tracked location of the asset.
        - `meta_data` TrackMetaDataSkynet — Specifies the custom data about the location that was added when the location was uploaded.
        - `speed` number — If available in the GPS information, this property returns the speed of the asset, in meters per second, at the tracked location.
        - `timestamp` integer — A UNIX epoch timestamp in milliseconds, representing the time at which the location was tracked.
        - `battery_level` integer — Returns the battery level of the GPS device, as a percentage, when the location was tracked. It has a minimum value of 0 and a maximum value of 100.
        - `tracking_mode` string — Internal parameter for tracking mode.
      - `meta_data` MetaData — Any valid json object data. Can be used to save customized data. Max size is 65kb.
      - `created_at` integer — A UNIX timestamp in seconds representing the time at which the asset was created.
      - `updated_at` integer — A UNIX timestamp in seconds representing the time at which the asset was last updated.
      - `tracked_at` integer — A UNIX epoch timestamp in seconds representing the last time when the asset was tracked.
      - `ranking_info` RankingInfo — An object returning the sorting details of the asset as per the configuration specified in the input.
        - `index` integer — Index of the ranked asset. The index value starts from 0.
        - `distance` number — Driving distance between the asset and the sort_destination.
        - `duration` number — Driving duration between the asset and the sort_destination. Please note this field in not returned in the response when sort_by = straight_distance .
      - `tags` string[] — **This parameter will be deprecated soon! Please move existing tags to attributes parameter.** Tags associated with the asset.
    - `page` DtoPagination — An object with pagination details of the search results. Use this object to implement pagination in your application.
      - `total` integer — An integer value indicating the total number of items available in the data set. This parameter can be used to calculate the total number of pages available.
      - `page` integer — An integer value indicating the current page number (starting at 0).
      - `size` integer — An integer value indicating the maximum number of items retrieved per page.
      - `hasmore` boolean — A boolean value indicating whether there are more items available beyond the current page.

---

[API](https://skmtc.net/nextbillion-ai/apis/one-spec-service.md) · [All operations](https://skmtc.net/nextbillion-ai/apis/one-spec-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextbillion-ai/one-spec-service/versions/b647f1808dda/schema)
