View as Markdown
RentCast icon

RentCast ACTION

Find Rental Listings

Search for rental listings in a geographical area, or by a specific address. 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 Find Rental Listings 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-find-rental-listings",
  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.

Find Rental Listings 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. Used to retrieve data for a specific property, or together with the Radius prop to search for listings in a specific area
Optional
latitude Latitude string
The latitude of the property, e.g. 29.475962. Use with Radius to search for listings in a specific area
Optional
longitude Longitude string
The longitude of the property, e.g. -98.351442. Use with Radius to search for listings in a specific area
Optional
radius Radius string
The radius of the search area in miles, with a maximum of 100.
Optional
propertyType Property Type string
The type of the property, used to search for listings matching this criteria. See the documentation for more information
Optional
bedrooms Bedrooms integer
The number of bedrooms, used to search for listings matching this criteria. Use 0 to indicate a studio layout
Optional
bathrooms Bathrooms string
The number of bathrooms, used to search for listings matching this criteria. Supports fractions to indicate partial bathrooms
Optional
status Status string
The current listing status, used to search for listings matching this criteria
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
maxListings Max Listings integer
The maximum number of listings to return. Each API call can retrieve up to 500 listings, so a higher amount will require multiple requests.
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-find-rental-listings
Version
0.0.3
App
RentCast
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes