← Twitter

Search Mentions from Twitter API

Pipedream makes it easy to connect APIs for Twitter and 700+ other apps remarkably fast.

Trigger workflow on
Search Mentions from the Twitter API
Next, do this
Connect to 700+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on Search Mentions with Twitter API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Search Mentions trigger
    1. Connect your Twitter account
    2. Configure Search Term
    3. Optional- Select a Result Type
    4. Optional- Select a Retweets
    5. Optional- Select a Replies
    6. Optional- Select one or more Languages
    7. Optional- Configure Locale
    8. Optional- Configure Geocode
    9. Optional- Configure Enrich Tweets
    10. Optional- Configure Count (advanced)
    11. Optional- Configure Max API Requests per Execution (advanced)
    12. Configure Polling interval
  2. Add steps to connect to 700+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Search Mentions on Twitter
Description:Emit new Tweets that match your search criteria
Version:0.0.7
Key:twitter-search-mentions

Code

import twitter from "../../twitter.app.mjs";
import moment from "moment";

export default {
  key: "twitter-search-mentions",
  name: "Search Mentions",
  description: "Emit new Tweets that match your search criteria",
  version: "0.0.7",
  type: "source",
  props: {
    db: "$.service.db",
    twitter,
    q: {
      propDefinition: [
        twitter,
        "q",
      ],
    },
    resultType: {
      propDefinition: [
        twitter,
        "resultType",
      ],
    },
    includeRetweets: {
      propDefinition: [
        twitter,
        "includeRetweets",
      ],
    },
    includeReplies: {
      propDefinition: [
        twitter,
        "includeReplies",
      ],
    },
    lang: {
      propDefinition: [
        twitter,
        "lang",
      ],
    },
    locale: {
      propDefinition: [
        twitter,
        "locale",
      ],
    },
    geocode: {
      propDefinition: [
        twitter,
        "geocode",
      ],
    },
    enrichTweets: {
      propDefinition: [
        twitter,
        "enrichTweets",
      ],
    },
    count: {
      propDefinition: [
        twitter,
        "count",
      ],
    },
    maxRequests: {
      propDefinition: [
        twitter,
        "maxRequests",
      ],
    },
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Twitter API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60 * 15,
      },
    },
  },
  methods: {
    _getSinceId() {
      return this.db.get("sinceId");
    },
    _setSinceId(sinceId) {
      this.db.set("sinceId", sinceId);
    },
  },
  async run() {
    const sinceId = this._getSinceId();
    const {
      lang,
      locale,
      geocode,
      resultType,
      enrichTweets,
      includeReplies,
      includeRetweets,
      maxRequests,
      count,
      q,
    } = this;
    let maxId;
    const limitFirstPage = !sinceId;

    // run paginated search
    const tweets = await this.twitter.paginatedSearch({
      q,
      sinceId,
      lang,
      locale,
      geocode,
      resultType,
      enrichTweets,
      includeReplies,
      includeRetweets,
      maxRequests,
      count,
      limitFirstPage,
    });

    // emit array of tweet objects
    if (tweets.length > 0) {
      tweets.sort(function(a, b) {return a.id - b.id;});

      tweets.forEach((tweet) => {
        this.$emit(tweet, {
          ts: moment(tweet.created_at, "ddd MMM DD HH:mm:ss Z YYYY").valueOf(),
          summary: tweet.full_text || tweet.text,
          id: tweet.id_str,
        });

        if (tweet.id_str > maxId || !maxId) {
          maxId = tweet.id_str;
        }
      });
    }
    if (maxId) {
      this._setSinceId(maxId);
    }
  },
};

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.
LabelPropTypeDescription
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
TwittertwitterappThis component uses the Twitter app.
Search Termqstring

Search for keywords star wars, screen names @starwars, or hashtags #starwars. You can also use Twitter's standard search operators.

Result TyperesultTypestringSelect a value from the drop down menu:{ "label": "Recent", "value": "recent" }{ "label": "Popular", "value": "popular" }{ "label": "Mixed", "value": "mixed" }
RetweetsincludeRetweetsstringSelect a value from the drop down menu:{ "label": "Include", "value": "include" }{ "label": "Exclude", "value": "exclude" }{ "label": "Only include retweets", "value": "filter" }
RepliesincludeRepliesstringSelect a value from the drop down menu:{ "label": "Include", "value": "include" }{ "label": "Exclude", "value": "exclude" }{ "label": "Only include replies", "value": "filter" }
Languageslangstring[]Select a value from the drop down menu.
Localelocalestring

Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.

Geocodegeocodestring

Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by latitude,longitude,radius, where radius units must be specified as either mi (miles) or km (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly.

Enrich TweetsenrichTweetsboolean

Enrich each Tweet with epoch (milliseconds) and ISO 8601 representations of Twitter's created_at timestamp, the Tweet URL, and the profile URL for the author.

Count (advanced)countinteger

The maximum number of tweets to return per API request (up to 100)

Max API Requests per Execution (advanced)maxRequestsinteger

The maximum number of API requests to make per execution (e.g., multiple requests are required to retrieve paginated results). Note: Twitter rate limits API requests per 15 minute interval.

Polling intervaltimer$.interface.timer

Pipedream will poll the Twitter API on this schedule

Authentication

Twitter uses OAuth authentication. When you connect your Twitter account, Pipedream will open a popup window where you can sign into Twitter and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Twitter API.

Pipedream requests the following authorization scopes when you connect your account:

About Twitter

From breaking news and entertainment to sports and politics, get the full story with all the live commentary.