Properties

Estimate a US property value and rent

Request RentCast provider automated-valuation-model (AVM) value and long-term rent estimates for one US address, plus provider-selected listing comparables. Supply address={formatted or line1+city,region/postal_code optional,country=US}; rent_estimate=false runs only the value request. Success costs50 credits and stores one account-owned prop_rentcast_ observation24h; retained reads1, errors/replay0. Outputs are provider AVM estimates with model bounds (low/high), not appraisals, sale prices, tax assessments or guarantees; comparables are provider-selected and unadjusted. Subject attributes come from the provider lookup. Source: RentCast /avm/value and /avm/rent/long-term, billed per request. Documentation-backed beta; not fresh live-source verification.

POST

properties

estimate

curl --request POST \
  --url https://api.example.com/v1/properties/estimate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "address": {
    "formatted": "<string>",
    "country": "<string>"
  }
}
'

import requests

url = "https://api.example.com/v1/properties/estimate"

payload = { "address": {
        "formatted": "<string>",
        "country": "<string>"
    } }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({address: {formatted: '<string>', country: '<string>'}})
};

fetch('https://api.example.com/v1/properties/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "status": "matched",
    "candidates": [
      {
        "id": "<string>",
        "entity_type": "listing",
        "method": "<string>",
        "source": {
          "platform": "<string>",
          "provider": "<string>",
          "observed_at": "2023-11-07T05:31:56Z",
          "access_class": "public_portal",
          "country": "<string>",
          "native_id": "<string>",
          "url": "<string>",
          "source_updated_at": "2023-11-07T05:31:56Z",
          "retrieved_at": "2023-11-07T05:31:56Z"
        },
        "confidence": 123
      }
    ]
  },
  "meta": {
    "request_id": "<string>",
    "schema_version": "<string>",
    "generated_at": "2023-11-07T05:31:56Z",
    "completeness": "complete",
    "sources": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>",
        "field": "<string>"
      }
    ],
    "pagination": {
      "next_cursor": "<string>",
      "has_more": true,
      "returned": 123,
      "total": 123,
      "total_relation": "exact"
    },
    "property_groups": [
      {
        "property_id": "<string>",
        "listing_ids": [
          "<string>"
        ],
        "match_method": "<string>",
        "status": "matched",
        "confidence": 123
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "details": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "request_id": "<string>"
}

Estimate one US property through RentCast provider automated valuation models. Supply address={formatted:...} or address={line1,city,region or postal_code,country:"US"}; rent_estimate=false skips the long-term rent AVM and halves the provider requests. Success costs 50 credits and stores one combined account-owned estimate observation for24 hours: property summary, estimate provenance record, value and rent valuations, and provider-selected comparables. Both estimates are provider model outputs with low/high bounds: value is point-in-time; rent is labeled monthly long-term rent. Neither is an appraisal, sale price, achievable-rent guarantee or licensed AVM product. Subject property attributes come from the provider lookup, not from public-record verification. Comparables are unadjusted provider listing selections with correlation and distance, not verified sales. This binding is documentation-backed beta; no data responses return status no_match at0 cost.

Check live capabilities before calling this operation.

Requires RENTCAST_API_KEY and explicit source enablement. Retained property, record, valuation and comparable reads then cost1 credit each.

Authorizations

x-api-key

string

header

required

Query Parameters

fields

string

Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.

Maximum string length: 4127

format

enum<string>

default:json

Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Available options:

json,

csv,

ndjson

Body

application/json

address

object

required

Option 1
Option 2

Show child attributes

rent_estimate

boolean

default:true

Request the provider long-term rent AVM in addition to the value AVM; false runs one provider request instead of two.

Response

Successful response; meta discloses source completeness

data

object

required

Show child attributes

meta

object

required

Show child attributes

Estimate a US property value and rent

curl --request POST \
  --url https://api.example.com/v1/properties/estimate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "address": {
    "formatted": "<string>",
    "country": "<string>"
  }
}
'

import requests

url = "https://api.example.com/v1/properties/estimate"

payload = { "address": {
        "formatted": "<string>",
        "country": "<string>"
    } }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({address: {formatted: '<string>', country: '<string>'}})
};

fetch('https://api.example.com/v1/properties/estimate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "status": "matched",
    "candidates": [
      {
        "id": "<string>",
        "entity_type": "listing",
        "method": "<string>",
        "source": {
          "platform": "<string>",
          "provider": "<string>",
          "observed_at": "2023-11-07T05:31:56Z",
          "access_class": "public_portal",
          "country": "<string>",
          "native_id": "<string>",
          "url": "<string>",
          "source_updated_at": "2023-11-07T05:31:56Z",
          "retrieved_at": "2023-11-07T05:31:56Z"
        },
        "confidence": 123
      }
    ]
  },
  "meta": {
    "request_id": "<string>",
    "schema_version": "<string>",
    "generated_at": "2023-11-07T05:31:56Z",
    "completeness": "complete",
    "sources": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ],
    "warnings": [
      {
        "code": "<string>",
        "message": "<string>",
        "field": "<string>"
      }
    ],
    "pagination": {
      "next_cursor": "<string>",
      "has_more": true,
      "returned": 123,
      "total": 123,
      "total_relation": "exact"
    },
    "property_groups": [
      {
        "property_id": "<string>",
        "listing_ids": [
          "<string>"
        ],
        "match_method": "<string>",
        "status": "matched",
        "confidence": 123
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "details": [
      {
        "platform": "<string>",
        "status": "success",
        "provider": "<string>",
        "error_code": "<string>",
        "truncated": true,
        "observed_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "request_id": "<string>"
}

Overview

Meta

Listings

Platform listings

Properties

Buildings

Developments

Agents

Agencies

Auctions

Markets

Stays

Locations

Jobs

Observations

Addresses

Permits

Estimate a US property value and rent

Authorizations

Query Parameters

Body

Response