---
title: "Rental estimates based on propertyId"
method: GET
path: "/v1/properties/{propertyId}/rentalEstimate"
tags: ["Properties"]
---

# Rental estimates based on propertyId

`GET /v1/properties/{propertyId}/rentalEstimate`

## Request

- Base URL: `https://api.domain.com.au`
- URL: `https://api.domain.com.au/v1/properties/{propertyId}/rentalEstimate`
- Auth: one of:
  - API key in header `x-api-key`
  - OAuth 2
    - Authorization code: `https://auth.domain.com.au/v1/connect/authorize`
    - Client credentials
    - Token URL: `https://auth.domain.com.au/v1/connect/token` scopes: `api_properties_read`
- TypeScript: <https://skmtc.dev/domain/apis/domain-public-api/docs/v1/properties/:propertyId/rentalEstimate/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `propertyId` string, required

## Response `200`

Success

- DomainAvmPIV1RentalEstimate
  - `weeklyRentEstimate` integer, nullable
  - `percentYieldRentEstimate` number, double, nullable
  - `rentalFsd` number, double, nullable
  - `estimateDate` string, nullable
  - `propertyType` string, nullable

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Server Error

## Changes

- **2024-04-24** `eee76e147314`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/domain/apis/domain-public-api/changes/v1/properties/:propertyId/rentalEstimate/get.md)

---

[API](https://skmtc.dev/domain/apis/domain-public-api.md) - [All operations](https://skmtc.dev/domain/apis/domain-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/domain/apis/domain-public-api/revisions/133015c6842c?raw)