/placekey/generate

POST /api/placekey/generate

Price: 5 credits

Generate the Placekey for a street address or a named place at an address

How to use it

Turn one structured address into its Placekey, a location id for joining place datasets. Pass location_name only when you want the id of a business or landmark at the address; without it the placekey is the address placekey. Send every address part you have: a street with a city alone can be too little to match, and leaving out the postal code can resolve to a different id. Read confidence_score before joining on the id, since an address sent with the wrong country still returns a LOW match. Parcel and census identifiers come back for US addresses only.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• street_address string required — Street address, including any suite or apartment number (examples: "1600 Pennsylvania Ave NW", "48750 Seminole Dr Ste 105", "10 Downing Street"; minLength: 1; maxLength: 300)
• country string required — ISO 3166-1 alpha-2 country code (examples: "US", "CA", "GB"; pattern: ^[A-Za-z]{2}$)
• city string nullable — City or town (examples: "Washington", "Toronto", "London"; maxLength: 200)
• region string nullable — State, province or other first-level region (examples: "DC", "ON", "California"; maxLength: 200)
• postal_code string nullable — Postal or ZIP code (examples: "20500", "M5V 3L9", "SW1A 2AA"; maxLength: 20)
• location_name string nullable — Name of the business or point of interest at the address (examples: "Starbucks", "CN Tower"; maxLength: 300)

Response

• @type string (default: "PlacekeyPlace")
• placekey string required
• address_placekey string nullable
• building_placekey string nullable
• confidence_score string nullable
• gers_id string nullable
• upi string nullable
• parcel_number string nullable
• geoid string nullable
• latitude number nullable
• longitude number nullable
• geocode_precision string nullable
• normalized_address object nullable
  • @type string (default: "PlacekeyNormalizedAddress")
  • primary_number string nullable
  • street_predirection string nullable
  • street_prefix string nullable
  • street_name string nullable
  • street_suffix string nullable
  • street_postdirection string nullable
  • formatted_street string nullable
  • secondary_designator string nullable
  • secondary_number string nullable
  • city string nullable
  • region string nullable
  • postal_code string nullable
  • country_code string nullable

Errors

• 422 — Not enough address fields to generate a Placekey Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The address could not be matched to a Placekey Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.