Skip to main content
POST
Radius Search Count

Authorizations

Authorization
string
header
required

Bearer token authentication using your thanks.io API key

Body

application/json
address
string
required

Street address to use for center of nearest neighbor search.

Example:

"123 Main Street"

postal_code
string
required

Postal code to use for center of nearest neighbor search.

Example:

"55555"

record_count
integer
required

Maximum number of nearest neighbors to count. The response reports how many records the search actually finds, up to this number.

Required range: 1 <= x <= 10000
Example:

100

record_types
enum<string>
default:all

Which type of records to search for

Available options:
all,
likelytomove,
apartmentcomplex,
likelytodownsize,
likelytorefi,
absenteeowner,
highnetworth,
majorityhomeequity,
homefreeclear,
underwater,
kidsinhousehold,
newhomeowner,
firsttimehomebuyer,
renters,
retiring,
retired,
pool,
onlybusinesses,
newbusiness
include_condos
boolean
default:true

Include condos in search.

Response

Successful Response

status
string
Example:

"success"

count
integer

Number of records the search found, up to record_count.

Example:

42

failure
boolean
Example:

false