View as Markdown
RentCast icon

RentCast ACTION

Get Rent Estimate

Get a property rent estimate and comparable properties. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's RentCast account once, then configure and run Get Rent Estimate from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "rentcast-get-rent-estimate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    rentcast: { authProvisionId: "apn_xxxxxxx" },
    address: "Address",
    latitude: "Latitude",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Rent Estimate inputs
Property Type Description
address Address string
The full address of the property, in the format of Street, City, State, Zip, e.g. 5500 Grand Lake Drive, San Antonio, TX, 78244
Optional
latitude Latitude string
The latitude of the property, e.g. 29.475962
Optional
longitude Longitude string
The longitude of the property, e.g. -98.351442
Optional
propertyType Property Type string
The type of the property. See the documentation for more information
Optional
bedrooms Bedrooms integer
The number of bedrooms in the property. Use 0 to indicate a studio layout
Optional
bathrooms Bathrooms string
The number of bathrooms in the property. Supports fractions to indicate partial bathrooms
Optional
squareFootage Square Footage string
The total living area size of the property, in square feet
Optional
maxRadius Max Radius string
The maximum distance between comparable listings and the subject property, in miles
Optional
daysOld Days Old integer
The maximum number of days since comparable listings were last seen on the market, with a minimum of 1
Optional
compCount Comparable Count integer
The number of comparable listings to use when calculating the value estimate, between 5 and 25. Defaults to 15 if not provided
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
rentcast-get-rent-estimate
Version
0.0.2
App
RentCast
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes