Skip to main content
POST
/
placematch
Placematch
curl --request POST \
  --url https://api.reprompt.io/v2/placematch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "place": {
    "name": "Starbucks",
    "full_address": "1585 Broadway, New York, NY 10036",
    "latitude": 40.7614327,
    "longitude": -73.9776216
  }
}
'
{
  "results": [
    {
      "name": "McDonald's",
      "full_address": "1528 Broadway, New York, NY 10036",
      "latitude": 40.7589,
      "longitude": -73.9851,
      "category": "fast_food",
      "categories": [
        "fast_food",
        "restaurant"
      ],
      "source": "overture",
      "is_match": true,
      "confidence": "HIGH",
      "reasoning": "Good match: normalized name similarity and location within acceptable range"
    }
  ],
  "metadata": {
    "total_results": 1,
    "sources_searched": [
      "overture"
    ],
    "search_radius_meters": 200
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token in the format: Bearer YOUR_API_KEY

Headers

​
apiKey
string | null

Query Parameters

​
org_slug
string | null

Body

application/json

Request model for placematch endpoint.

​
place
PlaceInput · object
required

Place to match. In order to match places you need to provide one of the following:

  • Name + Address: Provide place.name + place.full_address
  • Name + Address + Coordinates (most accurate): Provide place.name + place.full_address + place.latitude + place.longitude
​
match_sources
enum<string>[] | null

Sources to search for matches. Defaults to reprompt if not specified.

Reprompt supports multiple backends for matching against:

  • Foursquare OS Places - amazing open data project with 100M+ global POIs (Apache 2.0 license)
  • Overture Places - open map data from the Overture Maps Foundation with 64M+ places (CDLA Permissive 2.0)
  • Our index of places we picked up from crawling the web

Supported data sources for place matching and search.

These sources are available across both the placematch API (for entity resolution) and the find-places API (for geographic search).

Available options:
reprompt,
overture,
foursquare
​
max_matches
integer | null
default:1

Maximum matches per source

Required range: 1 <= x <= 5
​
radius
number | null
default:1000

Search radius in meters

Required range: 50 <= x <= 5000

Response

Successfully matched places

Response model for placematch endpoint.

​
results
PlacematchItem · object[]
required

Array of matched places

​
metadata
PlacematchMetadata · object
required

Operation metadata