Expand description
Modules§
- tracking
- Realtime tracking client (binary WebSocket,
tracking.v2).
Structs§
- Address
Api - Address search service (
GET /v2/address/search). - ApiError
- Non-2xx public-api response (or transport failure after retries).
- Auth
Error - Auth failed (401 / 402 / 403 / refresh failed).
- Client
- Unified public-api client (geocoding, address, routing, devices).
- Client
Auth - Pair from
POST /v2/client-tokens(via your backend).expires_atis unix epoch milliseconds. - Config
- Configures the public-api client.
Provide exactly one of
api_key,client_auth, oraccess_token. - Conflict
Error - Conflict (409), e.g. device offline for command.
- Device
- Public-api device row.
- Device
Command Result POST /v2/devices/{uid}/commandresponse.- Device
Input - Create/update body.
- Device
List Query - Optional list filters.
- Device
List Result GET /v2/devicesresponse.- Devices
Api - Devices service (
/v2/devices*). - Geocoding
Api - Geocoding service (
/v2/geocode/*,/v2/address/lookup). - Invalid
Config Error - Invalid client configuration.
- NotFound
Error - Resource not found (404).
- Routing
Api - Routing service (Valhalla proxies under
/v2/route*). - Token
Pair - Response from
POST /v2/client-tokens.
Enums§
- Error
- SDK error type for the HTTP public API.
Constants§
- DEFAULT_
BASE_ URL - Default public API base URL.
- DEFAULT_
CONCURRENCY - Default parallel geocode batch requests.
- DEFAULT_
MAX_ RETRIES - Default max retries for 5xx / network errors.
- DEFAULT_
RETRY_ BASE - Default exponential backoff base.
- DEFAULT_
TIMEOUT - Default per-attempt timeout.
- MAX_
CONCURRENCY - Max parallel geocode batch requests.
- MIN_
RETRY_ BASE - Minimum retry base.
Functions§
- mint_
client_ tokens - Mint a client-token pair with a secret API key (server-side).
Pass empty
scopesto grant all client-tokenable permissions on the key. - query
- Helper to build a
Queryfrom string pairs.