Get a Saved Location

Get an existing Saved Location.

Get a Saved Location

get

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

Path parameters

location_idstringRequired

An existing Saved Location ID.

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/saved-locations/{location_id}

HTTPcURLJavaScriptPython

GET /v1/saved-locations/{location_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "location_id": "7sdevIveOuIQmP0EL1lZoQ",
  "create_dt": "2025-11-17T19:11:43+00:00",
  "update_dt": "2025-11-17T19:11:43+00:00",
  "enrich_dt": "2025-11-17T19:11:45+00:00",
  "insights_dt": "2025-11-17T19:11:46+00:00",
  "name": "San Francisco",
  "place_ids": [
    5391959
  ],
  "formatted_address": "San Francisco, San Francisco County, California, United States [Locality]",
  "places": [
    {
      "place_id": 5391959,
      "type": "locality",
      "name": "San Francisco",
      "county": "San Francisco County",
      "region": "California",
      "country": "US",
      "geojson": {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.41942,
            37.77493
          ]
        }
      }
    }
  ],
  "summary_insights": [
    {
      "date_range": {
        "type": "next_90d",
        "start_dt": "2025-11-17T19:11:46+00:00",
        "end_dt": "2026-02-15T19:11:46+00:00"
      },
      "phq_attendance_sum": 2670581,
      "attended_event_count": 2568,
      "non_attended_event_count": 113,
      "unscheduled_event_count": 2,
      "pes_total_sum": 232505682,
      "pes_accommodation_sum": 88335769,
      "pes_hospitality_sum": 108671383,
      "pes_transportation_sum": 35496672
    }
  ],
  "subscription_valid_types": [
    "events",
    "features_api"
  ],
  "status": "active"
}

Examples

curl

curl --location 'https://api.predicthq.com/v1/saved-locations/_4Dl3p4Q2zl4ifMjG4Z3ew' \
--header 'Authorization: Bearer TOKEN'

python

OpenAPI Spec

The OpenAPI spec for Saved Locations API can be found here.

Guides

Below are some guides relevant to this API:

• Working with Location-Based Subscriptions