Merge pull request #64 from twitterdev/list-lookup-sample

added list lookup samples

Author: alanblee

List-lookup/List-Tweets-lookup/List-Tweets.py

@@ -0,0 +1,55 @@
+import requests
+import os
+import json
+
+# To set your enviornment variables in your terminal run the following line:
+# export 'BEARER_TOKEN'='<your_bearer_token>'
+bearer_token = os.environ.get("BEARER_TOKEN")
+
+
+def create_url():
+    # Tweet fields are adjustable.
+    # Options include:
+    # attachments, author_id, context_annotations,
+    # conversation_id, created_at, entities, geo, id,
+    # in_reply_to_user_id, lang, non_public_metrics, organic_metrics,
+    # possibly_sensitive, promoted_metrics, public_metrics, referenced_tweets,
+    # source, text, and withheld
+    tweet_fields = "tweet.fields=lang,author_id"
+    # Be sure to replace list-id with any List ID
+    id = "list-id"
+    url = "https://api.twitter.com/2/lists/{}/tweets".format(id)
+    return url, tweet_fields
+
+
+def bearer_oauth(r):
+    """
+    Method required by bearer token authentication.
+    """
+
+    r.headers["Authorization"] = f"Bearer {bearer_token}"
+    r.headers["User-Agent"] = "v2ListTweetsLookupPython"
+    return r
+
+
+def connect_to_endpoint(url, tweet_fields):
+    response = requests.request(
+        "GET", url, auth=bearer_oauth, params=tweet_fields)
+    print(response.status_code)
+    if response.status_code != 200:
+        raise Exception(
+            "Request returned an error: {} {}".format(
+                response.status_code, response.text
+            )
+        )
+    return response.json()
+
+
+def main():
+    url, tweet_fields = create_url()
+    json_response = connect_to_endpoint(url, tweet_fields)
+    print(json.dumps(json_response, indent=4, sort_keys=True))
+
+
+if __name__ == "__main__":
+    main()

List-lookup/List-Tweets-lookup/List-Tweets.rb

@@ -0,0 +1,44 @@
+# This script uses your bearer token to authenticate and retrieve the specified Tweet objects (by List ID)
+
+require 'json'
+require 'typhoeus'
+
+# The code below sets the bearer token from your environment variables
+# To set environment variables on Mac OS X, run the export command below from the terminal:
+# export BEARER_TOKEN='YOUR-TOKEN'
+bearer_token = ENV["BEARER_TOKEN"]
+
+# Be sure to replace list-id with any List ID
+id = "list-id"
+url = "https://api.twitter.com/2/lists/#{id}/tweets"
+
+
+params = {
+  # Tweet fields are adjustable.
+  # Options include:
+  # attachments, author_id, context_annotations,
+  # conversation_id, created_at, entities, geo, id,
+  # in_reply_to_user_id, lang, non_public_metrics, organic_metrics,
+  # possibly_sensitive, promoted_metrics, public_metrics, referenced_tweets,
+  # source, text, and withheld
+  "tweet.fields": "lang,author_id",
+}
+
+def list_tweets(url, bearer_token, params)
+  options = {
+    method: 'get',
+    headers: {
+      "User-Agent": "v2ListTweetsLookupRuby",
+      "Authorization": "Bearer #{bearer_token}"
+    },
+    params: params
+  }
+
+  request = Typhoeus::Request.new(url, options)
+  response = request.run
+
+  return response
+end
+
+response = list_tweets(url, bearer_token, params)
+puts response.code, JSON.pretty_generate(JSON.parse(response.body))

List-lookup/List-Tweets-lookup/List-tweets.js

@@ -0,0 +1,47 @@
+const needle = require("needle");
+// The code below sets the bearer token from your environment variables
+// To set environment variables on macOS or Linux, run the export command below from the terminal:
+// export BEARER_TOKEN='YOUR-TOKEN'
+
+const token = process.env.BEARER_TOKEN;
+const id = "list-id";
+
+const endpointURL = `https://api.twitter.com/2/lists/${id}/tweets`;
+
+async function getRequest() {
+  // These are the parameters for the API request
+  // by default, only the Tweet ID and text are returned
+  const params = {
+    "tweet.fields": "lang,author_id", // Edit optional query parameters here
+    expansions: "author_id", // expansions is used to include the user object
+    "user.fields": "created_at", // Edit optional query parameters here
+  };
+
+  // this is the HTTP header that adds bearer token authentication
+  const res = await needle("get", endpointURL, params, {
+    headers: {
+      "User-Agent": "v2ListTweetsLookupJS",
+      authorization: `Bearer ${token}`,
+    },
+  });
+
+  if (res.body) {
+    return res.body;
+  } else {
+    throw new Error("Unsuccessful request");
+  }
+}
+
+(async () => {
+  try {
+    // Make request
+    const response = await getRequest();
+    console.dir(response, {
+      depth: null,
+    });
+  } catch (e) {
+    console.log(e);
+    process.exit(-1);
+  }
+  process.exit();
+})();

List-lookup/List-follows-lookup/list-followers-lookup.js

@@ -0,0 +1,47 @@
+const needle = require("needle");
+// The code below sets the bearer token from your environment variables
+// To set environment variables on macOS or Linux, run the export command below from the terminal:
+// export BEARER_TOKEN='YOUR-TOKEN'
+
+const token = process.env.BEARER_TOKEN;
+const id = "list-id";
+
+const endpointURL = `https://api.twitter.com/2/lists/${id}/followers`;
+
+async function getRequest() {
+  // These are the parameters for the API request
+  // by default, only the User ID and name are returned
+  const params = {
+    "user.fields": "pinned_tweet_id,created_at", // Edit optional query parameters here
+    expansions: "pinned_tweet_id", // expansions is used to include the Tweet object
+    "tweet.fields": "created_at", // Edit optional query parameters here
+  };
+
+  // this is the HTTP header that adds bearer token authentication
+  const res = await needle("get", endpointURL, params, {
+    headers: {
+      "User-Agent": "v2ListFollowersLookupJS",
+      authorization: `Bearer ${token}`,
+    },
+  });
+
+  if (res.body) {
+    return res.body;
+  } else {
+    throw new Error("Unsuccessful request");
+  }
+}
+
+(async () => {
+  try {
+    // Make request
+    const response = await getRequest();
+    console.dir(response, {
+      depth: null,
+    });
+  } catch (e) {
+    console.log(e);
+    process.exit(-1);
+  }
+  process.exit();
+})();

List-lookup/List-follows-lookup/list-followers-lookup.py

@@ -0,0 +1,51 @@
+import requests
+import os
+import json
+
+# To set your enviornment variables in your terminal run the following line:
+# export 'BEARER_TOKEN'='<your_bearer_token>'
+bearer_token = os.environ.get("BEARER_TOKEN")
+
+
+def create_url():
+    # User fields are adjustable, options include:
+    # created_at, description, entities, id, location, name,
+    # pinned_tweet_id, profile_image_url, protected,
+    # public_metrics, url, username, verified, and withheld
+    user_fields = "user.fields=created_at,description,verified"
+    # You can replace list-id with the List ID you wish to find followers of.
+    id = "list-id"
+    url = "https://api.twitter.com/2/lists/{}/followers".format(id)
+    return url, user_fields
+
+
+def bearer_oauth(r):
+    """
+    Method required by bearer token authentication.
+    """
+
+    r.headers["Authorization"] = f"Bearer {bearer_token}"
+    r.headers["User-Agent"] = "v2ListFollowersLookupPython"
+    return r
+
+
+def connect_to_endpoint(url, user_fields):
+    response = requests.request("GET", url, auth=bearer_oauth, params=user_fields)
+    print(response.status_code)
+    if response.status_code != 200:
+        raise Exception(
+            "Request returned an error: {} {}".format(
+                response.status_code, response.text
+            )
+        )
+    return response.json()
+
+
+def main():
+    url, user_fields = create_url()
+    json_response = connect_to_endpoint(url, user_fields)
+    print(json.dumps(json_response, indent=4, sort_keys=True))
+
+
+if __name__ == "__main__":
+    main()

List-lookup/List-follows-lookup/list-followers-lookup.rb

@@ -0,0 +1,41 @@
+# This script uses your bearer token to authenticate and retrieve followers of a List specified by List ID
+
+require 'json'
+require 'typhoeus'
+
+# The code below sets the bearer token from your environment variables
+# To set environment variables on Mac OS X, run the export command below from the terminal:
+# export BEARER_TOKEN='YOUR-TOKEN'
+bearer_token = ENV["BEARER_TOKEN"]
+
+# Be sure to replace list-id with any List ID
+id = "list-id"
+url = "https://api.twitter.com/2/lists/#{id}/followers"
+
+
+params = {
+    # User fields are adjustable, options include:
+    # created_at, description, entities, id, location, name,
+    # pinned_tweet_id, profile_image_url, protected,
+    # public_metrics, url, username, verified, and withheld
+  "user.fields": "created_at,verified",
+}
+
+def lists(url, bearer_token, params)
+  options = {
+    method: 'get',
+    headers: {
+      "User-Agent": "v2ListFollowersLookupRuby",
+      "Authorization": "Bearer #{bearer_token}"
+    },
+    params: params
+  }
+
+  request = Typhoeus::Request.new(url, options)
+  response = request.run
+
+  return response
+end
+
+response = lists(url, bearer_token, params)
+puts response.code, JSON.pretty_generate(JSON.parse(response.body))

List-lookup/List-follows-lookup/user-list-followed.js

@@ -0,0 +1,48 @@
+const needle = require("needle");
+// The code below sets the bearer token from your environment variables
+// To set environment variables on macOS or Linux, run the export command below from the terminal:
+// export BEARER_TOKEN='YOUR-TOKEN'
+
+const token = process.env.BEARER_TOKEN;
+const id = "user-id";
+
+const endpointURL = `https://api.twitter.com/2/users/${id}/followed_lists`;
+
+async function getRequest() {
+  // These are the parameters for the API request
+  // by default, only the List ID and name are returned
+  const params = {
+    "list.fields": "owner_id", // Edit optional query parameters here
+    expansions: "owner_id", // expansions is used to include the user object
+    "user.fields": "created_at,verified", // Edit optional query parameters here
+  };
+
+  // this is the HTTP header that adds bearer token authentication
+  const res = await needle("get", endpointURL, params, {
+    headers: {
+      "User-Agent": "v2userListMembershipsJS",
+      authorization: `Bearer ${token}`,
+      "x-des-apiservices": "staging1",
+    },
+  });
+
+  if (res.body) {
+    return res.body;
+  } else {
+    throw new Error("Unsuccessful request");
+  }
+}
+
+(async () => {
+  try {
+    // Make request
+    const response = await getRequest();
+    console.dir(response, {
+      depth: null,
+    });
+  } catch (e) {
+    console.log(e);
+    process.exit(-1);
+  }
+  process.exit();
+})();

List-lookup/List-follows-lookup/user-list-followed.py

@@ -0,0 +1,50 @@
+import requests
+import os
+import json
+
+# To set your enviornment variables in your terminal run the following line:
+# export 'BEARER_TOKEN'='<your_bearer_token>'
+bearer_token = os.environ.get("BEARER_TOKEN")
+
+
+def create_url():
+    # List fields are adjustable, options include:
+    # created_at, description, owner_id,
+    # private, follower_count, member_count,
+    list_fields = "list.fields=created_at,follower_count"
+    # You can replace the user-id with any valid User ID you wish to find what Lists they are following.
+    id = "user-id"
+    url = "https://api.twitter.com/2/users/{}/followed_lists".format(id)
+    return url, list_fields
+
+
+def bearer_oauth(r):
+    """
+    Method required by bearer token authentication.
+    """
+
+    r.headers["Authorization"] = f"Bearer {bearer_token}"
+    r.headers["User-Agent"] = "v2userListMembershipsPython"
+    return r
+
+
+def connect_to_endpoint(url, list_fields):
+    response = requests.request("GET", url, auth=bearer_oauth, params=list_fields)
+    print(response.status_code)
+    if response.status_code != 200:
+        raise Exception(
+            "Request returned an error: {} {}".format(
+                response.status_code, response.text
+            )
+        )
+    return response.json()
+
+
+def main():
+    url, list_fields = create_url()
+    json_response = connect_to_endpoint(url, list_fields)
+    print(json.dumps(json_response, indent=4, sort_keys=True))
+
+
+if __name__ == "__main__":
+    main()