The Radar connector lets your AI agent act in each user's Radar account. Each user connects their own Radar API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 39 tools.
- Tools
- 39
- What they doRead · write · destructive
- 23 · 12 · 423 read12 write4 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Radar connection
In AgentKit > Connections, create a Radar connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'radar'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Radar:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'radar_beacons_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "radar"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Radar:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="radar_beacons_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Radar credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolradar_address_validateValidate and normalize a postal address.Read-onlyValidate Address
Validate and normalize a postal address. Returns the verified address with its components and a verification status. Use Forward Geocode to get coordinates for an address.
Inputs
citystringrequired- The city name. Example: Brooklyn.
country_codestringrequired- The unique 2-letter country code (e.g., US). Example: US.
postal_codestringrequired- The postal or zip code. Plus 4 codes are accepted but not required. Example: 11201.
state_codestringrequired- The 2-letter state abbreviation (e.g., NY). Example: NY.
address_labelstring- The first line of the address, including the building number, street name, and unit number if applicable (e.g., 20 Jay St Apt 3). Required if number and street aren't provided. Example: 20 Jay St.
numberstring- The building or P.O. box number. Required with street if addressLabel isn't provided. Example: 20.
streetstring- The street name. Required with number if addressLabel isn't provided. Example: Jay St.
unitstring- The unit number, such as apartment or suite (e.g., Apt 3). Example: Apt 3.
radar_autocompleteAutocomplete a partial address or place name, preferring results near a location.Read-onlyAutocomplete
Autocomplete a partial address or place name, preferring results near a location. Returns suggested addresses and places with coordinates and, with a session token, result IDs. Use Autocomplete Select to record the chosen result. Use Forward Geocode for complete addresses.
Inputs
querystringrequired- The partial address or place name to autocomplete. Example: 20 Jay St Brooklyn.
country_codestring- An optional countries filter. A string of comma-separated countries, the unique 2-letter country code. Example: US.
layersstring- Optional layer filters. A string, comma-separated, including one or more of place, address, postalCode, locality, county, state, country, coarse, and fine. Note that coarse includes all of postalCode, locality, county, state, and country, whereas fine includes address and place. If not provided, results from address and coarse layers will be returned. Example: address.
limitnumber- The max number of addresses to return. A number between 1 and 100. Defaults to 10. Example: 10.
nearstring- The location to prefer search results near. A string in the format latitude,longitude. If not provided, the request IP geolocation will be used to anchor the search. Example: 40.7041,-73.9867.
session_tokenstring- A UUID grouping the requests from one address field. When provided, each result carries a resultId that can be reported to the autocomplete select endpoint. Example: 6f1c2a3b-4d5e-4f60-8a9b-0c1d2e3f4a5b.
radar_beacon_getGet one beacon by its Radar _id.Read-onlyGet Beacon
Get one beacon by its Radar _id. Returns its tag, external ID, type, identifiers, location and metadata. Use List Beacons to find beacons.
Inputs
beacon_idstringrequired- The beacon's Radar _id. Example: 6109a4b16dbfe3de2cb03924.
radar_beacons_listList Bluetooth beacons, filterable by tag, external ID and dates.Read-onlyList Beacons
List Bluetooth beacons, filterable by tag, external ID and dates. Returns beacons with tag, external ID, type, identifiers, location and enabled flag. Use Get Beacon for one beacon.
Inputs
created_afterstring- A cursor for use in pagination. Retrieves beacons updated after the specified datetime. A date or valid ISO date string. Example: 2026-11-01T00:00:00Z.
created_beforestring- A cursor for use in pagination. Retrieves beacons updated before the specified datetime. A date or valid ISO date string. Example: 2026-11-16T00:00:00Z.
external_idstring- Retrieves beacons with the specified externalId. Example: 123.
limitnumber- The max number of beacons to return. A number between 1 and 1000. Defaults to 100. Example: 10.
tagstring- Retrieves beacons with the specified tag. Example: store.
radar_fraud_action_getGet the status of a block or unblock action.Read-onlyGet Fraud Action Status
Get the status of a block or unblock action. Returns the action's status and affected users and devices. Use the action ID from Block or Unblock Users or Devices.
Inputs
action_idstringrequired- Action ID from the statusUrl returned by Block or Unblock. Example: act_123.
radar_geocode_forwardConvert a complete address into coordinates.Read-onlyForward Geocode
Convert a complete address into coordinates. Returns matching addresses with latitude, longitude, formatted address, components, confidence and time zone. Use Autocomplete for partial addresses or place names. Use Reverse Geocode for coordinates to address.
Inputs
querystringrequired- The address to geocode. Example: 20 Jay St Brooklyn.
countrystring- An optional countries filter. A string of comma-separated countries, the unique 2-letter country code. Example: US.
langstring- Specifies the language for the results. A string, one of ar, de, en, es, fr, ja, ko, pt, ru, zh. Defaults to en. Example: en.one of
ardeenesfrjakoptruzh layersstring- Optional layer filters. A string, comma-separated, including one or more of place, address, postalCode, locality, county, state, country, coarse, and fine. Note that coarse includes all of postalCode, locality, county, state, and country, whereas fine includes address and place. If not provided, results from address and coarse layers will be returned. Example: address.
radar_geocode_reverseConvert coordinates into an address.Read-onlyReverse Geocode
Convert coordinates into an address. Returns addresses for the location with formatted address, components and time zone. Use Forward Geocode for address to coordinates.
Inputs
coordinatesstringrequired- The coordinates to reverse geocode. A string in the format latitude,longitude. Example: [40.7041, -73.9867].
layersstring- Optional layer filters. A string, comma-separated, including one or more of place, address, postalCode, locality, county, state, country, coarse, and fine. Note that coarse includes all of postalCode, locality, county, state, and country, whereas fine includes address and place. If not provided, results from address and coarse layers will be returned. Example: address.
radar_geofence_getGet one geofence by its Radar _id.Read-onlyGet Geofence
Get one geofence by its Radar _id. Returns its tag, external ID, description, type, geometry, metadata and settings. Use Get Geofence by External ID when you know the tag and external ID.
Inputs
geofence_idstringrequired- The geofence's Radar _id. Example: 56db1f4613012711002229f5.
radar_geofence_get_by_external_idGet one geofence by its tag and external ID.Read-onlyGet Geofence by External ID
Get one geofence by its tag and external ID. Returns its description, type, geometry, metadata and settings. Use Get Geofence when you have the Radar _id.
Inputs
external_idstringrequired- The geofence external ID within the tag. Example: 123.
tagstringrequired- The geofence tag (its group). Example: store.
radar_geofence_users_listList the users currently inside a geofence.Read-onlyList Users in Geofence
List the users currently inside a geofence. Returns the users with location and device details. Use Get User for one user's details.
Inputs
external_idstringrequired- The geofence external ID within the tag. Example: 123.
tagstringrequired- The geofence tag (its group). Example: store.
radar_geofences_listList geofences, most recently updated first, filterable by tag, external ID and dates.Read-onlyList Geofences
List geofences, most recently updated first, filterable by tag, external ID and dates. Returns geofences with tag, external ID, description, type, geometry, metadata and enabled flag. Use Search Geofences to find geofences near a location.
Inputs
created_afterstring- Retrieves geofences created after the specified datetime. A date or valid ISO date string. Example: 2026-11-01T00:00:00Z.
created_beforestring- Retrieves geofences created before the specified datetime. A date or valid ISO date string. Example: 2026-11-16T00:00:00Z.
external_idstring- Retrieves geofences with the specified externalId. Example: 123.
limitnumber- The max number of geofences to return. A number between 1 and 1000. Defaults to 100. Example: 10.
tagstring- Retrieves geofences with the specified tag. Example: store.
updated_afterstring- A cursor for use in pagination. Retrieves geofences updated after the specified datetime. A date or valid ISO date string. Example: 2026-11-01T00:00:00Z.
updated_beforestring- A cursor for use in pagination. Retrieves geofences updated before the specified datetime. A date or valid ISO date string. Example: 2026-11-16T00:00:00Z.
radar_geofences_searchFind your geofences near a location, optionally by tag and radius.Read-onlySearch Geofences
Find your geofences near a location, optionally by tag and radius. Returns geofences with tag, external ID, description, metadata and geometry. Use List Geofences to page through all geofences.
Inputs
nearstringrequired- A location for the search. A string in the format latitude,longitude. Example: 40.7041,-73.9867.
include_geometryboolean- Include geofence geometries in the response. Defaults to true. Example: false.
limitnumber- The max number of geofences to return. A number between 1 and 1000. Defaults to 100. Example: 10.
radiusnumber- Optional radius to search, in meters. Example: 100.
tagsstring- Optional tag filters. A string, comma-separated. Example: store,venue.
radar_places_searchFind places (stores, restaurants, airports and more) near a location by chain or category, or an airport by IATA code.Read-onlySearch Places
Find places (stores, restaurants, airports and more) near a location by chain or category, or an airport by IATA code. Returns places with name, chain, categories and location. Use Autocomplete to search places by name.
Inputs
nearstringrequired- A location for the search. A string in the format latitude,longitude. Example: 40.7041,-73.9867.
categoriesstring- Category filters. A string, comma-separated. If not provided, chains must be provided. Example: coffee-shop.
chainsstring- Chain slug filters. A string, comma-separated. If your project has a chain mapping, the mapped ID can be used in place of the chain slug. If not provided, categories must be provided. Example: starbucks.
iata_codestring- The 3-letter IATA code for the airport to search. If provided, no other parameters are required. Example: JFK.
limitnumber- The max number of places to return. A number between 1 and 100. Defaults to 10. Example: 10.
radiusnumber- The radius to search, in meters. A number between 1 and 10000. Defaults to 1000. Example: 100.
radar_places_settings_getGet the project's Places settings.Read-onlyGet Places Settings
Get the project's Places settings. Returns chain metadata, chain mappings and place filters. Use Update Places Settings to change them.
Inputs
This tool takes no inputs.
radar_route_directionsGet turn-by-turn directions through up to 25 locations in order.Read-onlyDirections
Get turn-by-turn directions through up to 25 locations in order. Returns routes with distance, duration, legs, steps and geometry. Use Optimize Route to find the best visiting order. Use Route Distance for distance and time only.
Inputs
locationsstringrequired- A list of up to 25 coordinates to visit in order. A pipe-delimited string in the format latitude0,longitude0|latitude1,longitude1|.... Example: 40.7041,-73.9867|40.7484,-73.9857.
alternativesboolean- Specifies whether to try to return alternative routes. This feature is available if only two locations are specified. Defaults to false. Example: false.
avoidstring- The features that calculated routes should avoid. A string, comma-separated, including one or more of tolls, highways, ferries and borderCrossings. No features are avoided if not provided. Example: tolls,highways.
departure_timestring- The date and time of the route provided as an ISO 8601 date string (e.g., 2025-01-01T14:30:00Z) which will be used for historical traffic times. If not provided, the current date and time will be used. Example: 2026-11-17T14:30:00Z.
geometrystring- The format of the geometry in the response. Valid values are linestring, polyline5 and polyline6. linestring returns a GeoJSON LineString, polyline5 returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and polyline6 returns a polyline with 6 decimal places of precision. Defaults to polyline6 if not provided. Example: linestring.one of
linestringpolyline5polyline6 headingnumber- Initial heading of travel where north is 0°, east is 90°, south is 180°, and west is 270°. If not provided, no initial heading will be used. Example: 90.
langstring- Specifies the language for the results. A string, one of de, en, es, fr, ja, ko, pt, ru. Defaults to en. Example: en.one of
deenesfrjakoptru modestring- The travel mode. A string, one of car, truck, foot, or bike. Defaults to car. Example: car.one of
cartruckfootbike unitsstring- The distance units. A string, metric or imperial. Defaults to imperial. Example: metric.one of
metricimperial
radar_route_distanceCalculate the travel distance and duration between two points for one or more travel modes.Read-onlyRoute Distance
Calculate the travel distance and duration between two points for one or more travel modes. Returns distance and duration for each mode. Use Route Matrix for many origins and destinations. Use Directions for turn-by-turn routes.
Inputs
destinationstringrequired- The destination. A string in the format latitude,longitude. Example: 40.7041,-73.9867.
modesstringrequired- The travel modes. A string, comma-separated, including one or more of car, truck, foot, or bike. Example: car,foot.
originstringrequired- The origin. A string in the format latitude,longitude. Example: 40.7041,-73.9867.
avoidstring- The features that calculated routes should avoid. A string, comma-separated, including one or more of tolls, highways, ferries and borderCrossings. No features are avoided if not provided. Example: tolls,highways.
departure_timestring- The date and time of the route provided as an ISO 8601 date string (e.g., 2025-01-01T14:30:00Z) which will be used for historical traffic times. If not provided, the current date and time will be used. Example: 2026-11-17T14:30:00Z.
geometrystring- The format of the geometry in the response. Valid values are linestring, polyline5 and polyline6. linestring returns a GeoJSON LineString, polyline5 returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and polyline6 returns a polyline with 6 decimal places of precision. Defaults to none if not provided. Example: linestring.one of
linestringpolyline5polyline6 unitsstring- The distance units. A string, metric or imperial. Defaults to imperial if not provided. In the response, distance.value will be in meters for metric and in feet for imperial. Example: metric.one of
metricimperial
radar_route_matchSnap GPS points recorded along a route to the roads most likely traveled.Read-onlyRoute Match
Snap GPS points recorded along a route to the roads most likely traveled. Returns the matched path, distance and requested road attributes. Use Directions to plan a route instead.
Inputs
patharrayrequired- Points recorded along the route, each as {"coordinates": "latitude,longitude"} with optional createdAt (ISO date) and accuracy (meters). Sample at least every 10 seconds for best results. Example: [{"coordinates": "40.7041,-73.9867"}, {"coordinates": "40.7050,-73.9860"}].
geometrystring- Geometry format: linestring, polyline5 or polyline6 (default). Example: linestring.one of
linestringpolyline5polyline6 modestring- Travel mode: car (default), truck, foot or bike. Example: car.one of
cartruckfootbike road_attributesstring- Comma-separated road attributes to include: speedLimit, names, roadClass. Example: speedLimit,names.
unitsstring- metric or imperial (default). Example: metric.one of
metricimperial
radar_route_matrixCalculate travel distances and durations between several origins and destinations.Read-onlyRoute Matrix
Calculate travel distances and durations between several origins and destinations. Returns a matrix with distance and duration for each origin-destination pair. Use Route Distance for a single pair.
Inputs
destinationsstringrequired- A list of destinations. A pipe-delimited string in the format latitude0,longitude0|latitude1,longitude1|.... Example: 40.7041,-73.9867|40.7484,-73.9857.
modestringrequired- The travel mode. A string, one of car, truck, foot, or bike. Example: car.one of
cartruckfootbike originsstringrequired- A list of origins. A pipe-delimited string in the format latitude0,longitude0|latitude1,longitude1|.... Example: 40.7041,-73.9867|40.7484,-73.9857.
avoidstring- The features that calculated routes should avoid. A string, comma-separated, including one or more of tolls, highways and ferries. No features are avoided if not provided. Example: tolls,highways.
unitsstring- The distance units. A string, metric or imperial. Defaults to imperial if not provided. Example: metric.one of
metricimperial
radar_route_optimizeFind the best order to visit up to 10 locations, starting at the first.Read-onlyOptimize Route
Find the best order to visit up to 10 locations, starting at the first. Returns the optimized order with distance, duration and geometry. Use Directions to follow a fixed order.
Inputs
locationsstringrequired- A list of up to 10 coordinates to visit. A pipe-delimited string in the format latitude0,longitude0|latitude1,longitude1|.... The first location should be the origin of the route, and the last location should be the final destination. Example: 40.7041,-73.9867|40.7484,-73.9857.
geometrystring- The format of the geometry in the response. Valid values are linestring, polyline5 and polyline6. linestring returns a GeoJSON LineString, polyline5 returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and polyline6 returns a polyline with 6 decimal places of precision. Defaults to none if not provided. Example: linestring.one of
linestringpolyline5polyline6 modestring- The travel mode. A string, one of car, truck, foot, or bike. Defaults to car. Example: car.one of
cartruckfootbike unitsstring- The distance units. A string, metric or imperial. Defaults to imperial. Example: metric.one of
metricimperial
radar_trip_getGet one trip by Radar _id or externalId.Read-onlyGet Trip
Get one trip by Radar _id or externalId. Returns its status, mode, ETA, destination geofence, user and metadata. Use List Trips to find trips.
Inputs
trip_idstringrequired- The trip's Radar _id or externalId. Example: 56db1f4613012711002229f4.
radar_trips_listList trips, filterable by status, destination geofence, user, delay and date.Read-onlyList Trips
List trips, filterable by status, destination geofence, user, delay and date. Returns trips with external ID, status, mode, ETA, destination and user. Use Get Trip for one trip.
Inputs
created_afterstring- A cursor for use in pagination. Retrieves trips created after the specified datetime. A date or valid ISO date string. Example: 2026-11-01T00:00:00Z.
created_beforestring- A cursor for use in pagination. Retrieves trips created before the specified datetime. A date or valid ISO date string. Example: 2026-11-16T00:00:00Z.
delayedboolean- Retrieves trips that matches specified delayed state. Example: true.
destination_geofence_external_idstring- Retrieves trips with the destination geofence external ID. Example: 123.
destination_geofence_tagstring- Retrieves trips with the destination geofence tag. Example: store.
include_locationsboolean- Whether to include locations on trips. Defaults to false. Example: false.
limitnumber- The max number of addresses to return. A number between 1 and 1000. Defaults to 500. Example: 10.
sort_bystring- Sorts trips by the specified field in descending order. A string, one of createdAt or updatedAt. Defaults to updatedAt. Example: updatedAt.one of
createdAtupdatedAt statusstring- Retrieves trips by status. A string, comma-separated including one or more of pending, started, approaching, arrived, completed, canceled, expired. Example: started.
user_idstring- The Radar _id of the user for which the trip is being tracked. Example: user-123.
radar_user_getGet one tracked user by Radar _id, userId or deviceId.Read-onlyGet User
Get one tracked user by Radar _id, userId or deviceId. Returns the user's location, device, metadata, current geofences, place, region and trip. Use List Users to find users.
Inputs
user_idstringrequired- The user's Radar _id, userId or deviceId. Example: 56db1f4613012711002229f4.
radar_users_listList tracked users, most recently updated first.Read-onlyList Users
List tracked users, most recently updated first. Returns users with ids, location, device, current geofences, place and trip, plus a hasMore flag. Use updated_before with the last user's updatedAt to page. Use Get User for one user.
Inputs
limitnumber- The max number of users to return. A number between 1 and 1000. Defaults to 100. Example: 10.
updated_afterstring- A cursor for use in pagination. Retrieves users updated after the specified datetime. A date or valid ISO date string. Example: 2026-11-01T00:00:00Z.
updated_beforestring- A cursor for use in pagination. Retrieves users updated before the specified datetime. A date or valid ISO date string. Example: 2026-11-16T00:00:00Z.
radar_autocomplete_selectRecord which Autocomplete result the user picked, closing the autocomplete session.WriteAutocomplete Select
Record which Autocomplete result the user picked, closing the autocomplete session. Returns the selected result. Use the resultId from an Autocomplete call made with a session token.
Inputs
result_idstringrequired- The resultId of the chosen result, as returned by the autocomplete endpoint. Results carry one only when the originating search passed a sessionToken. Example: res_8f2a1c.
radar_beacon_createCreate an iBeacon or Eddystone beacon so the SDK can detect it.WriteCreate Beacon
Create an iBeacon or Eddystone beacon so the SDK can detect it. Returns the new beacon. Use Upsert Beacon to create or replace one by ID.
Inputs
coordinatesarrayrequired- Approximate beacon location as [longitude, latitude], used to sync nearby beacons to the SDK. Example: [-73.9867, 40.7041].
descriptionstringrequired- A display name for the beacon. Example: Brooklyn store.
external_idstringrequired- An external ID for the beacon. Example: 123.
tagstringrequired- A group for the beacon. Example: store.
typestringrequired- The type of beacon, one of ibeacon (supported on iOS and Android) or eddystone (supported on Android only). Example: ibeacon.one of
ibeaconeddystone enabledboolean- If true, the beacon will generate events. If false, the beacon will not generate events. Example: true.
instancestring- For Eddystone beacons, the instance ID of the beacon. Required for eddystone. Example: a1b2c3d4e5f6.
majorstring- For iBeacons, the major ID of the beacon. Required for ibeacon. Example: 100.
metadataobject- A set of custom key-value pairs for the beacon. A JSON string representing a dictionary with up to 16 keys and values of type string, boolean, or number. Example: {"store_type": "flagship"}.
minorstring- For iBeacons, the minor ID of the beacon. Required for ibeacon. Example: 1.
uidstring- For Eddystone beacons, the UID of the beacon. Required for eddystone. Example: edd1ebeac04e5defa017.
uuidstring- For iBeacons, the UUID of the beacon. Required for ibeacon. Example: B9407F30-F5F8-466E-AFF9-25556B57FE6D.
radar_beacon_upsertCreate or replace a beacon identified by tag and external ID.WriteUpsert Beacon
Create or replace a beacon identified by tag and external ID. Returns the saved beacon. Use Create Beacon to always add a new one.
- Idempotent
Inputs
coordinatesarrayrequired- Approximate beacon location as [longitude, latitude]. Example: [-73.9867, 40.7041].
descriptionstringrequired- A display name for the beacon. Example: Brooklyn store.
external_idstringrequired- The beacon external ID within the tag. Example: 123-1.
tagstringrequired- The beacon tag (its group). Example: store-register.
typestringrequired- The type of beacon, one of ibeacon (supported on iOS and Android) or eddystone (supported on Android only). Example: ibeacon.one of
ibeaconeddystone enabledboolean- If true, the beacon will generate events. If false, the beacon will not generate events. Defaults to true. Example: true.
instancestring- For Eddystone beacons, the instance ID of the beacon. Required for eddystone. Example: a1b2c3d4e5f6.
majorstring- For iBeacons, the major ID of the beacon. Required for ibeacon. Example: 100.
metadataobject- An optional set of custom key-value pairs for the beacon. A JSON string representing a dictionary with up to 16 keys and values of type string, boolean, or number. Example: {"store_type": "flagship"}.
minorstring- For iBeacons, the minor ID of the beacon. Required for ibeacon. Example: 1.
uidstring- For Eddystone beacons, the UID of the beacon. Required for eddystone. Example: edd1ebeac04e5defa017.
uuidstring- For iBeacons, the UUID of the beacon. Required for ibeacon. Example: B9407F30-F5F8-466E-AFF9-25556B57FE6D.
radar_conversion_logLog a custom conversion event (such as a purchase or check-in) for a user, attributed to their location.WriteLog Conversion
Log a custom conversion event (such as a purchase or check-in) for a user, attributed to their location. Returns the created event. Use Track Location to record locations.
Inputs
namestringrequired- The name of the conversion. Should be generic (e.g., in_app_purchase). Only alphanumeric characters and underscores are supported. Example: in_app_purchase.
created_atstring- The datetime when the conversion occurred. Example: 2026-11-16T14:30:00Z.
device_idstring- A device ID for the user. Used to identify logged out users. Example: C305F2DB-56DC-404F-B6C1-BC52F0B680D8.
durationnumber- The duration of the conversion in minutes. Example: 12.
install_idstring- An install ID for the user. Used to identify users who have opted out of location permissions. Can be a random alphanumeric string for users that don't exist in Radar. Example: 5e4f3a2b-1c0d-4e9f-8a7b-6c5d4e3f2a1b.
metadataobject- The metadata of the conversion. This data cannot contain any sensitive or personally identifiable information. Example: {"store_type": "flagship"}.
revenuenumber- The revenue of the conversion. Used to associate an amount with a transactional conversion such as a purchase or coupon redemption. Example: 12.5.
user_idstring- The stable unique ID for the user. Used to identify logged in users. Example: user-123.
radar_fraud_blockBlock users or devices in Radar Fraud so their location checks fail.WriteBlock Users or Devices
Block users or devices in Radar Fraud so their location checks fail. Returns the action with a status URL; association blocking runs asynchronously. Use Get Fraud Action Status to follow it. Use Unblock Users or Devices to undo.
Inputs
itemsarrayrequired- Users or devices to block, 1 to 500. Each item has exactly one of userId or deviceId, plus optional includeAssociations, durationMs, description, label (fraud or not_fraud), fraudType and incidentTime. Example: [{"userId": "user-123", "description": "Suspicious activity"}].
radar_fraud_unblockRemove fraud blocks from users or devices.WriteUnblock Users or Devices
Remove fraud blocks from users or devices. Returns the action with a status URL. Use Get Fraud Action Status to follow it.
Inputs
itemsarrayrequired- Users or devices to unblock, 1 to 500. Each item has exactly one of userId or deviceId, plus optional includeAssociations, label, fraudType and incidentTime. Example: [{"userId": "user-123"}].
radar_geofence_upsertCreate or replace a geofence identified by tag and external ID, as a circle, polygon or isochrone.WriteUpsert Geofence
Create or replace a geofence identified by tag and external ID, as a circle, polygon or isochrone. Returns the saved geofence. Use List Geofences to see existing ones. Use Delete Geofence to remove one.
- Idempotent
Inputs
descriptionstringrequired- A description for the geofence. Example: Brooklyn store.
external_idstringrequired- The geofence external ID within the tag. Example: 123.
tagstringrequired- The geofence tag (its group). Example: store.
typestringrequired- The type of geofence geometry. A string, one of circle, polygon, or isochrone. Example: circle.one of
circlepolygonisochrone addressstring- An address to search for, and if found, will represent the center for type circle or isochrone. If address and coordinates are both provided, they must be nearby, and coordinates will take precedent. Ignored for type polygon. Required if coordinates and placeid are not included. Example: 20 Jay St, Brooklyn, NY.
coordinatesarray- Center (circle) or destination (isochrone) as [longitude, latitude], or polygon vertices as an array of [longitude, latitude] pairs. Required if address and place_id are not given. Example: [-73.9867, 40.7041].
delete_afterstring- Use to create temporary geofences. If set, the geofence will be deleted after the specified datetime. A date or valid ISO date string. Example: 2026-12-31T00:00:00Z.
disable_afterstring- Use to create temporary geofences. If set, the geofence will be disabled after the specified datetime. A date or valid ISO date string. Example: 2026-12-01T00:00:00Z.
dwell_thresholdnumber- An optional field to trigger dwell events. If set and user.dwelled_in_geofence is enabled in settings, an event is triggered when a user dwells in the geofence longer than the threshold (in minutes). Example: 10.
enabledboolean- If true, the geofence will generate events. If false, the geofence will not generate events. Defaults to true. Example: true.
ipstring- An optional IP address restriction for the geofence. A string of comma-separated IP address ranges, each of which could be a single IP (8.8.8.8), wildcard notation (8.8.8.*), or CIDR notation (8.8.8.8/24). If set, the geofence will only generate events for requests from the specified IP address. If not set, the geofence will generate events for all requests. Example: 203.0.113.0/24.
metadataobject- An optional set of custom key-value pairs for the geofence. A dictionary or JSON string with up to 16 keys and values of type string, boolean, or number. Example: {"store_type": "flagship"}.
modestring- The travel mode for type isochrone. Required for type isochrone. Example: car.one of
carfootbike operating_hoursobject- An optional set of key-value pairs restricting the operating hours of the geofence. Each key is a day of the week (e.g., Sunday) or the three letter abbreviation of the day (e.g., Sun), case insensitive. Each value is a list of pairs, where a pair indicates one opening and closing time for that day. For example, a restaurant only open for lunch and dinner on Sundays would be { Sunday: [["11:00", "14:00"], ["19:00", "22:00"]] }. Accepted time formats include h:mm aa (e.g., 12:45 AM) and HH:mm (e.g., 00:45). If not set, the geofence will always be open. Example: {"Mon": [["09:00", "17:00"]]}.
place_idstring- For place matching, an optional id of the Radar place to match to the geofence. If provided and found, the place centroid will override coordinates and address. Required if coordinates and address are not included. Example: 59302bcf8f27e9c0adf3fd5c.
radiusnumber- The radius in meters for type circle, a number between 10 and 10000. The travel duration in minutes for type isochrone. Ignored for type polygon. Required for type circle and isochrone. Example: 100.
stop_detectionboolean- The stop detection setting for the geofence. Overrides the project-level stop detection setting. Example: true.
trip_approaching_thresholdnumber- The trip approaching threshold setting for the geofence (in minutes). Overrides the project-level trip approaching threshold setting. Example: 5.
user_idstring- An optional user restriction for the geofence. If set, the geofence will only generate events for the specified user. If not set, the geofence will generate events for all users. **Deprecated.**. Example: user-123.
user_idsstring- An optional user restriction for the geofence. A string of comma-separated user IDs. If set, the geofence will only generate events for the specified users. If not set, the geofence will generate events for all users. Example: user-123,user-456.
radar_places_settings_updateUpdate the project's Places settings: chain metadata, chain mappings and place filters.WriteUpdate Places Settings
Update the project's Places settings: chain metadata, chain mappings and place filters. Returns the updated settings. Use Get Places Settings to read the current values.
- Idempotent
Inputs
chain_mappingsobject- Map of chain slug to your own identifier. Example: {"mcdonalds": "retailer1"}.
chain_metadataobject- Chain metadata keyed by chain slug. Example: {"mcdonalds": {"availableDeals": false}}.
place_filtersobject- Place filters, for example chain slugs to include. Example: {"chain": ["mcdonalds"]}.
radar_trackRecord a location update for a user or device from your server, creating the user if needed.WriteTrack Location
Record a location update for a user or device from your server, creating the user if needed. Returns the user and any events generated (geofence entries and exits, trip updates, place visits). Use List Users or Get User to read users without sending a location.
Inputs
accuracynumberrequired- The accuracy of the user's current latitude and longitude, in meters. A number greater than 0. Used when evaluating the confidence of geofence events. Example: 10.
device_idstringrequired- A device ID for the user. Used to identify logged out users. Example: C305F2DB-56DC-404F-B6C1-BC52F0B680D8.
latitudenumberrequired- The user's current latitude. A number between -90 and 90. Example: 40.7041.
longitudenumberrequired- The user's current longitude. A number between -180 and 180. Example: -73.9867.
altitudenumber- An altitude in meters. Example: 15.
descriptionstring- An optional description for the user, displayed in the dashboard. Example: Brooklyn store.
device_makestring- The manufacturer of the device. Example: Apple.
device_modelstring- The model of the device. Example: iPhone15,2.
device_osstring- The operating system of the device. Example: 17.4.
device_typestring- The user's device type, one of iOS, Android, or Web. Example: iOS.one of
iOSAndroidWeb foregroundboolean- true if the client is in the foreground, false if the client is in the background. Example: true.
metadataobject- An optional dictionary of custom metadata for the user. Up to 32 keys and values of type string, boolean, or number. Example: {"store_type": "flagship"}.
replayedboolean- true if the location is replayed, false if the location is not replayed. Defaults to false. Example: false.
stoppedboolean- true if the user is stopped, false if the user is moving. Example: false.
updated_atstring- The client timestamp or historical timestamp when the user's location was updated. Historical data must be upserted in chronological order. Optional, defaults to the current server timestamp if not provided or not in chronological order. A date or valid ISO date string. Example: 2026-11-16T14:30:00Z.
user_idstring- A stable unique ID for the user. Used with deviceId to identify logged in users. Not required for logged out users. Example: user-123.
vertical_accuracynumber- A vertical accuracy in meters. Example: 5.
radar_trip_createStart tracking a trip for a user toward a destination geofence, such as a pickup or delivery.WriteCreate Trip
Start tracking a trip for a user toward a destination geofence, such as a pickup or delivery. Returns the new trip with status and ETA. Use Update Trip to change its status. Use Delete Trip to remove it.
Inputs
external_idstringrequired- A stable unique ID for the trip. Depending on your use case, it may represent an order ID, a delivery ID, or something else. Example: 123.
approaching_thresholdnumber- For trips with a destination, the trip approaching threshold setting for the trip (in minutes). Overrides the geofence-level and project-level trip approaching threshold settings. Example: 5.
destination_geofence_external_idstring- For trips with a destination, the external ID of the destination geofence. Example: 123.
destination_geofence_tagstring- For trips with a destination, the tag of the destination geofence. Example: store.
metadataobject- An optional set of custom key-value pairs for the trip. Example: {"store_type": "flagship"}.
modestring- The travel mode for the trip. A string, one of foot, bike, and car. Defaults to car. Example: car.one of
footbikecar scheduled_arrival_atstring- Required for the Olo order firing integration, the backstop datetime when the device on the trip is expected to arrive. The order will be fired approachingThreshold minutes before scheduledArrivalAt. Example: 2026-11-16T18:00:00Z.
user_idstring- The external ID of the user for which the trip is being tracked. Example: user-123.
radar_trip_updateChange a trip's status (for example to completed or canceled), mode, destination or metadata.WriteUpdate Trip
Change a trip's status (for example to completed or canceled), mode, destination or metadata. Returns the updated trip. Use Get Trip to read the current state.
- Idempotent
Inputs
statusstringrequired- The new status of the trip, one of pending,started, approaching, arrived, completed, or canceled. Example: started.one of
pendingstartedapproachingarrivedcompletedcanceled trip_idstringrequired- The trip's Radar _id or externalId. Example: 56db1f4613012711002229f4.
approaching_thresholdnumber- For trips with a destination, the trip approaching threshold setting for the trip (in minutes). Overrides the geofence-level and project-level trip approaching threshold settings. Example: 5.
destination_geofence_external_idstring- For trips with a destination, the external ID of the destination geofence. Example: 123.
destination_geofence_tagstring- For trips with a destination, the tag of the destination geofence. Example: store.
metadataobject- An optional set of custom key-value pairs for the trip. Example: {"store_type": "flagship"}.
modestring- The travel mode for the trip. A string, one of foot, bike, and car. Example: car.one of
footbikecar scheduled_arrival_atstring- Required for the Olo order firing integration, the backstop datetime when the device on the trip is expected to arrive. The order will be fired approachingThreshold minutes before scheduledArrivalAt. Example: 2026-11-16T18:00:00Z.
radar_users_refreshAsk up to 10 users' devices to send a fresh location through a silent push.WriteRequest Location Refresh
Ask up to 10 users' devices to send a fresh location through a silent push. Returns the request result; devices then call track. Needs silent push set up in the Radar project and SDK.
Inputs
user_idsarrayrequired- An array of user IDs to send the track request to. Limit to a maximum of 10 users per request. Example: ["user-123"].
typestring- Choose which type of notification is used, one of silentPush or pushExtension. Example: silentPush.one of
silentPushpushExtension
radar_beacon_deleteDelete a beacon by its Radar _id.DestructiveDelete Beacon
Delete a beacon by its Radar _id. Returns a confirmation. Use List Beacons to find the _id.
- Idempotent
Inputs
beacon_idstringrequired- The beacon's Radar _id. Example: 6109a4b16dbfe3de2cb03924.
radar_geofence_deleteDelete a geofence by its Radar _id.DestructiveDelete Geofence
Delete a geofence by its Radar _id. Returns a confirmation. Use Get Geofence by External ID to find the _id from a tag and external ID.
- Idempotent
Inputs
geofence_idstringrequired- The geofence's Radar _id. Example: 56db1f4613012711002229f5.
radar_trip_deleteDelete a trip.DestructiveDelete Trip
Delete a trip. Returns a confirmation. Use Update Trip with status canceled to keep the record instead.
- Idempotent
Inputs
trip_idstringrequired- The trip's Radar _id or externalId. Example: 56db1f4613012711002229f4.
radar_user_deleteDelete a tracked user and their location data.DestructiveDelete User
Delete a tracked user and their location data. Returns a confirmation. Use Get User to check the user first.
- Idempotent
Inputs
user_idstringrequired- The user's Radar _id, userId or deviceId. Example: 56db1f4613012711002229f4.
No tools match.