Radar

Delete a beacon via DELETE /v1/beacons/{id}. Deletes a beacon. The beacon can be uniquely referenced by Radar `_id` or by `tag` and `externalId`. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Delete a geofence via DELETE /v1/geofences/{id}. Deletes a geofence. The geofence can be uniquely referenced by Radar `_id` or by `tag` and `externalId`.

Delete a geofence (by tag and externalId) via DELETE /v1/geofences/{tag}/{externalId}. Deletes a geofence. The geofence can be uniquely referenced by Radar `_id` or by `tag` and `externalId`.

Delete a trip via DELETE /v1/trips/{id}. Deletes a trip. The trip can be referenced by Radar `_id` or `externalId`.

Delete a user via DELETE /v1/users/{id}. Deletes a user. The user can be referenced by Radar `_id`, `userId`, or `deviceId`.

Validate an address via GET /v1/addresses/validate. Validates an address. Currently only available for US and Canada addresses for enterprise customers. This endpoint is best for validating complete structured addresses. For partial addresses or place names, call the [autocomplete](https://docs.radar.com/api#autocomplete) endpoint instead. Returns a `verificationStatus` as part of the `result`, as defined below: * `verified`: The input has a complete and unique match with a result. * `partially verified`: The input has a partial match with a result. * `ambiguous`: The input closely matches multiple results. * `unverified`: Unable to verify the input address. Returns a `recordType` value in the `metadata` field as part of the `result`, values are defined below according to USPS standards: * `S`: Street Address * `P`: Post Office Box * `R`: Rural Route * `H`: High-rise * `F`: Firm * `G`: General Delivery On US addresses, an `analysis` field may be returned, which contains the following fields: * `unit:missing`: Radar detected units at the address, but no unit was specified. * `unit:invalid`: Radar detected units at the address, but the unit specified doesn't exist. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

List beacons via GET /v1/beacons. Lists beacons. Beacons are sorted descending by `createdAt`. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Get a beacon via GET /v1/beacons/{id}. Gets a beacon. The beacon can be uniquely referenced by Radar `_id` or by `tag` and `externalId`. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Forward geocode via GET /v1/geocode/forward. Geocodes an address, converting address to coordinates. This endpoint is best for complete addresses. For partial addresses or place names, call the [autocomplete](https://docs.radar.com/api#autocomplete) endpoint instead. Returns a confidence level indicating the certainty of the result's latitude and longitude: * **`exact`**: Precise coordinates for a known address location. * **`interpolated`**: Estimated coordinates between two known address points when an exact address location is unavailable. * **`fallback`**: Coarse coordinates (e.g., postal code/city) for the containing region when no precise location is available. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

IP geocode via GET /v1/geocode/ip. Geocodes the requester's IP, converting IP address to city, state, and country. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Reverse geocode via GET /v1/geocode/reverse. Reverse geocodes a location, converting coordinates to address. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

List geofences via GET /v1/geofences. Lists geofences. Geofences are sorted descending by `updatedAt`.

Get a geofence via GET /v1/geofences/{id}. Gets a geofence. The geofence can be uniquely referenced by Radar `_id` or by `tag` and `externalId`.

Get a geofence (by tag and externalId) via GET /v1/geofences/{tag}/{externalId}. Gets a geofence. The geofence can be uniquely referenced by Radar `_id` or by `tag` and `externalId`.

Get users in a geofence via GET /v1/geofences/{tag}/{externalId}/users. Gets users currently in a geofence.

Directions via GET /v1/route/directions. Calculates the most efficient route between two or more locations to visit in order. Additionally you can modify the turn-by-turn directions response by specifying additional query parameters. Each turn-by-turn step includes `maneuver`, a string describing the maneuver type (for example, `start`, `left`, or `destination`). Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Distance via GET /v1/route/distance. Calculates the travel distance and duration between an origin and a destination. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Matrix via GET /v1/route/matrix. Calculates the travel distances and durations between multiple origins and destinations for up to 625 routes. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Optimize route via GET /v1/route/optimize. Calculates the optimal ordering and route to visit a list of locations. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Autocomplete via GET /v1/search/autocomplete. Autocompletes partial addresses and place names, sorted by relevance and proximity. **US/CA:** For customers using autocomplete for full address completion (i.e. checkout page), pass in `layers`: `address`, `countryCode`: `US, CA`. **International:** For customers implementing autocomplete for international address completion use cases, contact your solutions engineer for best practices based on your use case. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Search geofences via GET /v1/search/geofences. Searches for geofences near a location, sorted by distance. **Note:** To retrieve more than 100 results, `includeGeometries` must be set to `false`. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Search places via GET /v1/search/places. Searches for places near a location, sorted by distance. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Search users via GET /v1/search/users. Searches for users near a location, sorted by distance.

Get Places settings via GET /v1/settings. Gets your current Places settings. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

List trips via GET /v1/trips. Lists trips. Trips are sorted descending by `updatedAt`.

Get a trip via GET /v1/trips/{id}. Gets a trip. The trip can be referenced by Radar `_id` or `externalId`.

List users via GET /v1/users. Lists users. Users are sorted descending by `updatedAt`.

Get a user via GET /v1/users/{id}. Gets a user. The user can be referenced by Radar `_id`, `userId`, or `deviceId`.

Update Places settings via PATCH /v1/settings. Updates your Places settings. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Update a trip via PATCH /v1/trips/{id}/update. Updates a trip. The trip can be referenced by Radar `_id` or `externalId`. On iOS and Android, use the [SDK](https://docs.radar.com/sdk) to update trips. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Create a beacon via POST /v1/beacons. Creates a beacon. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Log a conversion via POST /v1/events. Conversions are available on the [**Enterprise plan**](https://radar.com/pricing). Logs a conversion to analyze alongside other location activity in your app. This can represent anything from a purchase or signup to engagement with an in-app feature. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Route match via POST /v1/route/match. Snaps points collected along a route to roads that were most likely traveled on. Returns the matched path and road information. For best results, the sample rate should be less than 10 seconds between points. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Track via POST /v1/track. Tracks a location update. Returns the user and the events generated, depending on project settings. On iOS and Android, use the [SDK](https://docs.radar.com/sdk/sdk) to track user locations in the foreground or in the background. `deviceId` is used to identify logged out users. `userId` and `deviceId` are used to identify logged in users. If a matching user already exists, it will be updated. If not, a new user will be created. Do not send any PII, like names, email addresses, or publicly available IDs, for `userId`. See [privacy best practices](https://docs.radar.com/faqs#what-are-privacy-best-practices-for-radar) for more information. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Create a new trip via POST /v1/trips. Use the [SDK](https://docs.radar.com/sdk/sdk) to start trips and track users for most use cases. Trips can also be created server-side or through integrations (e.g., Olo). Location updates with the specified `userId` from the [SDK](https://docs.radar.com/sdk/sdk) will update the trip for that user. Creates a new trip. Radar documents this endpoint for publishable keys; this connection sends the project's secret key, and whether Radar accepts a secret key here is unverified -- a 401 on this tool alone is that open question, not a bad key.

Send remote track requests to users via POST /v1/users/refresh. Sends a remote track request to a list of users via silent push notifications.

Upsert a beacon via PUT /v1/beacons/{id}. Upserts a beacon. The beacon can be uniquely referenced by Radar `_id` or by `tag` and `externalId`. If a beacon with the specified `tag` and `externalId` already exists, it will be updated. If not, it will be created. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Upsert a beacon (by tag and externalId) via PUT /v1/beacons/{tag}/{externalId}. Upserts a beacon. The beacon can be uniquely referenced by Radar `_id` or by `tag` and `externalId`. If a beacon with the specified `tag` and `externalId` already exists, it will be updated. If not, it will be created. Enterprise plan only (Radar's docs): a project whose contract lacks this module is refused by entitlement, not by a bad key.

Upsert a geofence via PUT /v1/geofences/{id}. Upserts a geofence. The geofence can be uniquely referenced by `tag` and `externalId` or by the Radar `_id`. If a geofence with the specified `tag` and `externalId` already exists, it will be updated. If not, it will be created.

Upsert a geofence (by tag and externalId) via PUT /v1/geofences/{tag}/{externalId}. Upserts a geofence. The geofence can be uniquely referenced by `tag` and `externalId` or by the Radar `_id`. If a geofence with the specified `tag` and `externalId` already exists, it will be updated. If not, it will be created.