# Comparable listings

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.
Click here for fieldsets#### default
`ItemNumber` `PType` `Latitude` `Longitude` `Address` `City` `Beds` `Baths` `SqFt` `YearBuilt` `DaysOnMarket` `ListingPrice` `ListingPricePerSqFt` `Score` `ListingType` `LotSize` `ListedOn`

Endpoint: GET /v1/properties/{RadarID}/comps/forsale
Version: 5.3.1.0
Security: api_key_bearer, x_radar_access_token

## Security:

  - `api_key_bearer` (unknown)
    http bearer

  - `x_radar_access_token` (unknown)
    apiKey in header X-Radar-Access-Token

## Path parameters:

  - `RadarID` (string, required)
    Unique ID for locating properties within PropertyRadar.

## Query parameters:

  - `Fields` (array)
    A list of fields or fieldsets the client would like returned from the service.  Fields can be suppressed by prepending "-"

  - `Purchase` (integer, required)
    Calls to this endpoint are charged per record returned.  To get a preview of the cost, set Purchase=0.  If Purchase is set to '1' or 'true', you will be charged against your
balance for each record returned according to the terms of your subscription package.  Charges are non-refundable. If you are requesting only RadarIDs `?Fields=RadarID` you won't be charged regardless of the value of Purchase.

  - `Limit` (integer)
    Maximum number of records to return.

  - `PType` (array)
    Override the basic property type of the subject property

  - `Beds` (integer)
    The number of bedrooms in the primary structure.

  - `Baths` (string)
    The number of bathrooms in the primary structure (.5 is toilet and sink only, .75 adds shower but no tub).

  - `Units` (integer)
    The number of units, if the property contains more than one.

  - `SqFt` (integer)
    The square footage of the primary structure.

  - `LotSize` (integer)
    The size of the lot in square feet.

  - `YearBuilt` (string)
    The year the property was built. Note that many counties will only have this data for newer properties after whatever date they began tracking it.

  - `ListingType` (array)
    The type of listing. Either MLS (Market, ShortSale, Auction, REO, QuickSale, Distressed, NonMarket) or FSBO.

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `results` (array)

  - `results.ItemNumber` (string)
    A number to display in the list and on corresponding map icons.
    Example: 1

  - `results.RadarID` (string)
    Unique ID for locating properties within PropertyRadar.

  - `results.Latitude` (number)
    The geographic coordinate in decimal degrees that specifies the north-south position of the center of the property.
    Example: 45.52155

  - `results.Longitude` (number)
    The geographic coordinate in decimal degrees that specifies the east-west position of the center of the property.
    Example: -122.6660

  - `results.Address` (string)
    Street address at which the property is located.
    Example: 123 Main St

  - `results.City` (string)
    City in which the property is located.

  - `results.PType` (string)
    Override the basic property type of the subject property Basic property types, derived and standardized across counties from county Use Codes.
    Enum: "Single Family", "Condominium", "Multi-Family 2-4", "Multi-Family 5+", "Other Res.", "Commercial", "Industrial", "Agricultural", "Land", "Government", "Recreation", "Transport", "Utility", "Other", "Unknown"

  - `results.State` (string)
    State in which the property is located.
    Enum: "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Virginia", "Vermont", "Washington", "West Virginia", "Wisconsin", "Wyoming"

  - `results.Beds` (integer)
    The number of bedrooms in the primary structure.
    Example: 2

  - `results.Baths` (string)
    The number of bathrooms in the primary structure (.5 is toilet and sink only, .75 adds shower but no tub).
    Example: 1.25

  - `results.SqFt` (integer)
    The square footage of the primary structure.
    Example: 2,400

  - `results.Units` (integer)
    The number of units, if the property contains more than one.
    Example: 10

  - `results.LotSize` (integer)
    The size of the lot in square feet.
    Example: 888

  - `results.YearBuilt` (string)
    The year the property was built. Note that many counties will only have this data for newer properties after whatever date they began tracking it.
    Example: 1974

  - `results.Score` (number)
    A number to indicate how closely the property matches the subject property, from 100 for a great match down to just above 0.
    Example: 85.2

  - `results.ListingPrice` (string)
    The asking price of the property listed for sale.
    Example: 89

  - `results.ListedOn` (string)
    The date the property was listed for sale or first detected as listed for sale.
    Example: 1984-01-24

  - `results.ListingStatus` (string)
    The current status of the most recent listing on the property.Do not use together with Listed For Sale or you may get zero or misleading results.

  - `results.ListingType` (string)
    The type of listing. Either MLS (Market, ShortSale, Auction, REO, QuickSale, Distressed, NonMarket) or FSBO.
    Enum: "", "MLS Market", "MLS ShortSale", "MLS REO", "TrusteeSale"

  - `results.ListingPricePerSqFt` (string)
    The listing price divided by the square footage of the property.
    Example: 89

  - `results.DaysOnMarket` (integer)
    The number of days an Active listing has been on the market. Omitted for listings that are not Active.
    Example: 888

  - `totalCost` (string)
    The total amount billed for the records in this response
    Example: 1.00

  - `quantityFreeRemaining` (integer)
    Export credits remaining in the account. Only present for preview (Purchase=false) responses.
    Example: 250

  - `resultCount` (integer)
    The number of records in this response
    Example: 20

## Response 400:

  - `400` (unknown)
    Bad request

## Response 400 fields (application/json):

  - `error` (string)
    A simple explanation of the problem.  Not for display to end users.

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    If present, an explanation suitable for display to end users

  - `messageTitle` (string)
    If present, a title suitable for display to end users

## Response 402:

  - `402` (unknown)
    Insufficient Balance. Returned when the account balance is too low to cover the cost of the purchase this request would incur (i.e. when the request charges for records and `Purchase=1`). Add to your balance to retry; an unpaid cost quote can be obtained with `Purchase=0`.

## Response 402 fields (application/json):

  - `error` (string)
    A simple explanation of the problem.  Not for display to end users.
    Example: Insufficient Balance

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    An explanation suitable for display to end users
    Example: Your account balance is insufficient to process this request. Log in at app.propertyradar.com to Add to Balance, and consider changing your Low Balance Notification and Auto Recharge settings

  - `messageTitle` (string)
    A title suitable for display to end users
    Example: Sorry, Insufficient Balance

## Response 403:

  - `403` (unknown)
    Forbidden. Returned when the access token is valid but the request is denied for authorization reasons. Common cases include an inactive subscription, a missing API or Integrations entitlement, insufficient OAuth scope, or lacking permission for the requested operation. Invalid or expired tokens return 401 instead.

## Response 403 fields (application/json):

  - `error` (string)
    A simple explanation of the problem. Not for display to end users. OAuth denials often use the form `{error_code} - {description}` (for example, `access_denied - ...`). Permission denials typically return `You are not authorized to use this service.`
    Example: You are not authorized to use this service.

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    If present, an explanation suitable for display to end users

  - `messageTitle` (string)
    If present, a title suitable for display to end users

## Response 404:

  - `404` (unknown)
    Not found. Returned when the requested path is unknown, authentication is missing (some routes return 404 rather than 401 to avoid revealing route existence), or a path parameter identifies a resource that does not exist or is not visible to the authenticated account (for example, an invalid RadarID or an ID belonging to another account). This replaces the previous behavior of returning 400 for resource-not-found errors.

## Response 404 fields (application/json):

  - `error` (string)
    A simple explanation of the problem. Not for display to end users. Resource-not-found errors typically return `Resource does not exist for given id`. Unknown paths or missing authentication may return a message indicating the path was not found or authentication is missing.
    Example: Resource does not exist for given id

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    If present, an explanation suitable for display to end users

  - `messageTitle` (string)
    If present, a title suitable for display to end users