Address Proximity Search

Address proximity search using location.

A reverse geo search functionality will enable the company to provide customers with personalized recommendations for nearby merchants that accept their card, enhancing the overall customer experience and driving card usage.

INPUTS Required:

Dataset to Search (e.g., premium-address-points) Location (expressed as Lat/Long, country) from where to start a Search Distance to Search and/or Max Results to return

post/v1/proximity-search

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/proximity-search
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

Example request

{
  "preferences": {
    "dataset": "premium-address-points",
    "maxResults": 10,
    "customPreferences": {
      "CLOSEST": "true"
    },
    "distance": {
      "value": 25,
      "distanceUnit": "METER"
    },
    "borderBufferKm": 25,
    "autoRoute": true,
    "clientCoordSystemName": "EPSG:4326"
  },
  "location": {
    "addressId": "1",
    "longitude": -73.704719,
    "latitude": 42.682251,
    "country": "USA"
  }
}

Response

Address proximity search successfully

Example response

{
  "response": {
    "addressId": "1",
    "errorMessage": "Not able to identify dataset",
    "status": "OK",
    "results": [
      {
        "distance": 0.42,
        "location": {
          "latitude": 40.7887,
          "longitude": -73.0393
        },
        "metadata": {
          "COUNTRY": "USA",
          "POSTALCODE": "00501"
        }
      }
    ]
  }
}

Changes

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