HyperTrack

HyperTrack Nearby API

The Nearby API from HyperTrack — 2 operation(s) for nearby.

GitHub OpenAPI

Operations 3

GET /nearby/v4 Get all nearby searches performed
POST /nearby/v4 Get all nearby workers
POST /nearby/v3 Get all nearby drivers

Documentation

📖
Documentation
https://hypertrack.com/docs/introduction
📖
APIReference
https://hypertrack.com/reference/get-orders
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/authentication/hypertrack-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/openapi/hypertrack-nearby-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/errors/hypertrack-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/data-model/hypertrack-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/conventions/hypertrack-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/conventions/hypertrack-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/asyncapi/hypertrack-events-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/mcp/hypertrack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hypertrack-nearby-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hypertrack-nearby-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HyperTrack Nearby API
  version: '1.0'
  description: HyperTrack API Reference — Orders, Workers, Places, Routes, and more.
  contact:
    name: HyperTrack support
    url: https://hypertrack.com/contact
    email: help@hypertrack.com
servers:
- url: https://v3.api.hypertrack.com
tags:
- name: Nearby
paths:
  /nearby/v4:
    get:
      parameters:
      - in: query
        name: pagination_token
        description: Identifier used to fetch the next page of data
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: request_id
        description: Unique id of a nearby search request.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: search_type
        description: Type of nearby search. 'eta' for finding estimates of nearby workers, 'region' for finding nearby workers.
        schema:
          type:
          - string
          - 'null'
          enum:
          - eta
          - region
        required: false
      - in: query
        name: order_handle
        description: Order handle used to search nearby workers for. This can later be used for tracking and associate nearby requests with corresponding orders.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: place_handle
        description: Place handle used to search nearby workers for. This can later be used for tracking and associate nearby requests with corresponding places.
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: from_date
        description: 'Start date of the search in yyyy-mm-dd format. default: 3 days ago utc date'
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: to_date
        description: 'End date of the search in yyyy-mm-dd format. default: todays utc date'
        schema:
          type:
          - string
          - 'null'
        required: false
      - in: query
        name: limit
        description: Maximum number of items to return. If not provided, it will default to 100.
        schema:
          type:
          - integer
          - 'null'
          default: 100
          maximum: 100
        required: false
      - in: query
        name: aggregate
        description: If true, the response will be aggregated by date and search type. If false, the response will be returned as is.
        schema:
          type:
          - boolean
          - 'null'
          default: false
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NearbySearchListResponse'
              examples:
                nearby_workers_response_example:
                  summary: Nearby API request response example. This is the list of workers which are ranked based on their distance from the location of interest (nearest first).
                  value:
                    drivers:
                    - device:
                        device_id: 00112233-2F48-4DA1-ACEA-8A8D530670CF
                        info:
                          timezone: America/Los Angeles
                          os_name: iOS
                          device_brand: Apple
                          sdk_version: func test app
                          device_model: IPhone X
                          network_operator: T-Mobile
                          name: Func Test Device
                          os_version: 12.1.4
                          os_hardware_identifier: 719bef31-e487-46e0-86f1-5f32589fd9eb
                        profile:
                          gig_type: ridesharing
                        status:
                          value: active
                          data:
                            activity: drive
                            recorded_at: 2022-06-30 13:35:14.806000+00:00
                      location:
                        coordinates:
                        - -122.3999933082254
                        - 37.793651385106074
                        type: Point
                      duration: null
                      distance: 9303
                      ongoing_trip: null
                      error: null
                    summary:
                      total_drivers: 1
                      processed_drivers: 1
                      unprocessed_drivers: 0
                      outside_region_drivers: 0
                      no_route_drivers: 0
          description: Successful response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Authentication error
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: Validation error
      tags:
      - Nearby
      summary: Get all nearby searches performed
      description: This API returns a list of all nearby searches performed. The response includes the search parameters, the results of the search. The API is useful for tracking the history of nearby searches and for debugging purposes. The API returns a paginated list of nearby searches, with the ability to filter by date range and search parameters.
      security:
      - BasicAuth: []
      - TokenAuth: []
    post:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NearbyResponse'
              examples:
                nearby_workers_response_example:
                  summary: Nearby API request response example. This is the list of workers which are ranked based on their distance from the location of interest (nearest first).
                  value:
                    request_id: 00000000-aaaa-bbbb-cccc-111122223333
                    summary:
                      no_route_workers: 0
                      outside_region_workers: 0
                      processed_workers: 2
                      total_workers: 2
                      unprocessed_workers: 0
                    workers:
                    - created_at: 2024-10-10 10:10:10
                      device:
                        device_id: AAA11111-BBBB-2222-CCCC-3333DDDD4444
                        info:
                          device_brand: Apple
                          device_model: iPad9,3
                          name: worker001
                          network_operator: CarrierX
                          os_name: iOS
                          os_version: 16.3.0
                          sdk_version: 5.11.0+abcd1234
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker001
                        status:
                          data:
                            activity: idle
                            recorded_at: 2025-05-16 08:00:00+00:00
                          value: active
                      distance: 8276.293463598915
                      location:
                        coordinates:
                        - -89.079472
                        - 42.264265
                        type: Point
                      name: worker001
                      ops_group_handle: default
                      profile:
                        driver_handle: worker001
                      timezone: America/Chicago
                      work_status:
                        available: true
                        tracking: true
                      worker_handle: worker001
                    - created_at: 2025-01-15 14:30:00
                      device:
                        device_id: BBB22222-CCCC-3333-DDDD-4444EEEE5555
                        info:
                          device_brand: Apple
                          device_model: iPhone13,2
                          name: worker002
                          network_operator: CarrierY
                          os_name: iOS
                          os_version: 17.0.1
                          sdk_version: 5.11.0+abcd1234
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker002
                        status:
                          data:
                            reason: manual_shutdown
                            recorded_at: 2025-05-16 08:15:00+00:00
                          value: inactive
                      distance: 8373.143574586262
                      location:
                        coordinates:
                        - -89.080647
                        - 42.264208
                        type: Point
                      name: worker002
                      ops_group_handle: default
                      profile:
                        driver_handle: worker002
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: false
                      worker_handle: worker002
                filtered_nearby_workers_response_example:
                  summary: Nearby API request response example filtered by profile/search criteria. This is the list of workers which are ranked based on their distance from the location of interest (nearest first) and matching the specified criteria.
                  value:
                    request_id: 00000000-aaaa-bbbb-cccc-111122223344
                    summary:
                      no_route_workers: 0
                      outside_region_workers: 0
                      processed_workers: 1
                      total_workers: 1
                      unprocessed_workers: 0
                    workers:
                    - created_at: 2024-10-10 10:10:10
                      device:
                        device_id: AAA11111-BBBB-2222-CCCC-3333DDDD4444
                        info:
                          device_brand: Apple
                          device_model: iPad9,3
                          name: worker001
                          network_operator: CarrierX
                          os_name: iOS
                          os_version: 16.3.0
                          sdk_version: 5.11.0+abcd1234
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker001
                        status:
                          data:
                            activity: idle
                            recorded_at: 2025-05-16 08:00:00+00:00
                          value: active
                      distance: 8276.293463598915
                      location:
                        coordinates:
                        - -89.079472
                        - 42.264265
                        type: Point
                      name: worker001
                      ops_group_handle: default
                      profile:
                        driver_handle: worker001
                      timezone: America/Chicago
                      work_status:
                        available: true
                        tracking: true
                      worker_handle: worker001
                eta_workers_response_example:
                  summary: Nearby API request response example for getting ETA of a list of workers. This is the list of workers which are ranked based on their drive duration from the location of interest (nearest first).
                  value:
                    request_id: 9b47006e-34de-450d-8681-50fa2c519a79
                    summary:
                      no_route_workers: 0
                      outside_region_workers: 0
                      processed_workers: 2
                      total_workers: 2
                      unprocessed_workers: 0
                    workers:
                    - created_at: 2024-07-09 20:10:10.442000
                      device:
                        device_id: DEVICE-001
                        info:
                          device_brand: Apple
                          device_model: iPhone15,4
                          name: worker_alpha
                          network_operator: --
                          os_name: iOS
                          os_version: 18.4.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker_alpha
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 08:30:45.224000+00:00
                          value: active
                      distance: 2696
                      duration: 236
                      location:
                        coordinates:
                        - -88.997979
                        - 42.262501
                        type: Point
                      name: worker_alpha
                      ops_group_handle: default
                      profile:
                        driver_handle: worker_alpha
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: worker_alpha
                    - created_at: 2024-07-09 18:52:01.346000
                      device:
                        device_id: DEVICE-002
                        info:
                          device_brand: samsung
                          device_model: SM-S908U1
                          name: worker_bravo
                          network_operator: AT&T
                          os_name: Android
                          os_version: '14'
                          sdk_version: 7.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker_bravo
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 08:39:29.562000+00:00
                          value: active
                      distance: 120822
                      duration: 4530
                      location:
                        coordinates:
                        - -87.682951
                        - 41.994821
                        type: Point
                      name: worker_bravo
                      ops_group_handle: default
                      profile:
                        driver_handle: worker_bravo
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: worker_bravo
                eta_nearby_workers_response_example:
                  summary: Nearby API request response example for getting ETA of nearby workers. This is the list of workers which are ranked based on their drive duration from the location of interest (nearest first).
                  value:
                    request_id: b8aeafa1-4024-4e3e-957d-9e77f113ec27
                    summary:
                      no_route_workers: 0
                      outside_region_workers: 0
                      processed_workers: 8
                      total_workers: 10
                      unprocessed_workers: 2
                    workers:
                    - created_at: 2024-07-09 20:10:10.442000
                      device:
                        device_id: UPDATED-DEVICE-ID-0
                        info:
                          device_brand: Apple
                          device_model: iPhone15,4
                          name: updated_name_0
                          network_operator: --
                          os_name: iOS
                          os_version: 18.4.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_0
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 07:07:17.222000+00:00
                          value: active
                      distance: 2696
                      duration: 292
                      location:
                        coordinates:
                        - -88.998123
                        - 42.262075
                        type: Point
                      name: updated_name_0
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_0
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_0
                    - created_at: 2024-11-29 17:25:37.284000
                      device:
                        device_id: UPDATED-DEVICE-ID-1
                        info:
                          device_brand: Apple
                          device_model: iPad7,12
                          name: updated_name_1
                          network_operator: --
                          os_name: iOS
                          os_version: 17.5.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_1
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 07:37:54.821000+00:00
                          value: active
                      distance: 9171
                      duration: 720
                      location:
                        coordinates:
                        - -89.07944
                        - 42.264295
                        type: Point
                      name: updated_name_1
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_1
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_1
                    - created_at: 2024-07-09 18:14:30.061000
                      device:
                        device_id: UPDATED-DEVICE-ID-2
                        info:
                          device_brand: Apple
                          device_model: iPhone12,1
                          name: updated_name_2
                          network_operator: Visible
                          os_name: iOS
                          os_version: 15.6.0
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_2
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 07:01:10.609000+00:00
                          value: active
                      distance: 68362
                      duration: 2495
                      location:
                        coordinates:
                        - -88.324998
                        - 42.034393
                        type: Point
                      name: updated_name_2
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_2
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_2
                    - created_at: 2024-07-10 11:17:42.495000
                      device:
                        device_id: UPDATED-DEVICE-ID-3
                        info:
                          device_brand: alps
                          device_model: S24 Ultra
                          name: updated_name_3
                          network_operator: T-Mobile
                          os_name: Android
                          os_version: '10'
                          sdk_version: 7.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_3
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 06:48:11.753000+00:00
                          value: active
                      distance: 120827
                      duration: 4443
                      location:
                        coordinates:
                        - -87.692175
                        - 42.011515
                        type: Point
                      name: updated_name_3
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_3
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_3
                    - created_at: 2025-04-01 12:38:41.792000
                      device:
                        device_id: UPDATED-DEVICE-ID-4
                        info:
                          device_brand: Apple
                          device_model: iPhone13,2
                          name: updated_name_4
                          network_operator: --
                          os_name: iOS
                          os_version: 18.3.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_4
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 06:54:49.891000+00:00
                          value: active
                      distance: 138605
                      duration: 4657
                      location:
                        coordinates:
                        - -87.938059
                        - 42.986098
                        type: Point
                      name: updated_name_4
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_4
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_4
                    - created_at: 2025-04-13 17:47:52.864000
                      device:
                        device_id: UPDATED-DEVICE-ID-5
                        info:
                          device_brand: Apple
                          device_model: iPhone17,4
                          name: updated_name_5
                          network_operator: --
                          os_name: iOS
                          os_version: 18.4.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_5
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 05:49:38.493000+00:00
                          value: active
                      distance: 143584
                      duration: 4717
                      location:
                        coordinates:
                        - -87.959918
                        - 43.041797
                        type: Point
                      name: updated_name_5
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_5
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_5
                    - created_at: 2024-08-24 02:26:26.748000
                      device:
                        device_id: UPDATED-DEVICE-ID-6
                        info:
                          device_brand: Apple
                          device_model: iPhone14,6
                          name: updated_name_6
                          network_operator: --
                          os_name: iOS
                          os_version: 18.3.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_6
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 06:45:27.962000+00:00
                          value: active
                      distance: 152366
                      duration: 4944
                      location:
                        coordinates:
                        - -87.917558
                        - 43.087834
                        type: Point
                      name: updated_name_6
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_6
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_6
                    - created_at: 2024-07-09 19:34:53.727000
                      device:
                        device_id: UPDATED-DEVICE-ID-7
                        info:
                          device_brand: Apple
                          device_model: iPhone17,4
                          name: updated_name_7
                          network_operator: --
                          os_name: iOS
                          os_version: 18.4.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: updated_driver_handle_7
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 07:36:30.426000+00:00
                          value: active
                      distance: 146902
                      duration: 5002
                      location:
                        coordinates:
                        - -87.815815
                        - 41.676121
                        type: Point
                      name: updated_name_7
                      ops_group_handle: default
                      profile:
                        driver_handle: updated_driver_handle_7
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: updated_worker_handle_7
                nearby_order_handle_workers_response_example:
                  summary: Nearby API request response example. This is the list of workers which are ranked based on their distance from the destination of an order_handle.
                  value:
                    request_id: 9b47006e-34de-450d-8681-50fa2c519a79
                    summary:
                      no_route_workers: 0
                      outside_region_workers: 0
                      processed_workers: 2
                      total_workers: 2
                      unprocessed_workers: 0
                    workers:
                    - created_at: 2024-07-09 20:10:10.442000
                      device:
                        device_id: DEVICE-001
                        info:
                          device_brand: Apple
                          device_model: iPhone15,4
                          name: worker_alpha
                          network_operator: --
                          os_name: iOS
                          os_version: 18.4.1
                          sdk_version: 5.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker_alpha
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 08:30:45.224000+00:00
                          value: active
                      distance: 2696
                      duration: 236
                      location:
                        coordinates:
                        - -88.997979
                        - 42.262501
                        type: Point
                      name: worker_alpha
                      ops_group_handle: default
                      profile:
                        driver_handle: worker_alpha
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: worker_alpha
                    - created_at: 2024-07-09 18:52:01.346000
                      device:
                        device_id: DEVICE-002
                        info:
                          device_brand: samsung
                          device_model: SM-S908U1
                          name: worker_bravo
                          network_operator: AT&T
                          os_name: Android
                          os_version: '14'
                          sdk_version: 7.11.0+74d1fabf
                          timezone: America/Chicago
                        profile:
                          driver_handle: worker_bravo
                        status:
                          data:
                            activity: unknown
                            recorded_at: 2025-05-16 08:39:29.562000+00:00
                          value: active
                      distance: 120822
                      duration: 4530
                      location:
                        coordinates:
                        - -87.682951
                        - 41.994821
                        type: Point
                      name: worker_bravo
                      ops_group_handle: default
                      profile:
                        driver_handle: worker_bravo
                      timezone: America/Chicago
                      work_status:
                        available: false
                        tracking: true
                      worker_handle: worker_bravo
                nearby_place_handle_workers_response_example:
                  summary: Nearby API request response example. This is the list of workers which are ranked based on their distance from a place_handle
                  value:
                    request_id: 9b47006e-34de-450d-8681-50fa2c519a79
                    summary:
                      no_route_workers: 0
                      outside_region_workers: 0
                      processed_workers: 2
                      total_workers: 2
                      unprocessed_workers: 0
                    workers:
                    - created_at: 2024-07-09 20:10:10.442000
                      device:
                        device_id: DEVICE-001
                        info:
                          device_brand: Apple
                          device_model: iPhone15,4
                          name: worker_alpha
                          network_operator: --
                          os_name: iOS
                       

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hypertrack/refs/heads/main/openapi/hypertrack-nearby-api-openapi.yml