{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Welcome","link":"/","routeSlug":"/"},{"type":"group","label":"Criteria","items":[{"type":"link","fsPath":"criteria.md","metadata":{"type":"markdown"},"label":"Understanding Criteria","link":"/criteria","routeSlug":"/criteria"},{"type":"link","fsPath":"criteria_reference.md","metadata":{"type":"markdown"},"label":"Criteria Reference","link":"/criteria_reference","routeSlug":"/criteria_reference"}]},{"type":"group","label":"API Reference","items":[{"type":"link","label":"PropertyRadar API","link":"/api","routeSlug":"/api"},{"type":"group","label":"Properties","link":"/api/properties","routeSlug":"/api/properties","items":[{"label":"Evictions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/get/properties/radarid/evictions","routeSlug":"/api/properties/get/properties/radarid/evictions","metadata":{"seo":{"title":"Evictions","description":"Returns information about the eviction records of a property."}},"httpPath":"/v1/properties/{RadarID}/evictions"},{"label":"Property from RadarID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/get/properties/radarid","routeSlug":"/api/properties/get/properties/radarid","metadata":{"seo":{"title":"Property from RadarID","description":"Returns information about the property.  Use Fields param to choose fields or fieldsets to be returned.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/properties/{RadarID}"},{"label":"Properties from criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/post/properties","routeSlug":"/api/properties/post/properties","metadata":{"seo":{"title":"Properties from criteria","description":"Returns properties info based on the passed Criteria and Fields.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/properties"},{"label":"Comparable sales","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/get/properties/radarid/comps/sales","routeSlug":"/api/properties/get/properties/radarid/comps/sales","metadata":{"seo":{"title":"Comparable sales","description":"Returns recent sales comps by looking up subject via RadarID. You can override the subject property values such as Beds, Bath, SqFt, etc. using the corresponding query params.  This is useful if the public records data for the subject property is incorrect, or you want to consider a \"what-if\" scenario.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/properties/{RadarID}/comps/sales"},{"label":"Comparable listings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/get/properties/radarid/comps/forsale","routeSlug":"/api/properties/get/properties/radarid/comps/forsale","metadata":{"seo":{"title":"Comparable listings","description":"Sale listings comps by looking up subject via RadarID. You can override the subject property values such as Beds, Bath, SqFt, etc. using the corresponding query params.  This is useful if the public records data for the subject property is incorrect, or you want to consider a \"what-if\" scenario.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/properties/{RadarID}/comps/forsale"},{"label":"Parcel boundaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/get/properties/radarid/parcels","routeSlug":"/api/properties/get/properties/radarid/parcels","metadata":{"seo":{"title":"Parcel boundaries","description":"Returns the parcel shapes for a given RadarID. Make sure to iterate over the results to build a complete parcel shape for instance in cases where a parcel is bisected by a road."}},"httpPath":"/v1/properties/{RadarID}/parcels"},{"label":"Transaction history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/properties/get/properties/radarid/transactions","routeSlug":"/api/properties/get/properties/radarid/transactions","metadata":{"seo":{"title":"Transaction history","description":"Returns filtered transaction history including user modifications. Fields defaults to the backward-compatible Standard fieldset; custom field lists accept at most 50 field IDs.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/properties/{RadarID}/transactions"}]},{"type":"group","label":"Persons","link":"/api/persons","routeSlug":"/api/persons","items":[{"label":"Owners of a property","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/get/properties/radarid/persons","routeSlug":"/api/persons/get/properties/radarid/persons","metadata":{"seo":{"title":"Owners of a property","description":"View information about the owners of a property."}},"httpPath":"/v1/properties/{RadarID}/persons"},{"label":"Bankruptcies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/get/persons/personkey/bankruptcies","routeSlug":"/api/persons/get/persons/personkey/bankruptcies","metadata":{"seo":{"title":"Bankruptcies","description":"Returns information about the bankruptcy records of a person.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/persons/{PersonKey}/bankruptcies"},{"label":"Divorces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/get/persons/personkey/divorces","routeSlug":"/api/persons/get/persons/personkey/divorces","metadata":{"seo":{"title":"Divorces","description":"Returns information about divorce cases for a person."}},"httpPath":"/v1/persons/{PersonKey}/divorces"},{"label":"Liens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/get/persons/personkey/liens","routeSlug":"/api/persons/get/persons/personkey/liens","metadata":{"seo":{"title":"Liens","description":"Returns lien records for a person."}},"httpPath":"/v1/persons/{PersonKey}/liens"},{"label":"Probates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/get/persons/personkey/probates","routeSlug":"/api/persons/get/persons/personkey/probates","metadata":{"seo":{"title":"Probates","description":"Returns information about the probate records for a person."}},"httpPath":"/v1/persons/{PersonKey}/probates"},{"label":"Purchase a person’s phone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/post/persons/personkey/phone","routeSlug":"/api/persons/post/persons/personkey/phone","metadata":{"seo":{"title":"Purchase a person’s phone","description":"Purchase a phone for a specific person.  You can obtain the PersonKey you needby using the Property from RadarID or Properties from Criteria endpointswhile requesting the Persons field, (e.g. ?Fields=overview,Persons).  Or you can use theOwners of a property endpoint."}},"httpPath":"/v1/persons/{PersonKey}/Phone"},{"label":"Purchase a person’s email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/post/persons/personkey/email","routeSlug":"/api/persons/post/persons/personkey/email","metadata":{"seo":{"title":"Purchase a person’s email","description":"Purchase a email for a specific person.  You can obtain the PersonKey you needby using the Property from RadarID or Properties from Criteria endpointswhile requesting the Persons field, (e.g. ?Fields=overview,Persons).  Or you can use theOwners of a property endpoint."}},"httpPath":"/v1/persons/{PersonKey}/Email"},{"label":"Relatives","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/persons/get/persons/personkey/relatives","routeSlug":"/api/persons/get/persons/personkey/relatives","metadata":{"seo":{"title":"Relatives","description":"Returns information about the relatives of a person"}},"httpPath":"/v1/persons/{PersonKey}/relatives"}]},{"type":"group","label":"Lists","link":"/api/lists","routeSlug":"/api/lists","items":[{"label":"Create a list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/post/lists","routeSlug":"/api/lists/post/lists","metadata":{"seo":{"title":"Create a list","description":"Creates a new list from a Criteria object. Learn about the types of lists you can create."}},"httpPath":"/v1/lists"},{"label":"View all lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/get/lists","routeSlug":"/api/lists/get/lists","metadata":{"seo":{"title":"View all lists","description":"Returns all the lists for this user, ordered by count, then by name alphabetically"}},"httpPath":"/v1/lists"},{"label":"View a list’s details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/get/lists/listid","routeSlug":"/api/lists/get/lists/listid","metadata":{"seo":{"title":"View a list’s details","description":"Returns a single list by Id"}},"httpPath":"/v1/lists/{ListID}"},{"label":"Update the attributes of a list","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/patch/lists/listid","routeSlug":"/api/lists/patch/lists/listid","metadata":{"seo":{"title":"Update the attributes of a list","description":"Updates the attributes of a list, except for Criteria."}},"httpPath":"/v1/lists/{ListID}"},{"label":"Delete a list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/delete/lists/listid","routeSlug":"/api/lists/delete/lists/listid","metadata":{"seo":{"title":"Delete a list","description":"Deletes a list"}},"httpPath":"/v1/lists/{ListID}"},{"label":"View list items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/get/lists/listid/items","routeSlug":"/api/lists/get/lists/listid/items","metadata":{"seo":{"title":"View list items","description":"View the RadarIDs for all items in a list."}},"httpPath":"/v1/lists/{ListID}/items"},{"label":"Add items to list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/put/lists/listid/items","routeSlug":"/api/lists/put/lists/listid/items","metadata":{"seo":{"title":"Add items to list","description":"Adds one or more properties defined by criteria to a list, this doesn't apply to a dynamic or import list.<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/lists/{ListID}/items"},{"label":"Delete an item from a list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/lists/delete/lists/listid/items/radarid","routeSlug":"/api/lists/delete/lists/listid/items/radarid","metadata":{"seo":{"title":"Delete an item from a list","description":"Deletes a property from a list<details><summary>Click here for fieldsets</summary>"}},"httpPath":"/v1/lists/{ListID}/items/{RadarID}"}]},{"type":"group","label":"Suggestions","link":"/api/suggestions","routeSlug":"/api/suggestions","items":[{"label":"View address suggestions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/suggestions/post/suggestions/siteaddress","routeSlug":"/api/suggestions/post/suggestions/siteaddress","metadata":{"seo":{"title":"View address suggestions","description":"Returns Site Addresses based on SuggestionInput and an optional criteria object. Returns a criteria object which specifies City, State, etc. for the given address."}},"httpPath":"/v1/suggestions/SiteAddress"},{"label":"View FIPS and Counties","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/suggestions/post/suggestions/county","routeSlug":"/api/suggestions/post/suggestions/county","metadata":{"seo":{"title":"View FIPS and Counties","description":"Returns valid Counties and their associated FIPS based on SuggestionInput and an optional criteria object. Returns a criteria object which specifies the FIPS for the given County."}},"httpPath":"/v1/suggestions/County"}]},{"type":"group","label":"Integrations","link":"/api/integrations","routeSlug":"/api/integrations","items":[{"label":"View all webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/integrations/get/integrations/webhooks","routeSlug":"/api/integrations/get/integrations/webhooks","metadata":{"seo":{"title":"View all webhooks","description":"Returns all active webhooks"}},"httpPath":"/v1/integrations/webhooks"},{"label":"Register new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/integrations/post/integrations/webhooks","routeSlug":"/api/integrations/post/integrations/webhooks","metadata":{"seo":{"title":"Register new webhook","description":"Creates a new webhook"}},"httpPath":"/v1/integrations/webhooks"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/integrations/delete/integrations/webhooks/webhookid","routeSlug":"/api/integrations/delete/integrations/webhooks/webhookid","metadata":{"seo":{"title":"Delete a webhook","description":"Deletes an existing webhook given the Id"}},"httpPath":"/v1/integrations/webhooks/{WebhookID}"}]},{"type":"group","label":"Imports","link":"/api/imports","routeSlug":"/api/imports","items":[{"label":"Match and import to list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/imports/post/lists/listid/import/items","routeSlug":"/api/imports/post/lists/listid/import/items","metadata":{"seo":{"title":"Match and import to list","description":"Import records into a given list and match them. The request body is a JSON array of items to be imported for matching."}},"httpPath":"/v1/lists/{ListID}/import/items"},{"label":"View imported matches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/imports/get/lists/listid/import/items","routeSlug":"/api/imports/get/lists/listid/import/items","metadata":{"seo":{"title":"View imported matches","description":"List the imported items with match info."}},"httpPath":"/v1/lists/{ListID}/import/items"},{"label":"Update an import match","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/imports/patch/lists/listid/import/items/listimportitemid","routeSlug":"/api/imports/patch/lists/listid/import/items/listimportitemid","metadata":{"seo":{"title":"Update an import match","description":"Update an import match"}},"httpPath":"/v1/lists/{ListID}/import/items/{ListImportItemID}"},{"label":"Remove import match","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/imports/delete/lists/listid/import/items/listimportitemid","routeSlug":"/api/imports/delete/lists/listid/import/items/listimportitemid","metadata":{"seo":{"title":"Remove import match","description":"Delete an import match and revert actions such as setting primary contact."}},"httpPath":"/v1/lists/{ListID}/import/items/{ListImportItemID}"}]},{"type":"group","label":"Automations","link":"/api/automations","routeSlug":"/api/automations","items":[{"label":"Update an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/automations/put/lists/listid/automations","routeSlug":"/api/automations/put/lists/listid/automations","metadata":{"seo":{"title":"Update an automation","description":"Update an existing automation or configure new automation for a list."}},"httpPath":"/v1/lists/{ListID}/automations"},{"label":"View an automation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/automations/get/lists/listid/automations","routeSlug":"/api/automations/get/lists/listid/automations","metadata":{"seo":{"title":"View an automation","description":"View the details of the automation for the list."}},"httpPath":"/v1/lists/{ListID}/automations"}]},{"type":"group","label":"Accounts","link":"/api/accounts","routeSlug":"/api/accounts","items":[{"label":"View the account's members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/get/accounts/members","routeSlug":"/api/accounts/get/accounts/members","metadata":{"seo":{"title":"View the account's members","description":"View all members of an account.This service merges the users from account_members and account_invitations."}},"httpPath":"/v1/accounts/members"},{"label":"View status level labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/accounts/get/accounts/preferences/statuses","routeSlug":"/api/accounts/get/accounts/preferences/statuses","metadata":{"seo":{"title":"View status level labels","description":"View the labels associated with each of the 9 status levels."}},"httpPath":"/v1/accounts/preferences/statuses"}]},{"type":"group","label":"Documents","link":"/api/documents","routeSlug":"/api/documents","items":[{"label":"Document details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/documents/get/documents/documentid","routeSlug":"/api/documents/get/documents/documentid","metadata":{"seo":{"title":"Document details","description":"Get a specific document by DocumentID. Returns document metadata including recording details, parties, and document type.Examples:"}},"httpPath":"/v1/documents/{DocumentID}"}]}]},{"type":"link","fsPath":"changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/changelog","routeSlug":"/changelog"}]}