Get Placekeys

GET

Query

Arguments

string

Optional ID echoed back in the response for this query.

string

Name of the point of interest to match, when available.

string

Street address of the place.

string

City where the place is located.

string

Second-level administrative region, such as a US state.

string

Postal code of the place.

string

ISO 2-letter country code. Placekey requires all queries in a batch to use the same iso_country_code when supplied.

number

Latitude in WGS-84 coordinates.

number

Longitude in WGS-84 coordinates.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Try this request

Request

curl --request GET \
  --url "https://embedded.mindcloud.co/v1/universal/placekey/latest/actions/get-placekeys" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --get \
  --data-urlencode 'connectionId=$CONNECTION_ID'

{
  "success": true,
  "data": [
    {
      "addressPlacekey": "string",
      "buildingPlacekey": "string",
      "confidenceScore": 1,
      "geocode": {},
      "normalizedAddress": "string",
      "placekey": "string",
      "queryId": "string"
    }
  ],
  "meta": {}
}