Get Suggested Radius

Take the guesswork out of working out a suitable radius around your business when searching for events.

The Suggested Radius API returns a radius for finding events around a business location. Rather than guessing an appropriate distance, the API calculates a radius based on factors including population density, local event patterns, and industry.

Use the returned radius as the spatial input for Events API queries, Features API calls, Beam, and demand forecasting workflows.

We recommend caching the response and refreshing monthly - the radius for a given location changes infrequently.

Predicted Impact Area is the successor to this API, providing a more accurate representation of event impact than a radius. Suggested Radius remains available and existing implementations are unaffected.

Get Suggested Radius

get

Returns a suggested radius for the given location and industry.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Query parameters

radius_unitstring · enumOptional

The unit of the radius returned.

This will be the unit specified in the radius_unit parameter in the call made.

Default: mPossible values:

industrystring · enumOptional

The industry of interest for which the radius will be calculated. For different industries, the radii will be different based on the various types of events that would impact the location. For example, if you were getting the suggested radius around a hotel you’d specify accommodation as the industry.

E.g. ?industry=accommodation

Default: otherPossible values:

location.originstringRequired

A comma-separated string consisting of the latitude and longitude of the location to find the optimal radius for. For example your store or hotel location.

The format is <latitude>,<longitude>

E.g. ?location.origin=37.747767,-122.455320

Pattern: ^-?\d{1,3}(?:\.\d+)?,\-?\d{1,3}(?:\.\d+)?$

Responses

200

Successful Response

application/json

Response model for the backwards-compatible Suggested Radius API.

radiusnumberRequired

The suggested radius for a given location rounded to 2 decimal places.

radius_unitstring · enumRequired

The unit of the radius returned.

This will be the unit specified in the radius_unit parameter in the call made.

Possible values:

400

Validation Error

application/json

get

/v1/suggested-radius/

HTTPcURLJavaScriptPython

GET /v1/suggested-radius/?location.origin=text HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "radius": 1,
  "radius_unit": "m",
  "location": {
    "lat": "text",
    "lon": "text"
  }
}

Examples

curl

curl -X GET "https://api.predicthq.com/v1/suggested-radius/?location.origin=37.747767,-122.455320&industry=parking&radius_unit=km" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

python

OpenAPI Spec

The OpenAPI spec for Suggested Radius API can be found here.

Guides

Below are some guides relevant to this API:

• Find Events by Latitude/Longitude and Radius