> For the complete documentation index, see [llms.txt](https://docs.predicthq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.predicthq.com/api/suggested-radius/get-suggested-radius.md).

# 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.

Suggested Radius is deprecated. Use [Predicted Impact Area](/api/impact-area/get-impact-area.md) for new integrations instead.

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

{% hint style="success" %}
[Predicted Impact Area](/api/impact-area/get-impact-area.md) 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.
{% endhint %}

## Get Suggested Radius

> \*\*Deprecated:\*\* Use the \[Predicted Impact Area API]\(<https://docs.predicthq.com/api/impact-area>) instead, which provides a more accurate polygon representation of event impact rather than a simple radius.\
> \
> Returns a suggested radius for the given location and industry.

````json
{"openapi":"3.1.0","info":{"title":"PredictHQ Suggested Radius API","version":"1.0.0"},"tags":[{"name":"Suggested Radius API"}],"servers":[{"url":"https://api.predicthq.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"$API_KEY","description":"Enter your PredictHQ API key. The Bearer prefix is added automatically.\n\nWhen calling the API directly, send: `Authorization: Bearer <YOUR_API_KEY>` as documented at [https://docs.predicthq.com/api/overview/authenticating](https://docs.predicthq.com/api/overview/authenticating)\n"}},"schemas":{"RadiusUnit":{"description":"The unit of the radius returned.\n\nThis will be the unit specified in the radius_unit parameter in the call made.\n\n- `m` — Meters\n- `km` — Kilometers\n- `ft` — Feet\n- `mi` — Miles","type":"string","enum":["m","km","ft","mi"],"title":"RadiusUnit"},"Industry":{"description":"The industry category of the business location.\n\nDifferent industries have different event impact profiles, which affect the\nreturned suggested radius.\n\n- `accommodation` — Accommodation providers, travel tech, and OTAs\n- `cpg` — Consumer packaged goods companies\n- `tourism` — Leisure, travel, and tourism businesses (e.g. Expedia, DMOs, travel platforms)\n- `marketing` — Advertising and marketing services\n- `parking` — Parking facility operators\n- `restaurants` — Food and beverage businesses including restaurant groups\n- `retail` — Non-food retail and retail tech\n- `transportation` — On-demand transport and delivery\n- `other` — All other industries","type":"string","enum":["accommodation","restaurants","retail","parking","cpg","tourism","marketing","transportation","other"],"title":"Industry"},"SuggestedRadiusResponse":{"description":"Response model for the backwards-compatible Suggested Radius API.","type":"object","properties":{"radius":{"description":"The suggested radius for a given location rounded to 2 decimal places.","type":"number","title":"Radius"},"radius_unit":{"description":"The unit of measurement for the radius","$ref":"#/components/schemas/RadiusUnit"},"location":{"description":"Origin location","$ref":"#/components/schemas/LocationResponse"}},"required":["radius","radius_unit","location"],"title":"SuggestedRadiusResponse"},"LocationResponse":{"description":"The origin location coordinates provided in the request.\n\nE.g.:\n```json\n{\n  \"lat\": \"37.747767\",\n  \"lon\": \"-122.455320\"\n}\n```","type":"object","properties":{"lat":{"description":"Latitude of the location","type":"string","title":"Lat"},"lon":{"description":"Longitude of the location","type":"string","title":"Lon"}},"required":["lat","lon"],"title":"Location"},"HTTPValidationError":{"type":"object","properties":{"error":{"description":"Error summary message","type":"string","title":"Error"},"details":{"description":"List of validation error details","type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDetail"},"title":"Details"}},"required":["error","details"],"title":"HTTPValidationError"},"ValidationErrorDetail":{"type":"object","properties":{"field":{"description":"The field that failed validation","type":"string","title":"Field"},"msg":{"description":"The validation error message","type":"string","title":"Message"},"type":{"description":"The type of validation error","type":"string","title":"Error Type"}},"required":["field","msg","type"],"title":"ValidationErrorDetail"},"ErrorResponse":{"type":"object","properties":{"error":{"description":"Error message","type":"string","title":"Error"}},"required":["error"],"title":"ErrorResponse"}}},"paths":{"/v1/suggested-radius/":{"get":{"operationId":"get_suggested_radius","summary":"Get Suggested Radius","description":"**Deprecated:** Use the [Predicted Impact Area API](https://docs.predicthq.com/api/impact-area) instead, which provides a more accurate polygon representation of event impact rather than a simple radius.\n\nReturns a suggested radius for the given location and industry.","parameters":[{"name":"radius_unit","in":"query","description":"Unit in which the suggested radius will be returned.\nThe default unit is m\n\nPossible values:\n- `m` - meters (default)\n- `km` - kilometers\n- `ft` - feet\n- `mi` - miles\n\n\nE.g. `?radius_unit=km`","required":false,"schema":{"default":"m","$ref":"#/components/schemas/RadiusUnit"}},{"name":"industry","in":"query","description":"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.\n\n\nE.g. `?industry=accommodation`","required":false,"schema":{"default":"other","$ref":"#/components/schemas/Industry"}},{"name":"location.origin","in":"query","description":"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.\n\n\nThe format is `<latitude>,<longitude>`\n\n\nE.g. `?location.origin=37.747767,-122.455320`","required":true,"schema":{"type":"string","pattern":"^-?\\d{1,3}(?:\\.\\d+)?,\\-?\\d{1,3}(?:\\.\\d+)?$"},"explode":false,"style":"form"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestedRadiusResponse"}}}},"400":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":true,"tags":["Suggested Radius API"]}}}}
````

## Examples

The following examples request a suggested radius for a parking business:

{% tabs %}
{% tab title="curl" %}

```bash
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 $API_TOKEN"
```

{% endtab %}

{% tab title="python" %}

```python
import requests

response = requests.get(
    url="https://api.predicthq.com/v1/suggested-radius/",
    headers={
      "Authorization": "Bearer $API_TOKEN",
      "Accept": "application/json"
    },
    params={
        "location.origin": "37.747767,-122.455320",
        "industry": "parking",
        "radius_unit": "km"
    }
)

print(response.json())
```

{% endtab %}
{% endtabs %}

## OpenAPI spec

See the [OpenAPI spec for the Suggested Radius API](https://api.predicthq.com/docs/?urls.primaryName=Suggested+Radius+API).

## Guides

These guides are relevant to this API:

* [Create a Saved Location](/api/saved-locations/create-a-saved-location.md)
* [Get Predicted Impact Area](/api/impact-area/get-impact-area.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.predicthq.com/api/suggested-radius/get-suggested-radius.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.