Find Rental Listings with RentCast API on New Row Custom Query from PostgreSQL API

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

Trigger workflow on

New Row Custom Query from the PostgreSQL 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 PostgreSQL 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 Row Custom Query trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
4. Select a Table
5. Select a Column
6. Configure SQL Query
7. Optional- Configure Values
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 Row Custom Query on PostgreSQL

Description:Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.6

Key:postgresql-new-row-custom-query

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Trigger Code#

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

export default {
  ...common,
  name: "New Row Custom Query",
  key: "postgresql-new-row-custom-query",
  description: "Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
    table: {
      propDefinition: [
        common.props.postgresql,
        "table",
        (c) => ({
          schema: c.schema,
        }),
      ],
    },
    column: {
      propDefinition: [
        common.props.postgresql,
        "column",
        (c) => ({
          table: c.table,
          schema: c.schema,
        }),
      ],
    },
    query: {
      propDefinition: [
        common.props.postgresql,
        "query",
      ],
    },
    values: {
      propDefinition: [
        common.props.postgresql,
        "values",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: "New Row",
        ts: Date.now(),
      };
    },
  },
  async run() {
    const {
      schema,
      table,
      column,
      query,
      values = [],
    } = this;

    if (!Array.isArray(values)) {
      throw new Error("No valid values provided. The values property must be an array.");
    }

    const numberOfValues = query?.match(/\$/g)?.length || 0;
    if (values.length !== numberOfValues) {
      throw new Error("The number of values provided does not match the number of values in the query.");
    }

    const isColumnUnique = await this.isColumnUnique(schema, table, column);
    if (!isColumnUnique) {
      throw new Error("The column selected contains duplicate values. Column must be unique");
    }

    const rows = await this.postgresql.executeQuery({
      text: query,
      values,
    });
    for (const row of rows) {
      const meta = this.generateMeta(row, column);
      this.$emit(row, meta);
    }
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL 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
Schema	`schema`	`string`	Select a value from the drop down menu.
Table	`table`	`string`	Select a value from the drop down menu.
Column	`column`	`string`	Select a value from the drop down menu.
SQL Query	`query`	`string`	Your custom SQL Query using `$1`, `$2`... to represent values (eg. `INSERT INTO users(name, email) VALUES($1, $2)`
Values	`values`	`string[]`	List of values represented in your SQL Query above

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

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

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.1",
  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.