How to Scrape Twitter Profiles with TypeScript

Extract profile data from Twitter

📘 Using TypeScript

Overview

Learn how to scrape Twitter profiles using TypeScript. This comprehensive guide will walk you through the entire process, from setup to implementation.

What You'll Learn

  • • Setting up your development environment
  • • Installing the required HTTP client
  • • Authenticating with the ScrapeCreators API
  • • Making requests to Twitter
  • • Handling responses and errors
  • • Best practices for production use

What You'll Get

  • • Access to profiles data
  • • JSON formatted responses
  • • Real-time data access
  • • Scalable solution
  • • Error handling patterns
  • • Performance optimization tips

Prerequisites

1. API Key

First, you'll need a ScrapeCreators API key to authenticate your requests.

Sign up at app.scrapecreators.com to get your free API key with 100 requests.

2. Development Environment

Make sure you have the following installed:

  • • TypeScript and its dependencies
  • • A code editor (VS Code, Sublime, etc.)
  • • Basic understanding of API requests
  • • Command line interface access

Step 1: Install HTTP Client

Axios is a promise-based HTTP client for TypeScript/JavaScript

npm
npm install axios

Step 2: API Implementation

Now let's make a request to the Twitter API using TypeScript. Replace YOUR_API_KEY with your actual API key.

TypeScript
import axios from 'axios';

interface ScrapeParams {
    handle: string;
}

const API_KEY = 'YOUR_API_KEY';

async function scrape(params: ScrapeParams): Promise<any> {
    try {
        const response = await axios.get(`https://api.scrapecreators.com/v1/twitter/profile?handle=Austen`, {
            headers: {
                'x-api-key': API_KEY,
                'Content-Type': 'application/json'
            },
        });

        console.log('Response:', response.data);
        return response.data;
    } catch (error) {
        console.error('Error:', error.response?.data || error.message);
        throw error;
    }
}

// Usage
const params: ScrapeParams = {
    handle: 'Austen'
};

scrape(params);

Step 3: Testing Your Code

API Parameters

This endpoint accepts the following parameters:

handleRequired(string)

Twitter handle

Example: Austen

Run Your Code

Execute your script to test the API connection. You should see a JSON response with Twitter profiles data.

✅ Success: You should receive a structured JSON response containing the requested data.

Expected Response

Here's an example of the JSON response you'll receive:

Sample Response
{
  "__typename": "User",
  "id": "VXNlcjoyMjE4MzgzNDk=",
  "rest_id": "221838349",
  "affiliates_highlighted_label": {
    "label": {
      "url": {
        "url": "https://twitter.com/bloomtech",
        "urlType": "DeepLink"
      },
      "badge": {
        "url": "https://pbs.twimg.com/profile_images/1542996246477938688/PR4UFtE6_bigger.jpg"
      },
      "description": "Bloom Institute of Technology",
      "userLabelType": "BusinessLabel",
      "userLabelDisplayType": "Badge"
    }
  },
  "is_blue_verified": true,
  "profile_image_shape": "Circle",
  "legacy": {
    "created_at": "Wed Dec 01 19:13:23 +0000 2010",
    "default_profile": false,
    "default_profile_image": false,
    "description": "CEO https://t.co/m6TigM5azr & https://t.co/NuPTghEZ1I (part of @bloomtech). We help teams maximize productivity using AI. Will tweet as I wish and suffer the consequences.",
    "entities": {
      "description": {
        "urls": [
          {
            "display_url": "GauntletAI.com",
            "expanded_url": "http://GauntletAI.com",
            "url": "https://t.co/m6TigM5azr",
            "indices": [
              4,
              27
            ]
          },
          {
            "display_url": "Aitra.com",
            "expanded_url": "http://Aitra.com",
            "url": "https://t.co/NuPTghEZ1I",
            "indices": [
              30,
              53
            ]
          }
        ]
      },
      "url": {
        "urls": [
          {
            "display_url": "gauntletai.com",
            "expanded_url": "http://gauntletai.com",
            "url": "https://t.co/nCe0AdT8D4",
            "indices": [
              0,
              23
            ]
          }
        ]
      }
    },
    "fast_followers_count": 0,
    "favourites_count": 80812,
    "followers_count": 377608,
    "friends_count": 1051,
    "has_custom_timelines": true,
    "is_translator": false,
    "listed_count": 3959,
    "location": "Austin, TX",
    "media_count": 3843,
    "name": "Austen Allred",
    "normal_followers_count": 377608,
    "pinned_tweet_ids_str": [
      "1882816395400073367"
    ],
    "possibly_sensitive": false,
    "profile_banner_url": "https://pbs.twimg.com/profile_banners/221838349/1622098809",
    "profile_image_url_https": "https://pbs.twimg.com/profile_images/1608281295918096385/D2kh-M28_normal.jpg",
    "profile_interstitial_type": "",
    "screen_name": "Austen",
    "statuses_count": 46114,
    "translator_type": "regular",
    "url": "https://t.co/nCe0AdT8D4",
    "verified": false,
    "withheld_in_countries": []
  },
  "tipjar_settings": {
    "is_enabled": false,
    "bandcamp_handle": "",
    "bitcoin_handle": "",
    "cash_app_handle": "",
    "ethereum_handle": "",
    "gofundme_handle": "",
    "patreon_handle": "",
    "pay_pal_handle": "",
    "venmo_handle": ""
  },
  "legacy_extended_profile": {},
  "is_profile_translatable": false,
  "has_hidden_subscriptions_on_profile": false,
  "verification_info": {
    "is_identity_verified": false,
    "reason": {
      "description": {
        "text": "This account is verified because it's an affiliate of @bloomtech on X. Learn more",
        "entities": [
          {
            "from_index": 54,
            "to_index": 64,
            "ref": {
              "url": "https://twitter.com/bloomtech",
              "url_type": "ExternalUrl"
            }
          },
          {
            "from_index": 71,
            "to_index": 81,
            "ref": {
              "url": "https://help.twitter.com/en/rules-and-policies/profile-labels",
              "url_type": "ExternalUrl"
            }
          }
        ]
      },
      "verified_since_msec": "1473330227634"
    }
  },
  "highlights_info": {
    "can_highlight_tweets": true,
    "highlighted_tweets": "482"
  },
  "user_seed_tweet_count": 0,
  "business_account": {},
  "creator_subscriptions_count": 3
}

Verify Response Structure

Check that your response includes the expected fields:

  • ✓__typename(string)
  • ✓id(string)
  • ✓rest_id(string)
  • ✓affiliates_highlighted_label(object)
  • ✓is_blue_verified(boolean)
  • ... and 11 more fields

Best Practices

1

Error Handling

Implement comprehensive error handling and retry logic for failed requests. Log errors properly for debugging.

2

Caching

Cache responses when possible to reduce API calls and improve performance. Consider data freshness requirements.

3

Security

Never expose your API key in client-side code. Use environment variables and secure key management practices.

Performance Tips

Batch Requests

When scraping multiple profiles, consider batching requests to maximize throughput while staying within rate limits.

Async Processing

Use asynchronous processing in TypeScript to handle multiple requests concurrently and improve overall performance.

Common Use Cases

Market Research

Analyze Twitter profiles to understand market trends, competitor analysis, and audience insights.

Content Analytics

Track performance metrics, engagement rates, and content trends across Twitter profiles.

Lead Generation

Identify potential customers and business opportunities throughTwitter data analysis.

Troubleshooting

Common Errors

401 Unauthorized

Check your API key is correct and properly formatted in the x-api-key header.

402 Payment Required

You ran out of credits and need to buy more.

404 Not Found

The resource might not exist or be private.

500 Server Error

Temporary server issue. Implement retry logic with exponential backoff.

Frequently Asked Questions

How much does it cost to scrape Twitter profiles?

ScrapeCreators offers 100 free API calls to get started. After that, pricing starts at $10 for 5k requests with volume discounts available.

Is it legal to scrape Twitter data?

Scraping publicly available data is fair game, and we only collect public data. So anything that you can see in an incognito browser is what we collect.

How fast can I scrape Twitter profiles?

There is no rate limit! So you can scrape as fast as you want!

What data format does the API return?

All API responses are returned in JSON format, making it easy to integrate with any programming language or application.

Can I use this with other TypeScript frameworks?

Yes! This tutorial focuses on core TypeScript HTTP concepts that work with any framework. The API calls remain the same regardless of your specific TypeScript setup.

How do I handle large datasets?

For large datasets, implement pagination, use streaming responses where available, and consider storing data in a database for efficient querying.

Related Tutorials

All Tutorials

Browse all available scraping tutorials for different platforms and languages.

Free Tools

Try our free online tools to test scraping without writing any code.

Ready to Start Scraping?

Get started with 100 free API calls. No credit card required.

Start Scraping ⚡️ View Documentation