List near
Answers which units can reach a site soonest.
GET /v1/patrol/unit/near
| Address | https://api.hanzo.ai/v1/patrol/unit/near |
| Method | GET |
| Operation | get_patrol_unit_near |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Answers which units can reach a site soonest. Distance is a great-circle haversine over the units' last reported positions, and an available unit sorts ahead of a busy one at any distance — a controller asking for the nearest unit is asking for the nearest free one.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
site | query | string | — | Site is the site to measure from, by document name. |
limit | query | integer | — | Limit caps how many units come back. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | patrol.patrolNearList | ok |
default | problem-details | refused |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolNearest[] | — | Data is the closest units, available ones first and then by distance. |
data[].eta | body | integer (int64) | — | Eta is the minutes the drive would take at the planning speed. |
data[].km | body | number (double) | — | Km is the great-circle distance to the site in kilometres. |
data[].unit | body | string | — | Unit is the unit's call sign. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol unit nearimport { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolUnitNear();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).get_patrol_unit_near()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.GetPatrolUnitNear(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, patrol_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = patrol_api::get_patrol_unit_near(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new PatrolApi(client).getPatrolUnitNear();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/patrol/unit/near \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?