Example Twitter JSON File

Share this article

This article series was rewritten in mid 2017 with up-to-date information and fresh examples.

Twitter, one of the biggest social networks, has been providing developers access to their platform via a REST API for years. They also have a streaming API for developers interested in real-time data. To gain access to any of these APIs, you will need first to register an application here. Ensure you have read the Developer Agreement, otherwise you will be locked out if you create an application that violates their terms.

Once you have registered your application, you will be able to generate the following keys needed for your app to access Twitter’s data.

  • consumer key (also known as API key)
  • consumer secret
  • access token key
  • access token secret

The Twitter API uses the JSON format to communicate with third-party apps. Hence, you can use any programming language that has JSON support to develop your application. In this example, we’ll use NodeJS.

First, git clone the json-examples project, install the dependencies and create a .env file.

git@github.com:sitepoint-editors/json-examples.git
cd json-examples
npm install
touch .env

In the .env file, you’ll need to populate the following settings:

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN_KEY=
TWITTER_ACCESS_TOKEN_SECRET=

Next, let’s have a look at the twitter-json-example.js code.

require('dotenv').config();
var Twitter = require('twitter');

const CONSUMER_KEY = 'TWITTER_CONSUMER_KEY';
const CONSUMER_SECRET = 'TWITTER_CONSUMER_SECRET';
const ACCESS_TOKEN_KEY = 'TWITTER_ACCESS_TOKEN_KEY';
const ACCESS_TOKEN_SECRET = 'TWITTER_ACCESS_TOKEN_SECRET';

// Validate Twitter API Keys
const keys = [CONSUMER_KEY, CONSUMER_SECRET, ACCESS_TOKEN_KEY, ACCESS_TOKEN_SECRET ]
keys.forEach((key) => {
  if(!process.env[key])
    throw new Error(key + ' has not been set!');
});

var client = new Twitter({
  consumer_key: process.env[CONSUMER_KEY],
  consumer_secret: process.env[CONSUMER_SECRET],
  access_token_key: process.env[ACCESS_TOKEN_KEY],
  access_token_secret: process.env[ACCESS_TOKEN_SECRET]
});

var params = {screen_name: 'sitepointJS', count: 3};
client.get('statuses/user_timeline', params, function(error, tweets, response) {
  if (!error) {
    console.log(JSON.stringify(tweets));
  }
});

To easily work with the Twitter REST API, we have enlisted the help of an npm package named Twitter. First, we validate that all API keys have been defined. We then perform a query on the path statuses/user_timeline. To learn more about Twitter API paths, check out Apigee Twitter console.

To execute the code, just do:

node twitter-json-example.js

Wait a few seconds and you’ll soon receive a JSON output. Below I’ve demonstrated the partial results:

[{
  "created_at": "Thu Jun 22 21:00:00 +0000 2017",
  "id": 877994604561387500,
  "id_str": "877994604561387520",
  "text": "Creating a Grocery List Manager Using Angular, Part 1: Add & Display Items https://t.co/xFox78juL1 #Angular",
  "truncated": false,
  "entities": {
    "hashtags": [{
      "text": "Angular",
      "indices": [103, 111]
    }],
    "symbols": [],
    "user_mentions": [],
    "urls": [{
      "url": "https://t.co/xFox78juL1",
      "expanded_url": "http://buff.ly/2sr60pf",
      "display_url": "buff.ly/2sr60pf",
      "indices": [79, 102]
    }]
  },
  "source": "<a href=\"http://bufferapp.com\" rel=\"nofollow\">Buffer</a>",
  "user": {
    "id": 772682964,
    "id_str": "772682964",
    "name": "SitePoint JavaScript",
    "screen_name": "SitePointJS",
    "location": "Melbourne, Australia",
    "description": "Keep up with JavaScript tutorials, tips, tricks and articles at SitePoint.",
    "url": "http://t.co/cCH13gqeUK",
    "entities": {
      "url": {
        "urls": [{
          "url": "http://t.co/cCH13gqeUK",
          "expanded_url": "https://www.sitepoint.com/javascript",
          "display_url": "sitepoint.com/javascript",
          "indices": [0, 22]
        }]
      },
      "description": {
        "urls": []
      }
    },
    "protected": false,
    "followers_count": 2145,
    "friends_count": 18,
    "listed_count": 328,
    "created_at": "Wed Aug 22 02:06:33 +0000 2012",
    "favourites_count": 57,
    "utc_offset": 43200,
    "time_zone": "Wellington",
  },
}]
Here are the other examples in this series:

Frequently Asked Questions (FAQs) about Twitter JSON

What is Twitter JSON and how does it work?

Twitter JSON (JavaScript Object Notation) is a lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate. It is used by Twitter’s API to provide a structured representation of the data being exchanged between the client and server. This includes tweets, user profiles, and other data. The data is represented as key-value pairs, making it easy to access specific pieces of information.

How can I access Twitter JSON data?

To access Twitter JSON data, you need to use Twitter’s API (Application Programming Interface). This involves sending a request to the API with specific parameters, such as the type of data you want and the format you want it in (in this case, JSON). The API then returns the requested data in the specified format.

What kind of data can I get from Twitter JSON?

Twitter JSON can provide a wide range of data, including tweets, user profiles, follower lists, and more. Each piece of data is represented as a key-value pair, making it easy to access specific information. For example, you can get the text of a tweet, the user who posted it, the time it was posted, and more.

How do I parse Twitter JSON data?

Parsing Twitter JSON data involves extracting the specific pieces of information you need from the JSON object. This can be done using various programming languages, such as JavaScript, Python, or PHP. Each language has its own methods for parsing JSON data, but the basic process involves accessing the key-value pairs in the JSON object.

Can I use Twitter JSON data in my own applications?

Yes, you can use Twitter JSON data in your own applications. This is one of the main uses of Twitter’s API. By accessing and parsing the JSON data, you can display tweets, user profiles, and other data in your own application, website, or other platform.

Is there a limit to how much Twitter JSON data I can access?

Yes, Twitter imposes rate limits on its API to prevent abuse and ensure fair usage. These limits vary depending on the type of data you’re accessing and the method you’re using to access it. If you exceed these limits, your access to the API may be temporarily suspended.

How can I handle errors when working with Twitter JSON?

When working with Twitter JSON, errors can be handled by checking the HTTP status code that is returned with the JSON data. If the status code indicates an error, you can use the error message provided in the JSON data to determine what went wrong and how to fix it.

Can I filter the Twitter JSON data I receive?

Yes, you can filter the Twitter JSON data you receive by specifying certain parameters in your API request. For example, you can filter tweets by keyword, language, location, and more. This allows you to get only the data that is relevant to your needs.

How is Twitter JSON data structured?

Twitter JSON data is structured as a series of key-value pairs. Each key represents a specific piece of data, such as the text of a tweet or the name of a user, and the value is the actual data itself. This structure makes it easy to access specific pieces of data.

Can I access historical Twitter data using JSON?

Yes, you can access historical Twitter data using JSON. However, this requires using Twitter’s premium or enterprise APIs, which provide access to more data than the standard API. This includes historical tweets, user profiles, and more.

Michael WanyoikeMichael Wanyoike
View Author

I write clean, readable and modular code. I love learning new technologies that bring efficiencies and increased productivity to my workflow.

jQueryjsonnilsonjtwitter
Share this article
Read Next
Get the freshest news and resources for developers, designers and digital creators in your inbox each week
Loading form