## Changelog

### 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

- New response fields in `/properties`
  - [IsListedForSaleByOwner](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/islistedforsalebyowner)
- New `LastTransferType` value on `/properties`: `Non-Market - Correction`
- New criteria
  - [IsListedForSaleByOwner](/criteria_reference#listed-for-sale-by-owner)


#### Changes

- Criteria
  - [Listed for Sale?](/criteria_reference#listed-for-sale): applies to MLS listings only (description updated)
  - [Listing Type](/criteria_reference#listing-type): new value `FSBO`; MLS values relabeled (for example, "Market" becomes "MLS Market")
  - [Transfer Type](/criteria_reference#transfer-type): new value `Non-Market - Correction`
  - `ListingPriceReduced` replaced with [Price Change](/criteria_reference#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

- New criteria
  - [DistressScore](/criteria_reference#distress-score)
  - [inDistress](/criteria_reference#in-distress)
  - [DivorceFilingDate](/criteria_reference#divorce-filing-date)
  - [hasRecentEviction](/criteria_reference#property-has-eviction)
  - [EvictionFilingDate](/criteria_reference#eviction-filing-date)
  - [inProbateProperty](/criteria_reference#property-owner-has-probate)
  - [ProbateFilingDate](/criteria_reference#probate-filing-date)
- New response fields in `/properties`
  - [DistressScore](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/distressscore)
  - [MaxDistanceMiles](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=maxdistancemiles)
  - [hasRecentEviction](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/hasrecenteviction)
  - [EvictionFilings](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/evictionfilings)
  - [inProbateProperty](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/inprobateproperty)
  - [ListingStatusDate](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/listingstatusdate)
  - [isExpiredListing](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=results/isexpiredlisting)
- New Endpoints
  - [/documents/{DocumentID}](/api/documents/get/documents/documentid)
  - [/properties/{RadarID}/evictions](/api/properties/get/properties/radarid/evictions)
  - [/persons/{PersonKey}/probates](/api/persons/get/persons/personkey/probates)
  - [/persons/{PersonKey}/divorces](/api/persons/get/persons/personkey/divorces)
  - [/persons/{PersonKey}/bankruptcies](/api/persons/get/persons/personkey/bankruptcies)
  - [/persons/{PersonKey}/liens](/api/persons/get/persons/personkey/liens)
- New field on every paid endpoint
  - [quantityFreeRemaining](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=quantityfreeremaining) (preview only)
  - [totalCost](/api/properties/get/properties/radarid#properties/get/properties/radarid/t=response&c=200&path=totalcost) (existing but previously always 0 for preview)


#### Fixes

- Documentation restored for [Purchase Email](/api/persons/post/persons/personkey/email) and [Purchase Phone](/api/persons/post/persons/personkey/phone)


#### Changes

- Docs now indicate that Card and Overview fieldsets have special behavior around AVM.
- All Comps-related fields removed from /properties.  Instead use [/properties/{RadarID}/comps/sales](#operation/GET/properties/RadarID/comps/sales) or [/properties/{RadarID}/comps/forsale](#operation/GET/properties/RadarID/comps/forsale)


### 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)