{
"message": "success",
"mailing_list_id": 1196,
"failure": false
}{
"message": "No neighbors could be found with search parameters.",
"failure": true
}{
"message": "Unauthorized"
}{
"message": "Not Found"
}{
"message": "An identical radius search purchase was already made from this account within the last 24 hours. Change the search parameters, or wait 24 hours, to buy these leads again.",
"code": "duplicate_radius_search",
"mailing_list_id": 1196,
"order_id": null,
"failure": true
}{
"message": "The given data was invalid.",
"errors": {
"record_count": [
"Test mode is enabled on this account, so a radius search bought via API or Zapier is limited to 5 records per purchase. Nothing was purchased and the account was not charged. Send record_count of 5 or fewer, or turn test mode off in the dashboard under API Settings to buy a full list."
]
},
"failure": true
}Radius Search
This call will purchase a radius search mailing listing and add it to your account. Each record added to the mailing list costs $.05. You can specify the number of records to return (up to 2,500) and the address/postal code to center the search around. You can also specify a mailing_list_id to add the results to an existing mailing list, or leave it blank to create a new mailing list. While API/Zapier Test Mode is enabled on the account, this endpoint is limited to 5 records per purchase — test mode cancels orders, but buying a radius search is not an order and is charged in full, so the limit is what keeps an integration under development from buying a full list by accident.
{
"message": "success",
"mailing_list_id": 1196,
"failure": false
}{
"message": "No neighbors could be found with search parameters.",
"failure": true
}{
"message": "Unauthorized"
}{
"message": "Not Found"
}{
"message": "An identical radius search purchase was already made from this account within the last 24 hours. Change the search parameters, or wait 24 hours, to buy these leads again.",
"code": "duplicate_radius_search",
"mailing_list_id": 1196,
"order_id": null,
"failure": true
}{
"message": "The given data was invalid.",
"errors": {
"record_count": [
"Test mode is enabled on this account, so a radius search bought via API or Zapier is limited to 5 records per purchase. Nothing was purchased and the account was not charged. Send record_count of 5 or fewer, or turn test mode off in the dashboard under API Settings to buy a full list."
]
},
"failure": true
}Authorizations
Bearer token authentication using your thanks.io API key
Body
Street address to use for center of nearest neighbor search.
"123 Main Street"
Postal code to use for center of nearest neighbor search.
"55555"
Number of nearest neighbors to search for. While API/Zapier Test Mode is enabled on the account, a purchase through this endpoint is limited to 5 records; a larger value is refused with a 422 and nothing is bought or charged. Buying from the dashboard is not affected and keeps the full 2,500.
1 <= x <= 25001
ID of the mailing list to add the radius search results to. If not provided, a new mailing list will be created.
1
Which type of records to search for
all, likelytomove, apartmentcomplex, likelytodownsize, likelytorefi, absenteeowner, highnetworth, majorityhomeequity, homefreeclear, underwater, kidsinhousehold, newhomeowner, firsttimehomebuyer, renters, retiring, retired, pool, onlybusinesses, newbusiness Include condos in search.
Append phone and email to each record for an additional fee ($.20 per record).
Use Property Owners Address when searching for a commercial record_type.
Specifies whether to include the search address in the mailing list created.
Was this page helpful?