Find Rental Listings with RentCast API on New Collection from MongoDB API

Pipedream makes it easy to connect APIs for RentCast, MongoDB and 2,900+ other apps remarkably fast.

Trigger workflow on

New Collection from the MongoDB API

Next, do this

Find Rental Listings with the RentCast API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MongoDB trigger and RentCast action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Collection trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
Configure the Find Rental Listings action
1. Connect your RentCast account
2. Configure infoAlert
3. Optional- Configure Address
4. Optional- Configure Latitude
5. Optional- Configure Longitude
6. Optional- Configure Radius
7. Optional- Select a Property Type
8. Optional- Configure Bedrooms
9. Optional- Configure Bathrooms
10. Optional- Select a Status
11. Optional- Configure Days Old
12. Optional- Configure Max Listings
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Collection on MongoDB

Description:Emit new an event when a new collection is added to a database

Version:0.0.7

Key:mongodb-new-collection

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "mongodb-new-collection",
  name: "New Collection",
  description: "Emit new an event when a new collection is added to a database",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getCollectionIds() {
      return this.db.get("collectionIds");
    },
    _setCollectionIds(collectionIds) {
      this.db.set("collectionIds", collectionIds);
    },
    isRelevant(uuid, collectionIds) {
      return !collectionIds.includes(uuid);
    },
    async processEvent(client, ts) {
      const collectionIds = this._getCollectionIds() || [];
      const collections = await this.mongodb.listCollections(client, this.database);
      for (const collection of collections) {
        const uuid = JSON.stringify(collection.info.uuid);
        if (!this.isRelevant(uuid, collectionIds)) {
          continue;
        }
        collectionIds.push(uuid);
        this.emitEvent(collection, ts);
      }
      this._setCollectionIds(collectionIds);
    },
    generateMeta({
      info, name,
    }, ts) {
      return {
        id: info.uuid,
        summary: name,
        ts,
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.

Trigger Authentication#

MongoDB uses API keys for authentication. When you connect your MongoDB account, Pipedream securely stores the keys so you can easily authenticate to MongoDB APIs in both code and no-code steps.

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Find Rental Listings on RentCast

Description:Search for rental listings in a geographical area, or by a specific address. [See the documentation](https://developers.rentcast.io/reference/rental-listings-long-term)

Version:0.0.2

Key:rentcast-find-rental-listings

View on GitHub

Action Code#

import rentcast from "../../rentcast.app.mjs";

export default {
  key: "rentcast-find-rental-listings",
  name: "Find Rental Listings",
  description: "Search for rental listings in a geographical area, or by a specific address. [See the documentation](https://developers.rentcast.io/reference/rental-listings-long-term)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    rentcast,
    infoAlert: {
      propDefinition: [
        rentcast,
        "infoAlert",
      ],
    },
    address: {
      propDefinition: [
        rentcast,
        "address",
      ],
      description: "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",
    },
    latitude: {
      propDefinition: [
        rentcast,
        "latitude",
      ],
      description: "The latitude of the property, e.g. `29.475962`. Use with `Radius` to search for listings in a specific area",
    },
    longitude: {
      propDefinition: [
        rentcast,
        "longitude",
      ],
      description: "The longitude of the property, e.g. `-98.351442`. Use with `Radius` to search for listings in a specific area",
    },
    radius: {
      type: "string",
      label: "Radius",
      description: "The radius of the search area in miles, with a maximum of 100.",
      optional: true,
    },
    propertyType: {
      propDefinition: [
        rentcast,
        "propertyType",
      ],
      description: "The type of the property, used to search for listings matching this criteria. [See the documentation](https://developers.rentcast.io/reference/property-types) for more information",
    },
    bedrooms: {
      propDefinition: [
        rentcast,
        "bedrooms",
      ],
      description: "The number of bedrooms, used to search for listings matching this criteria. Use `0` to indicate a studio layout",
    },
    bathrooms: {
      propDefinition: [
        rentcast,
        "bathrooms",
      ],
      description: "The number of bathrooms, used to search for listings matching this criteria. Supports fractions to indicate partial bathrooms",
    },
    status: {
      type: "string",
      label: "Status",
      description: "The current listing status, used to search for listings matching this criteria",
      optional: true,
      options: [
        "Active",
        "Inactive",
      ],
    },
    daysOld: {
      propDefinition: [
        rentcast,
        "daysOld",
      ],
    },
    maxListings: {
      type: "integer",
      label: "Max Listings",
      description: "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: true,
      min: 1,
      default: 50,
      max: 2000,
    },
  },
  async run({ $ }) {
    let {
      rentcast, maxListings,  ...params
    } = this;

    const totalItems = [];
    let offset = 0;
    do {
      const limit = Math.min(maxListings, 500);
      const response = await rentcast.findRentalListings({
        $,
        params: {
          ...params,
          limit,
          offset,
        },
      });
      const length = response?.length;
      if (!length) {
        break;
      }
      totalItems.push(...response.slice(0, maxListings));
      offset += length;
      maxListings -= length;
    } while (maxListings > 0);

    $.export("$summary", `Successfully fetched ${totalItems.length} rental listings`);
    return totalItems;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
RentCast	`rentcast`	`app`	This component uses the RentCast app.
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
Latitude	`latitude`	`string`	The latitude of the property, e.g. `29.475962`. Use with `Radius` to search for listings in a specific area
Longitude	`longitude`	`string`	The longitude of the property, e.g. `-98.351442`. Use with `Radius` to search for listings in a specific area
Radius	`radius`	`string`	The radius of the search area in miles, with a maximum of 100.
Property Type	`propertyType`	`string`	Select a value from the drop down menu:`{ "value": "Single Family", "label": "A detached, single-family property" }{ "value": "Condo", "label": "A single unit in a condominium development or building, which is part of a homeowner’s association (HOA)" }{ "value": "Townhouse", "label": "A single-family property that shares walls with other adjacent homes, and is typically part of a homeowner’s association (HOA)" }{ "value": "Manufactured", "label": "A pre-fabricated or mobile home, typically constructed at a factory" }{ "value": "Multi-Family", "label": "A residential multi-family building (2-4 units)" }{ "value": "Apartment", "label": "A commercial multi-family building or apartment complex (5+ units)" }{ "value": "Land", "label": "A single parcel of vacant, undeveloped land" }`
Bedrooms	`bedrooms`	`integer`	The number of bedrooms, used to search for listings matching this criteria. Use `0` to indicate a studio layout
Bathrooms	`bathrooms`	`string`	The number of bathrooms, used to search for listings matching this criteria. Supports fractions to indicate partial bathrooms
Status	`status`	`string`	Select a value from the drop down menu:`ActiveInactive`
Days Old	`daysOld`	`integer`	The maximum number of days since comparable listings were last seen on the market, with a minimum of 1
Max Listings	`maxListings`	`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.