Mailing Lists

Radius Search Count

Changed on

This call reports how many records a radius search would find, without buying them. Nothing is charged, no mailing list is created, and the call can be repeated freely, so use it to preview a search before purchasing it with the Radius Search endpoint. It accepts the same search parameters with the same defaults, so sending the same payload to both counts exactly what would be bought. Because counting is free, record_count may go up to 10,000 and the API/Zapier Test Mode purchase limit does not apply.

post/mailing-lists-utils/count-radius-search

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/mailing-lists-utils/count-radius-search
  • Auth: HTTP bearer

Request body

addressstring required

Street address to use for center of nearest neighbor search.

postal_codestring required

Postal code to use for center of nearest neighbor search.

record_countinteger required

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

record_types'all' | 'likelytomove' | 'apartmentcomplex' | 'likelytodownsize' | 'likelytorefi' | 'absenteeowner' | 'highnetworth' | 'majorityhomeequity' | 'homefreeclear' | 'underwater' | 'kidsinhousehold' | 'newhomeowner' | 'firsttimehomebuyer' | 'renters' | 'retiring' | 'retired' | 'pool' | 'onlybusinesses' | 'newbusiness'

Which type of records to search for

include_condosboolean

Include condos in search.

Example request

{
  "address": "123 Main Street",
  "postal_code": "55555",
  "record_count": 100
}

Response

Successful Response

statusstring
countinteger

Number of records the search found, up to record_count.

failureboolean

Example response

{
  "status": "success",
  "count": 42
}

Changes