Skip to main content
POST

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

Number of nearest neighbors to search for.

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

1

​
mailing_list_id
integer

ID of the mailing list to add the radius search results to. If not provided, a new mailing list will be created.

Example:

1

​
record_types
enum<string>
default:all

Which type of records to search for

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

Include condos in search.

​
append_data
boolean
default:false

Append phone and email to each record for an additional fee ($.20 per record).

​
use_property_owner
boolean
default:false

Use Property Owners Address when searching for a commercial record_type.

​
include_search_address
boolean

Specifies whether to include the search address in the mailing list created.

Response

Successful Response

​
message
string
Example:

"success"

​
mailing_list_id
integer
Example:

1196

​
failure
boolean
Example:

false