Skip to content
Last updated

Changelog

Version 5.3.1.0

Additions

Changes

  • Rate limits strictly enforced, expect HTTP 429 if exceeded.
  • Properties from Criteria: Expired Listing results and signal counts now match Property from RadarID by excluding properties that have been relisted after an expired listing.

Version 5.3.0.1

Additions

  • Property Lien Document Type: added CLN (Property Tax Lien) and ASM (Special Assessment) search values. Document details and transaction history now label ASM as Special Assessment.

Version 5.3.0.0

Changes

  • Export and Public API responses now use the flag field type for distress and status indicators in the Properties Flags template (for example isPreforeclosure, isAuction, isBankOwned, isDeceasedProperty, inBankruptcyProperty). When a flag is false, the field is omitted instead of returning 0 or "No". When true, Public API returns 1 and Export returns '1'. Clients that previously treated explicit 0 as false should treat a missing field as false. Loan-attribute and physical-amenity fields remain yesno with explicit 0/1 values.

Additions

  • Properties from Criteria: added page-token pagination for efficient deep paging. The first request needs no page token; pass each response's nextPageToken as PageToken in the next request. Start remains supported but is deprecated; use PageToken instead. If both are sent, PageToken takes precedence.
  • Street Suffix: added the SiteSuffix Location criterion. Select a supported street-type abbreviation, such as ST, AVE, or RD, and combine it with SiteStreetName to narrow results.

Version 5.2.2.0

Additions

  • Property from RadarID and Properties from Criteria: added property read response fields: isSameCounty and isSameState (owner mailing vs situs jurisdiction), and calculated value fields AssessedValueDividedByAVM, CapRate, and EstCashReturn.
  • Site address suggestions: added a RadarIDs array containing the PropertyRadar identifiers associated with each address. See also Changes below.
  • City suggestions and Subdivision suggestions: added dedicated routes that return matching labels and Criteria.
  • Properties from Criteria: added non-billable aggregate counts when Purchase=0, Limit=0, and TopLevelFields=facets. Responses return no Property records, always include numeric totalResultCount, and return facets only when at least 25 Properties match; otherwise facets is empty.
  • Property from RadarID and Properties from Criteria: added EquityBand and DistressBand response fields, which provide broad estimates in non-billable property previews.
  • Property from RadarID and Properties from Criteria: added the requestable YearsDelinquent response field. It reports 1–4 years or 5 years or more and is omitted when unavailable.
  • New template routes (non-billable; no Purchase parameter):
  • Criteria, Property fields, and Person fields: added a stable GroupID response field and include/exclude filter.
  • Purchase Phone and Purchase Email: added DisplayStatus to returned contact records to describe provenance and edits independently of the deliverability Status. The responses now also fully document returned values, links, contact and deliverability metadata, and sources.
  • Relatives: added the Fields query parameter for response field selection, including MyPersonKey, relative-level RecordStatus, and individual name and address fields: RelativeFirstName, RelativeMiddleName, RelativeLastName, RelativeSuffix, RelativeStreetAddress, RelativeCity, RelativeState, and RelativeZIPCode.
  • Property owners: added requestable fields:
    • Mail address: MailCity, MailState, and MailZipFive
    • Demographics: BirthMonth, Language, BusinessOwner, and HomeBusiness
    • Property ownership: NumberPropertiesOwned
    • Names and notes: AlsoKnownAs and PersonNote
    • Person signals: isDeceased, inBankruptcy, inDivorce, PersonHasOpenLiens, and inProbate. Signal fields return 1 when true and are omitted when false.
  • Property transaction history: added a DocGroup filter that is applied before counting, limiting, and billing.
  • Property transaction history and Document details: added requestable LoanBalance, LoanPayment, and LoanMaturityDate estimates for applicable open mortgage records; unavailable and closed-loan estimates are omitted.

Removals

  • Relatives: removed contact-level status from RelativePhones items. The new RecordStatus field describes the relative result rather than an individual phone.

Changes

  • Property from RadarID: Purchase=0 now returns a non-billable preview containing RadarID, City, State, County, PType, Beds, Baths, SqFt, AVM, isListedForSale, ListingPrice, DaysOnMarket, and EquityBand, with DistressBand also included when the account includes Distress Score. The response also includes a quote for the full record. When Fields is supplied, only requested fields from this allowlist are returned; exact distress and equity values remain excluded.
  • Property transaction history: resultCount is the count after Limit and is used for preview cost estimates; totalResultCount is the filtered count before Limit.
  • Property transaction history: normalized DocGroup response values to the seven values accepted by the new filter.
    • ASN documents previously returned as Assignment now return as Notice.
    • CCR, CNS, CNT, COD, EAS, ENV, HOM, LND, and OPT documents previously returned as Encumbrance now return as Other.
    • LLA, MAP, and RSV documents previously returned as Map now return as Other.
  • Document details: relabeled the CLN document type from "County Tax Lien" to "Property Tax Lien"; the identifier remains CLN.
  • Relatives: successful responses now include resultCount, totalResultCount, and totalCost. Existing relatives report zero cost; newly purchased relatives report the purchase cost.
  • Relatives: RelativeAge is now returned as an integer instead of a string.
  • Comparable for-sale properties: DaysOnMarket is now calculated only for Active listings and omitted for other listing statuses.
  • Purchase Phone and Purchase Email: Purchase=0 for a valid My Person with no owned contact records now returns an empty, zero-cost response instead of HTTP 503.
  • Site address suggestions: Limit now defaults to 25 and rejects values greater than 25; Start is deprecated and should be omitted or set to 0. See Additions above.

Documentation

  • If a field or parameter has a title in the PropertyRadar app that does not exactly match the API field name, it is now displayed alongside the field name.
  • Property from RadarID, Properties from Criteria, and List import items: five-digit ZIP Code fields are now documented as strings instead of integers. This includes ZipFive, OwnerZipFive, and List import item ZipFive.
  • Property owners: OtherProperties is now documented as containing up to 20 currently owned Properties, excluding the Property requested.
  • Comparable sales: PricePerSqFt is documented as the last transfer value divided by square footage.
  • Comparable sales and Comparable for-sale properties: clarified that Score ranges from 100 for a great match down to just above 0.

Version 5.2.1.0

Additions

  • Property transaction history now supports the many detailed response fields previously available only through Document details. Fields defaults to the backward-compatible Standard fieldset and accepts up to 50 field IDs.
  • Property transaction history: added filters for more focused requests.
    • DocType returns only specified document types. E.g. DocType=DOT,GRT to filter to Deeds of Trust & Grant Deeds.
    • RecDate limits results to a date range or period.
    • Limit sets a maximum number of records returned (and billed)
    • DocumentID retrieves a specific document associated with the Property.

Changes

  • Property transaction history: filters are applied before result counting, limiting, and billing; quotes report the filtered count and purchases bill only returned records.
  • /properties response field AVMReliability is correctly documented as an integer, not a string.

Version 5.2.0.0

Additions

Changes

  • Raised OAuth/Public API comma-separated Fields limit from 50 to 500 user-specified field ids per request (named fieldsets such as All and PropertyTab are unchanged). Error message: Exceeded 500 field limit for user-specified fields.
  • List automations: PurchasePhone and PurchaseEmail (0/1 flags) replaced by PurchasePhoneOptions and PurchaseEmailOptions objects with contacts_to_include (all|primary); phones also support has_mobile.
  • Fieldsets for /properties: Likely score fields added to GridOptional.
  • Criteria objects: menuLabels and chipLabel fields documented.

Version 5.1.1.0

Changes

  • Documented 402 Insufficient Balance response on all pay-per-record endpoints (those with a Purchase parameter)
  • Added and documented 403 Forbidden response on all endpoints (authorization and subscription/feature denial when the access token is valid; invalid or expired tokens return 401). Subscription issues previously returned 400.
  • Added and documented 404 Not Found response on all endpoints (unknown path, missing authentication on some routes, or resource ID not found or not visible to the account). Resource-not-found errors previously returned 400.

Version 5.1.0.0

Additions

Changes

  • Criteria
    • Listed for Sale?: applies to MLS listings only (description updated)
    • Listing Type: new value FSBO; MLS values relabeled (for example, "Market" becomes "MLS Market")
    • Transfer Type: new value Non-Market - Correction
    • ListingPriceReduced replaced with Price Change (Was yes/no, now percent range)
  • Fieldsets for /properties
    • isListedForSaleByOwner added to Grid, GridOptional, Card, Mobile, Map, and Overview
    • isExpiredListing added to GridOptional
  • Removed response fields in /properties
    • ListingStatus
    • ListingStatusDate
    • ListingType

Version 5.0.0.2

Changes

  • isSiteVacant and isMailVacant added to Card and Mobile fieldsets

Version 5.0

Additions

Fixes

Changes

Version 4.26.1

  • New documentation format

Version 4.26

  • MRCOO Transfer types (LastTransferType) now include non-market types that result in a change of ownership.
  • New TaxResale type added to both TransferType and LastTransferType.
  • [ClientName] added to /integrations/webhooks.

Version 4.25

  • Improved schema for Polygon and Radius.
  • New LimitSort and LimitNearest Criteria.
  • inDivorceProperty became inDivorce and the description changed.
  • DivorceRecordingDate and DivorceDecreeDate were replaced by DivorceFilingDate.

Version 4.24

  • No changes from Version 4.23

Version 4.23

  • Lists: Added GroupName parameter and resource field for filtering lists by groups. "Audiences" is the only currently supported group.
  • Lists: Added DisplayOrder resource field for controlling list ordering within groups.
  • Lists: Enhanced sorting to include DisplayOrder field.
  • Lists: New endpoint /v1/lists/groups

Version 4.21

  • Updated pay-per-record documentation to clarify RadarID-only requests are free

Version 4.18

  • API docs reorganized so that Criteria is at the top level, preface organized into Welcome, Get started etc.

Version 4.17

  • All errors now in JSON format (previously not found or missing auth returned as HTML)