Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / CRM

Find local businesses

Local businesses of one kind around a city, from Overture Maps' open data (places from Meta, Microsoft, Foursquare and others; free to use, with credit to the Overture Maps Foundation): names, websites, phone numbers, emails and addresses, open ones Overture is fairly sure of, the surest first. Nothing is saved: add the ones you want to a list with POST /lists/{id}/places. The area is a radius around the city's center, by default one that grows with its population. A city's first search can take up to a minute; answers are kept, so the next is quick.

post/api/v1/places/search

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.
Scopescrm:read

Other ways to call it

CLItroopy places search
MCP tooltroopy_search_places
Rate limit20 calls in 60 seconds, for each key

Body

application/json
category*string

A place category, like dental_clinic, plumbing or coffee_shop: GET /places/categories finds them

At most 80 characters

city*string

At least 1 characters · At most 100 characters

country*string

The city's country, as two letters: US, GB, IN

regionstring

Its state or region, when the name is common: TX, or US-TX

At most 10 characters

radiusKmnumber

How far from the city's center, in kilometres

At least 1 · At most 100

limitinteger

Default 50 · At least 1 · At most 200

offsetinteger

Default 0 · At least 0 · At most 10000

Response

200 · application/json
data*object
3 properties
center*object

Where it looked

4 properties
name*string
lat*number
lon*number
radiusKm*number
places*array<object>
15 properties
id*string

Overture's id for it, stable across its releases

name*string
category*string | null

Its most precise category

website*string | null
domain*string | null

Its website's domain, unless that site is a page on a site many businesses share

phone*string | null
email*string | null
address*string | null
city*string | null
region*string | null
postcode*string | null
country*string | null
lat*number
lon*number
confidence*number

How sure Overture is that it exists, 0 to 1

more*boolean

There are more: ask again with offset

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.