From 9bc04d6605a62484355785a2c66f1c46ed6caeb0 Mon Sep 17 00:00:00 2001 From: Jarred Parrett <91471796+jarredSafegraph@users.noreply.github.com> Date: Thu, 30 May 2024 09:31:38 -0400 Subject: [PATCH] Update README.md (#38) --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 87ce8da..256b6a0 100644 --- a/README.md +++ b/README.md @@ -105,11 +105,13 @@ The `PlacekeyAPI.lookup_placekey` method can be used to lookup the Placekey for >>> "postal_code": "94131", >>> "iso_country_code": "US" >>> } ->>> pk_api.lookup_placekey(**place, fields=["building_placekey","address_placekey"]) +>>> pk_api.lookup_placekey(**place, fields=["building_placekey","address_placekey","confidence_score","gers"]) {'query_id': '0', 'placekey': '227-223@5vg-82n-pgk', 'address_placekey': '227@5vg-82n-pgk', - 'building_placekey': '227@5vg-82n-pgk'} + 'building_placekey': '227@5vg-82n-pgk', + 'confidence_score': 'HIGH', + 'gers': None} ``` The `PlacekeyAPI.lookup_placekeys` method can be used to lookup Placekeys for multiple places. @@ -137,10 +139,23 @@ The `PlacekeyAPI.lookup_placekeys` method can be used to lookup Placekeys for mu >>> "longitude": -122.44283 >>> } >>> ] ->>> pk_api.lookup_placekeys(places) -[{'query_id': 'place_0', 'placekey': '226@5vg-7gq-5mk'}, - {'query_id': 'thisqueryidaloneiscustom', 'placekey': '227-222@5vg-82n-pgk'}, - {'query_id': 'place_2', 'placekey': '@5vg-82n-kzz'}] +>>> pk_api.lookup_placekeys(places, fields=["building_placekey","address_placekey","confidence_score","gers"]) +[{'query_id': 'place_0', + 'placekey': '0rsdbudq45@5vg-7gq-5mk', + 'address_placekey': '0rsdbudq45@5vg-7gq-5mk', + 'building_placekey': '22g@5vg-7gq-5mk', + 'confidence_score': 'HIGH', + 'gers': None}, + {'query_id': 'thisqueryidaloneiscustom', + 'placekey': '227-223@5vg-82n-pgk', + 'address_placekey': '227@5vg-82n-pgk', + 'building_placekey': '227@5vg-82n-pgk', + 'confidence_score': 'HIGH', + 'gers': None}, + {'query_id': 'place_2', + 'placekey': '@5vg-82n-kzz', + 'confidence_score': 'HIGH', + 'gers': None}] ``` Full details on how to query the API and how to get an API key can be found [here](https://docs.placekey.io/).