> ## Documentation Index
> Fetch the complete documentation index at: https://realtycrawl.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

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

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.

> [!NOTE]
>
> Check [live capabilities](https://realtycrawl.dev/v1/meta/capabilities?platform=rentcast) before calling this operation.

Requires RENTCAST\_API\_KEY and explicit source enablement. Retained property, record, valuation and comparable reads then cost1 credit each.


## OpenAPI

````yaml POST /v1/properties/estimate
openapi: 3.1.0
info:
  title: RealtyCrawl API
  version: 0.1.0
  description: >-
    Unified real estate API with source-specific operations, markets and access
    requirements. Check current capabilities before source requests.
    Documentation-backed beta contracts require explicit configuration and do
    not establish fresh live source acceptance.
servers: []
security:
  - ApiKeyAuth: []
paths:
  /v1/properties/estimate:
    post:
      tags:
        - properties
      summary: Estimate a US property value and rent
      description: >-
        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.
      operationId: estimateProperty
      parameters:
        - name: fields
          in: query
          description: >-
            Response-only comma-separated field paths relative to data items; up
            to 32 paths. Source requests and billing are unchanged.
          schema:
            type: string
            maxLength: 4127
        - name: format
          in: query
          description: >-
            Response-only export format. JSON retains the envelope; CSV/NDJSON
            contain data records, with request/credit metadata in headers.
            Errors stay JSON.
          schema:
            type: string
            enum:
              - json
              - csv
              - ndjson
            default: json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyEstimateRequest'
      responses:
        '200':
          description: Successful response; meta discloses source completeness
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/estimatePropertyResponse'
            text/csv:
              schema:
                type: string
                description: Data rows only; request, row count and credits are in headers.
            application/x-ndjson:
              schema:
                type: string
                description: One JSON data item per line; metadata is in headers.
        default:
          description: Typed error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PropertyEstimateRequest:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/AddressSelector'
        rent_estimate:
          type: boolean
          default: true
          description: >-
            Request the provider long-term rent AVM in addition to the value
            AVM; false runs one provider request instead of two.
      required:
        - address
      additionalProperties: false
    estimatePropertyResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Resolution'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - meta
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: array
              items:
                $ref: '#/components/schemas/SourceOutcome'
          required:
            - code
            - message
            - retryable
          additionalProperties: false
        request_id:
          type: string
      required:
        - error
        - request_id
      additionalProperties: false
    AddressSelector:
      oneOf:
        - type: object
          properties:
            formatted:
              type: string
              minLength: 3
            country:
              type: string
              pattern: ^[A-Z]{2}$
          required:
            - formatted
            - country
          additionalProperties: false
        - type: object
          properties:
            line1:
              type: string
              minLength: 1
            unit:
              anyOf:
                - type: string
                - type: 'null'
            city:
              type: string
              minLength: 1
            region:
              anyOf:
                - type: string
                - type: 'null'
            postal_code:
              anyOf:
                - type: string
                - type: 'null'
            country:
              type: string
              pattern: ^[A-Z]{2}$
            original_text:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - line1
            - city
            - country
          additionalProperties: false
    Resolution:
      type: object
      properties:
        status:
          type: string
          enum:
            - matched
            - ambiguous
            - unmatched
        candidates:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              entity_type:
                type: string
                enum:
                  - listing
                  - property
                  - building
                  - address
              confidence:
                anyOf:
                  - type: number
                  - type: 'null'
              method:
                type: string
              source:
                $ref: '#/components/schemas/Source'
            required:
              - id
              - entity_type
              - method
              - source
            additionalProperties: false
      required:
        - status
        - candidates
      additionalProperties: false
    Meta:
      type: object
      properties:
        request_id:
          type: string
        schema_version:
          type: string
        generated_at:
          type: string
          format: date-time
        completeness:
          type: string
          enum:
            - complete
            - partial
            - unknown
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceOutcome'
        warnings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              field:
                type: string
            required:
              - code
              - message
            additionalProperties: false
        pagination:
          type: object
          properties:
            next_cursor:
              anyOf:
                - type: string
                - type: 'null'
            has_more:
              type: boolean
            returned:
              type: integer
            total:
              anyOf:
                - type: integer
                - type: 'null'
            total_relation:
              type: string
              enum:
                - exact
                - lower_bound
                - unknown
          required:
            - next_cursor
            - has_more
            - returned
            - total
            - total_relation
          additionalProperties: false
        property_groups:
          type: array
          items:
            $ref: '#/components/schemas/PropertyGroup'
      required:
        - request_id
        - schema_version
        - generated_at
        - completeness
        - sources
      additionalProperties: false
    SourceOutcome:
      type: object
      properties:
        platform:
          type: string
        provider:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
          enum:
            - success
            - partial
            - failed
            - unsupported
        error_code:
          anyOf:
            - type: string
            - type: 'null'
        truncated:
          type: boolean
        observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - platform
        - status
      additionalProperties: false
    Source:
      type: object
      properties:
        platform:
          type: string
        country:
          type: string
        native_id:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
              format: uri
            - type: 'null'
        provider:
          type: string
        observed_at:
          type: string
          format: date-time
        source_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        access_class:
          type: string
          enum:
            - public_portal
            - licensed_feed
            - public_record
            - modeled
        retrieved_at:
          type: string
          format: date-time
      required:
        - platform
        - provider
        - observed_at
        - access_class
      additionalProperties: false
    PropertyGroup:
      type: object
      properties:
        property_id:
          anyOf:
            - type: string
            - type: 'null'
        listing_ids:
          type: array
          items:
            type: string
        match_method:
          type: string
        confidence:
          anyOf:
            - type: number
            - type: 'null'
        status:
          type: string
          enum:
            - matched
            - ambiguous
      required:
        - property_id
        - listing_ids
        - match_method
        - status
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.