Twitter Get Friendships Show

This Apify actor retrieves and returns detailed friendship information between two specified Twitter/X users. It determines the relationship status—whether users follow each other, have pending follow requests, or have blocked one another.

Key Features

• Direct API Integration: Uses Twitter's internal API endpoints for reliable data fetching
• Structured Output: Returns consistent, well-formatted JSON data
• Apify SDK: Built on Apify's toolkit for Actors
• Dataset Storage: Automatically stores results in Apify datasets for easy access and export
• Input Validation: Uses Apify's input schema to validate parameters before execution

How to Use

Input Parameters

Provide the following in JSON format:

{
  "userId1": "123456789",
  "userId2": "987654321",
  "screenName1": "username1",
  "screenName2": "username2"
}

Note: You can use either user IDs (userId1/userId2) or screen names (screenName1/screenName2). Using both for a user provides redundancy.

Output Format

The actor returns an object containing:

{
  "user1": {
    "id": "123456789",
    "screen_name": "username1",
    "following": true,
    "followed_by": false,
    "blocking": false,
    "blocked_by": false,
    "muting": false,
    "marked_spam": false
  },
  "user2": {
    "id": "987654321",
    "screen_name": "username2",
    "following": false,
    "followed_by": true,
    "blocking": false,
    "blocked_by": false,
    "muting": false,
    "marked_spam": false
  },
  "relationship": {
    "source_follows_target": true,
    "target_follows_source": false,
    "source_blocked_target": false,
    "target_blocked_source": false
  }
}

Execution Methods

Via Apify Console:
1. Navigate to the actor page
2. Configure input parameters
3. Click "Run"

Via API:

curl "https://api.apify.com/v2/acts/ACTOR_ID/runs?token=YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId1": "123456789", "userId2": "987654321"}'

Via Apify CLI:

apify call ACTOR_ID -p input.json

Local Development

To modify or extend this actor locally:

1. Install Apify CLI:

npm -g install apify-cli

1. Pull the actor:

apify pull <ActorId>

1. Install dependencies and run locally:

cd actor-directory
npm install
apify run

Resources

• Apify SDK for JavaScript documentation
• Apify Platform documentation
• Twitter API documentation
• Join our developer community on Discord

Notes

• This actor requires valid Twitter authentication credentials configured in Apify
• Rate limits and Twitter API restrictions apply
• Results are stored in Apify datasets and can be exported as JSON, CSV, or other formats