Predictions

Resolve a Google place ID to a PurpleGrain place

Resolve a Google Places place ID into a PurpleGrain address or city. Returns the supplied place ID, the lookup time as created_at, and the resolved place relationship; use include=place to embed that place. Sends the place ID to Google Places and may create local address, city and location reference records. This is a place-resolution operation with possible writes, rather than a read of an existing prediction record.

get/predictions/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/predictions/{id}
  • Auth: none declared

Path parameters

idstring required

Google Places place ID to resolve, such as a place_id from a place search result.

Query parameters

includestring
Example:place

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; max 10 paths. Allowed paths: place.

Response

Successful. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "prediction"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.