Skip to main content
Radar logo
  • Category: places & weather
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 37
  • Triggers: 0
  • Slug: RADAR
  • Version: 20261101_00

Tools

Slug: RADAR_AUTOCOMPLETE_ADDRESS_OR_PLACETool to autocomplete partial addresses and place names based on relevance and proximity. Use after a user inputs a partial address/place to get suggestions, optionally biased by location.

Input Parameters

string
Coordinate bias as ‘lat,lng’
integer
Maximum number of results to return (1-100)
string
required
Partial address or place to autocomplete
array
Result types to return (e.g., [‘address’,‘place’])

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_CREATE_BEACONTool to create a new beacon in Radar. Use when you need to register a physical beacon device (iBeacon or Eddystone) for location tracking.

Input Parameters

string
required
A group or category for the beacon (e.g., ‘store-entrance’, ‘parking-lot’)
string ("ibeacon" | "eddystone")
required
The type of beacon technology
string
For iBeacon, the UUID identifier
string
For iBeacon, the major value
string
For iBeacon, the minor value
boolean
Whether the beacon is enabled. If not specified, defaults to true.
object
Optional custom metadata key-value pairs for the beacon
string
required
An external ID for the beacon, used to reference it in your system
array
required
The approximate location of the beacon in [longitude, latitude] format. Used to sync nearby beacons (within 1 kilometer) to the SDK.
string
A description for the beacon

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_CREATE_TRIPCreates a new Radar trip with an external ID and optional origin, destination, mode, and metadata details.

Input Parameters

string ("car" | "foot" | "bike")
Mode of travel, one of ‘car’, ‘foot’, or ‘bike’
object
Custom key-value pairs for trip
string
required
External ID for the trip
object
Origin location as GeoJSON Point
string
Tag of origin geofence (e.g. warehouse)
object
Destination location as GeoJSON Point
integer
Distance threshold in meters for approaching status
string
Tag of destination geofence (e.g. store)
string
External ID of origin geofence
string
External ID of destination geofence

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_DELETE_BEACONTool to delete a beacon by its Radar ID. Use when supplying a beacon’s unique identifier to remove it.

Input Parameters

string
required
The Radar _id of the beacon to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_DELETE_GEOFENCETool to delete a geofence by ID. Use when supplying a geofence’s unique identifier to remove it.

Input Parameters

string
required
Unique ID of the geofence to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_DELETE_GEOFENCE_BY_TAGTool to delete a geofence by tag and external ID. Use when you have both the tag and external identifier to remove a specific geofence.

Input Parameters

string
required
The tag of the geofence to delete
string
required
The external ID of the geofence to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_DELETE_TRIPTool to delete a trip by its Radar ID or external ID. Use after confirming the trip exists.

Input Parameters

string
required
The unique identifier of the trip to delete. Can be Radar _id or externalId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_DELETE_USERDelete a Radar user by Radar _id, userId, or deviceId. A 404 response is reported as success, so success does not confirm that a user was deleted.

Input Parameters

string
required
The user identifier - can be Radar _id, userId, or deviceId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_FORWARD_GEOCODEGeocode a full address into geographic coordinates, with optional layer and country filters. Results can be exact, interpolated, or coarse fallback matches.

Input Parameters

integer
Maximum number of results to return (default 10, max 100)
string
required
The full address or query string to geocode
array
Place types to filter results, comma-separated (e.g., ‘address’,‘locality’)
string
Two-letter ISO 3166-1 alpha-2 country code to filter results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_BEACONRetrieve a beacon by its Radar ID, returning the supported beacon fields.

Input Parameters

string
required
The Radar-generated _id of the beacon to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_BEACON_BY_TAGLook up a beacon by tag and external ID, returning the first beacon in the filtered results. Missing geometry coordinates are returned as zero.

Input Parameters

string
required
A group for the beacon (required)
string
required
An external ID for the beacon (required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_CONTEXT_FOR_LOCATIONTool to retrieve context for a given location. Use when you need geofences, place, and region information based on coordinates. Use after obtaining valid latitude and longitude.

Input Parameters

number
required
Latitude in decimal degrees, between -90 and 90
number
required
Longitude in decimal degrees, between -180 and 180

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_GEOFENCERetrieve a geofence by Radar ID or by tag and external ID, returning the supported geofence fields.

Input Parameters

string
Unique Radar geofence identifier (e.g., ‘56db1f4613012711002229f5’). Use this OR tag+externalId.
string
Tag of the geofence. Must be used together with externalId.
string
External identifier of the geofence. Must be used together with tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_PLACES_SETTINGSRequest Radar project Places settings. The response exposes a limited optional Places object; Radar’s documented top-level chain metadata, mappings, and place filters are not included in that object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_ROUTE_DIRECTIONSTool to get turn-by-turn directions between multiple locations. Use when you need detailed navigation instructions with steps, distances, and durations for routing.

Input Parameters

string ("de" | "en" | "es" | "fr" | "ja" | "ko" | "pt" | "ru")
Result language. Options: ‘de’, ‘en’, ‘es’, ‘fr’, ‘ja’, ‘ko’, ‘pt’, ‘ru’. Defaults to ‘en’
string ("car" | "truck" | "foot" | "bike")
Travel method. Options: ‘car’, ‘truck’, ‘foot’, ‘bike’. Defaults to ‘car’
string
Route features to bypass, comma-separated. Options: ‘tolls’, ‘highways’, ‘ferries’, ‘borderCrossings’
string ("metric" | "imperial")
Distance units. Options: ‘metric’, ‘imperial’. Defaults to ‘imperial’
number
Initial travel direction in degrees (0=north, 90=east, 180=south, 270=west)
string ("linestring" | "polyline5" | "polyline6")
Response geometry format. Options: ‘linestring’, ‘polyline5’, ‘polyline6’. Defaults to ‘polyline6’
string
required
A list of up to 25 coordinates to visit in order. A pipe-delimited string in the format ‘latitude0,longitude0|latitude1,longitude1|…’
boolean
Return alternative routes (only works for two-location routes). Defaults to false
string
ISO 8601 datetime for historical traffic consideration (e.g., ‘2025-01-01T14:30:00Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_ROUTE_MATRIXTool to calculate travel distance and duration between multiple origins and destinations for up to 625 routes. Use when you need to compute route metrics for multiple origin-destination pairs efficiently.

Input Parameters

string ("car" | "truck" | "foot" | "bike")
Travel mode for route calculation
string ("metric" | "imperial")
Unit system for distance measurements (metric returns meters, imperial returns feet)
string
required
Pipe-separated list of origin coordinates as ‘lat,lon|lat,lon’ (e.g., ‘40.7128,-74.0060|37.7749,-122.4194’)
string
required
Pipe-separated list of destination coordinates as ‘lat,lon|lat,lon’ (e.g., ‘40.7589,-73.9851|34.0522,-118.2437’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_TRIPTool to retrieve a trip by ID or externalId. Use when you have a trip ID or externalId to fetch its details.

Input Parameters

string
required
The Radar trip ID or externalId.
string
Set to ‘externalId’ when using an external trip ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_USERGet a user by Radar _id, userId, or deviceId. The returned user may include location and context data such as geofences, place, beacons, and trip information.

Input Parameters

string
required
User identifier - can be Radar _id, userId, or deviceId

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_GET_USERS_IN_GEOFENCERetrieve users currently within a geofence identified by its tag and external ID. Results include pagination metadata; use the cursor and limit to request pages.

Input Parameters

string
required
Tag of the geofence
integer
Maximum number of users to return (default: 100, max: 500)
string
Pagination cursor to fetch the next page of results
string
required
External ID of the geofence

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_IP_GEOCODETool to geocode an IP address to city, state, and country. Use when you need location details based on an IP address.

Input Parameters

string
The IP address to geocode; defaults to the requester’s IP if omitted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_LIST_EVENTSTool to list events. Use when you need to retrieve a paginated list of events with optional filtering.

Input Parameters

string
Return events created before this ISO 8601 timestamp
string
Filter events by event type
integer
Maximum number of events to return (1-500)
string
Return events created after this ISO 8601 timestamp
string
Filter events by user ID
string
Cursor to return events created after this event ID
string
Cursor to return events created before this event ID
string
Filter events by device ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_LIST_GEOFENCESList a page of geofences sorted by updated time, with optional filters and pagination cursors.

Input Parameters

string
Filter geofences by tag
integer
Page number to return (default 1)
integer
Maximum number of geofences to return (1-500)
object
Filter geofences by metadata key-value pairs
string
Filter geofences by external ID
string
Return geofences created after this ISO8601 timestamp
string
Return geofences updated after this ISO8601 timestamp
string
Return geofences created before this ISO8601 timestamp
string
Return geofences updated before this ISO8601 timestamp

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_LIST_TRIPSLists trips sorted by updated time, with optional user and external ID filters and ID-based cursor parameters.

Input Parameters

integer
Maximum number of trips to return (1–100). Defaults to 100 when omitted.
string
Filter trips by Radar user ID.
object
Filter trips by metadata key/value pairs.
string
Filter trips by external ID.
string
Return trips ending immediately before this trip ID.
string
Return trips starting immediately after this trip ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_LIST_USERSTool to list Radar users sorted by update time. Use when you need to page through users in your project.

Input Parameters

array
Only return users who have all of these tags
integer
Maximum number of users to return
string
User ID after which to return users for pagination
string
Only return users created after this ISO 8601 timestamp
string
Only return users updated after this ISO 8601 timestamp
string
Only return users created before this ISO 8601 timestamp
string
Only return users updated before this ISO 8601 timestamp

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_REVERSE_GEOCODETool to convert geographic coordinates to structured addresses. Use when you have latitude/longitude and need a human-readable address.

Input Parameters

integer
Maximum number of results to return (default 1, max 10)
array
Place types to restrict results, comma-separated (e.g., [‘address’,‘place’])
string
Two-letter ISO 3166-1 alpha-2 country code to filter results
string
required
Latitude and longitude in ‘lat,lon’ format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_ROUTE_DISTANCEComputes travel distance and duration between one origin and one destination for a selected travel mode.

Input Parameters

string ("car" | "truck" | "foot" | "bike")
Routing mode
string
Route features to avoid, comma-separated (e.g., ‘tolls,ferries’)
string ("metric" | "imperial")
Units for distance measurement
string
required
Origin coordinate as ‘latitude,longitude’
string ("polyline" | "polyline5" | "polyline6" | "linestring")
Format for route geometry in response. Options: ‘polyline’, ‘polyline5’, ‘polyline6’, ‘linestring’
string
required
Destination coordinate as ‘latitude,longitude’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_SEARCH_GEOFENCES_NEAR_LOCATIONTool to search for geofences near a given location. Use when you need to find geofences within a radius of specified coordinates.

Input Parameters

array
Filter geofences by these tags
integer
Search radius in meters (default 1000, max 10000)
number
required
Latitude of the location to search near
object
Filter geofences by metadata key-value pairs
number
required
Longitude of the location to search near

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_SEARCH_PLACES_NEAR_LOCATIONTool to search for places near given coordinates. Use when you need to find points of interest around a location.

Input Parameters

string
required
Coordinates to search near in ‘lat,lng’ format
string
Filter by brand name or ID
integer
Number of results to return; max 100; defaults to 10
array
Filter by chain IDs
array
Filter by custom group names
integer
Search radius in meters; max 10000 (10 km); defaults to 1000
string
ISO 3166-1 alpha-2 country code
array
Filter by category names
boolean
If true, includes chain metadata in each place object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_SEARCH_USERS_NEAR_LOCATIONTool to search for users near a location. Use after obtaining coordinates when you need to retrieve users within a given radius.

Input Parameters

integer
Maximum number of users to return (default: 100, max: 500).
number
Maximum distance in meters to search (default: 1000, range: 1-10000).
number
required
Latitude of the location in decimal degrees.
number
required
Longitude of the location in decimal degrees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_TRACK_LOCATION_UPDATETool to track a user’s location update. Use when sending a location update for a user, creating or updating user and event data.

Input Parameters

string
Stable unique identifier for logged-in users. Combined with deviceId for user identification.
boolean
Whether the user is stopped (not moving)
number
required
Accuracy of the location in meters. Must be greater than 0.
number
Altitude of the device in meters
string
required
Unique identifier for the user’s device. Required for user identification.
string
Operating system version of the device
number
required
Latitude of the location in degrees
object
Arbitrary metadata to associate with this track event (up to 32 keys)
boolean
Whether this location update is historical (replayed)
number
required
Longitude of the location in degrees
string
ISO 8601 timestamp for historical track events
string
Manufacturer of the device
string
Type of device: iOS, Android, or Web
boolean
Whether the client is in the foreground
string
Text description of the user to display on the dashboard
string
Model of the device
number
Vertical accuracy of the altitude in meters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPDATE_PLACES_SETTINGSSubmits a Places settings update for a Radar project with an optional chain metadata enabled flag.

Input Parameters

object
Chain metadata preferences for Places.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPDATE_TRIPTool to update a trip. Use when you need to modify mode, destination, schedule, or active status.

Input Parameters

string
required
The Radar trip ID or externalId to update
string ("car" | "truck" | "bike" | "foot" | "motorbike")
Mode of travel (valid values: car, foot, bike, truck, motorbike)
boolean
Whether the trip is active (true) or paused/completed (false)
string
Set to ‘externalId’ when the provided ID is an external trip ID
object
Custom metadata (max 16 key-value pairs)
string
New external ID for the trip
object
Explicit destination coordinates if not using a geofence.
number
Threshold in meters for the ‘arrived’ state
string
Scheduled arrival time in ISO8601 format
number
Threshold in meters for the ‘approaching’ state
string
Tag of destination geofence
number
Radius in meters for the destination geofence
string
External ID of destination geofence

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPDATE_TRIP_BY_IDTool to update a trip status by Radar _id or external ID. Use when you need to change trip status to started, approaching, arrived, completed, or canceled.

Input Parameters

string
required
Trip ID (Radar _id or externalId) to update
string ("started" | "approaching" | "arrived" | "completed" | "canceled")
required
The new status of the trip
object
Optional custom key-value pairs for the trip
string
Optional stable unique ID for the trip

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPSERT_BEACON_BY_IDTool to create or update a beacon by Radar _id. Use when you need to ensure a beacon with a specific ID exists with updated properties.

Input Parameters

string
required
The Radar beacon _id to create or update
string
A group for the beacon
string
required
Beacon type, must be ‘ibeacon’
string
required
The iBeacon UUID
string
required
Major number for the beacon (can be string or integer)
string
required
Minor number for the beacon (can be string or integer)
boolean
If true, the beacon will generate events; defaults to true
string
External ID for the beacon
array
required
The approximate location in [longitude, latitude] format
string
Display name for the beacon

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPSERT_BEACON_BY_TAGTool to create or update a beacon by tag and externalId. Use when you need to ensure a beacon exists or is updated with specific identifiers.

Input Parameters

string
required
Tag identifier for grouping the beacon (appears in URL path)
string
UID identifier for Eddystone beacons (required for eddystone, not used for ibeacon)
string ("ibeacon" | "eddystone")
required
Beacon technology type: ibeacon or eddystone
string
UUID identifier for iBeacon type (required for ibeacon, not used for eddystone)
string
Major ID for iBeacon type (required for ibeacon, not used for eddystone)
string
Minor ID for iBeacon type (required for ibeacon, not used for eddystone)
boolean
required
Whether the beacon is active and generates events
string
Instance ID for Eddystone beacons (required for eddystone, not used for ibeacon)
object
Custom key-value pairs for the beacon (max 16 keys, values must be string/boolean/number)
string
required
External identifier mapping to your database (appears in URL path)
array
required
Beacon location as [longitude, latitude] in GeoJSON format
string
required
Human-readable display name for the beacon

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPSERT_GEOFENCETool to create or update a geofence by tag and externalId. Use when ensuring a geofence exists or is updated based on identifiers.

Input Parameters

string
required
Tag of the geofence to create or update
string ("circle" | "polygon")
required
Shape type of the geofence
number
Radius in meters defining a circle. Required when type=‘circle’.
object
GeoJSON geometry object for the geofence
object
Custom key-value pairs attached to the geofence
string
required
External identifier of the geofence
array
Array of [longitude, latitude] pairs defining a polygon. Required when type=‘polygon’.
string
required
Human-readable description of the geofence (required by the API)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RADAR_UPSERT_GEOFENCE_BY_IDTool to create or update a geofence by Radar _id. Use when you need to upsert a geofence using its internal Radar identifier.

Input Parameters

string
required
Radar internal geofence _id to create or update
string
Group identifier for the geofence
string ("circle" | "polygon" | "isochrone")
required
Geofence geometry type: circle, polygon, or isochrone
number
Distance in meters (required for circle and isochrone types)
boolean
Boolean to enable/disable event generation for this geofence
object
Custom key-value pairs (up to 16 keys)
string
External database reference
string
required
Location data in [longitude, latitude] format for circle/isochrone, or array of coordinate pairs for polygon
string
required
A display name for the geofence (required by API)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not