Find Rental Listings with RentCast API on New Run State Changed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for RentCast, OpenAI (ChatGPT) and 2,200+ other apps remarkably fast.

Trigger workflow on

New Run State Changed from the OpenAI (ChatGPT) 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 OpenAI (ChatGPT) 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 Run State Changed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
3. Configure Thread ID
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 Run State Changed on OpenAI (ChatGPT)

Description:Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)

Version:0.0.5

Key:openai-new-run-state-changed

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-run-state-changed",
  name: "New Run State Changed",
  description: "Emit new event every time a run changes its status. [See the documentation](https://platform.openai.com/docs/api-reference/runs/listRuns)",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    threadId: {
      propDefinition: [
        common.props.openai,
        "threadId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getStatusItems() {
      return this.db.get("statusItems");
    },
    setStatusItems(value) {
      this.db.set("statusItems", value);
    },
    async getData() {
      const {
        openai,
        threadId,
      } = this;

      const { data } = await openai.listRuns({
        threadId,
      });

      return data;
    },
    getMeta(item) {
      const ts = Date.now();
      return {
        id: `${item.id}-${ts}`,
        summary: `Run State Changed: ${item.id}`,
        ts,
      };
    },
    statusByItemId(itemId, statusItems) {
      const { [itemId]: status } = statusItems || {};
      return status;
    },
    buildStatusItems(data) {
      return data?.reduce((acc, item) => ({
        ...acc,
        [item.id]: item.status,
      }), {});
    },
    async getAndProcessItems(maxEvents) {
      const {
        getData,
        getStatusItems,
        setStatusItems,
        statusByItemId,
        buildStatusItems,
        getMeta,
        $emit: emit,
      } = this;

      const data = await getData();
      const statusItems = getStatusItems();

      Array.from(data)
        .reverse()
        .forEach((item, index) => {
          const statusChanged = statusByItemId(item.id, statusItems) !== item.status;
          if ((!maxEvents || index < maxEvents) && statusChanged) {
            emit(item, getMeta(item));
          }
        });

      setStatusItems(buildStatusItems(data));
    },
  },
  sampleEmit,
};

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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

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.