Find Rental Listings with RentCast API on New DynamoDB Stream Event from AWS API

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

Trigger workflow on

New DynamoDB Stream Event from the AWS 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 AWS 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 DynamoDB Stream Event trigger
1. Connect your AWS account
2. Configure timer
3. Select a AWS Region
4. Select a Stream
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 DynamoDB Stream Event on AWS

Description:Emit new event when a DynamoDB stream receives new events. [See the docs here](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html)

Version:0.0.2

Key:aws-new-dynamodb-stream-event

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import common from "../../common/common-dynamodb-streams.mjs";

export default {
  ...common,
  key: "aws-new-dynamodb-stream-event",
  name: "New DynamoDB Stream Event",
  description: "Emit new event when a DynamoDB stream receives new events. [See the docs here](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html)",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    ...common.props,
    stream: {
      type: "string",
      label: "Stream",
      description: "ARN of the Stream to watch for new events",
      async options({ prevContext }) {
        const {
          streams,
          lastEvaluatedStreamArn,
        } = await this.listEnabledStreams({
          ExclusiveStartStreamArn: prevContext.lastEvaluatedStreamArn,
        });
        const options = streams.map((stream) => ({
          label: `${stream.TableName} - Created ${stream.StreamLabel}`,
          value: stream.StreamArn,
        }));
        return {
          options,
          context: {
            lastEvaluatedStreamArn,
          },
        };
      },
    },
  },
  hooks: {
    async deploy() {
      const { StreamDescription: streamDescription } = await this.listShards({
        StreamArn: this.stream,
      });
      const shardId = streamDescription.Shards[streamDescription.Shards.length - 1].ShardId;
      const { ShardIterator: shardIterator } = await this.getShardIterator({
        ShardId: shardId,
        StreamArn: this.stream,
        ShardIteratorType: "LATEST",
      });
      this._setShardIterator(shardIterator);
    },
  },
  methods: {
    ...common.methods,
    _getShardIterator() {
      return this.db.get("shardIterator");
    },
    _setShardIterator(shardIterator) {
      this.db.set("shardIterator", shardIterator);
    },
    generateMeta({
      eventID, eventName, dynamodb,
    }) {
      return {
        id: eventID,
        summary: `New ${eventName} event`,
        ts: Date.parse(dynamodb.ApproximateCreationDateTime),
      };
    },
  },
  async run() {
    if (!(await this.isStreamEnabled(this.stream))) {
      throw new Error("Stream is no longer enabled.");
    }

    const shardIterator = this._getShardIterator();

    const {
      Records: records, NextShardIterator: nextShardIterator,
    } = await this.getRecords({
      ShardIterator: shardIterator,
    });

    for (const record of records) {
      const meta = this.generateMeta(record);
      this.$emit(record, meta);
    }

    this._setShardIterator(nextShardIterator);
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
AWS Region	`region`	`string`	Select a value from the drop down menu.
Stream	`stream`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

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.

Action Authentication#

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

About RentCast#

Rental Property Rates and Market Trends.

More Ways to Connect RentCast + AWS#

Other Popular Integrations#

Find Rental Listings with RentCast API on New Inbound SES Emails from AWS API

AWS + RentCast

Find Rental Listings with RentCast API on New DynamoDB Stream Event from AWS API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular