Notifications

GET/tw-v2/interaction/notifications

Description

Retrieve the authenticated user's notifications timeline on the platform. Returns notifications including likes, retweets, mentions, and follows.

Parameters

Parameter	Type	Required	Description
authToken	string	required	Account authentication token (auth_token cookie value)
timelineType	string	optional	Type of notifications to retrieve: 'All', 'Verified', or 'Mentions' (default: 'All')
count	number	optional	Number of results to return per page (min: 1, max: 100, default: 20)
cursor	string	optional	Pagination cursor for fetching next page of results. Obtained from previous response.
proxy	string	optional	Optional proxy in format 'host:port@user:pass'

Code Examples

const params = new URLSearchParams({
  authToken: 'YOUR_AUTH_TOKEN'
});

const response = await fetch(`https://api.tweetapi.com/tw-v2/interaction/notifications?${params}`, {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

Response

Success Response (200 OK)

200

{
  "data": [
    {
      "id": "F1jG7mhWwAAAAAAB15VmQrFiaySXms5dAAA",
      "type": "device_follow_tweet_notification_entry",
      "timestamp": "2025-10-05T06:39:17.402Z",
      "message": "Sample post text 53528 for documentation.",
      "users": [
        {
          "id": "100151062666878842",
          "username": "sample_user_44649",
          "name": "Sample User 44649",
          "followerCount": 117834,
          "isBlueVerified": true
        }
      ],
      "url": "/2/notifications/device_follow.json",
      "icon": "bell_icon"
    },
    {
      "id": "F1jG7mhWwAAAAAAB15VmQrFiaySWMQX0Luk",
      "type": "generic_magic_rec_first_degree_tweet_recent",
      "timestamp": "2025-10-04T22:40:41.212Z",
      "message": "Sample post text 73354 for documentation.",
      "users": [
        {
          "id": "10014752",
          "username": "sample_user_73927",
          "name": "Sample User 73927",
          "followerCount": 317001,
          "isBlueVerified": true
        }
      ],
      "tweets": [
        {
          "id": "2009453333471715800",
          "text": "Sample post text 50778 for documentation.",
          "author": {
            "id": "20027198",
            "username": "sample_user_73927"
          },
          "type": "quote"
        }
      ],
      "url": "https://x.com/sample_user_68005/status/2009512428773061595",
      "icon": "recommendation_icon"
    },
    {
      "id": "F1jG7mhWwAAAAAAB15VmQrFiaySWc3a7cAA",
      "type": "generic_magic_rec_first_degree_tweet_recent",
      "timestamp": "2025-10-04T22:40:41.211Z",
      "message": "Sample post text 43575 for documentation.",
      "users": [
        {
          "id": "10017528",
          "username": "sample_user_96991",
          "name": "Sample User 96991",
          "followerCount": 226995885,
          "isBlueVerified": true
        }
      ],
      "tweets": [
        {
          "id": "2001389518663911394",
          "text": "Sample post text 24893 for documentation.",
          "author": {
            "id": "20089310",
            "username": "sample_user_96991"
          },
          "type": "tweet"
        }
      ],
      "url": "https://x.com/sample_user_51247/status/2001728280874107908",
      "icon": "recommendation_icon"
    },
    {
      "id": "F1jG7mhWwAAAAAAB15VmQrFiaySWc3a8AAA",
      "type": "favorite_notification_entry",
      "timestamp": "2025-10-04T19:22:03.210Z",
      "message": "Sample post text 85791 for documentation.",
      "users": [
        {
          "id": "123456789",
          "username": "user123",
          "name": "Sample User 08211",
          "followerCount": 5432,
          "isBlueVerified": false
        }
      ],
      "tweets": [
        {
          "id": "2001775356878954654",
          "text": "Sample post text 08370 for documentation.",
          "author": {
            "id": "2001005139481102956",
            "username": "your_username"
          },
          "type": "tweet"
        }
      ],
      "url": "https://example.com/link-94089/profile-41921/your_username/status/2009078023935564305",
      "icon": "favorite_icon"
    },
    {
      "id": "F1jG7mhWwAAAAAAB15VmQrFiaySWjvKlAAA",
      "type": "retweet_notification_entry",
      "timestamp": "2025-10-04T18:15:42.209Z",
      "message": "Sample post text 88014 for documentation.",
      "users": [
        {
          "id": "987654321",
          "username": "anotheruser",
          "name": "Sample User 52010",
          "followerCount": 12345,
          "isBlueVerified": true
        }
      ],
      "tweets": [
        {
          "id": "2001298886742910077",
          "text": "Sample post text 08279 for documentation.",
          "author": {
            "id": "2001226944052982843",
            "username": "your_username"
          },
          "type": "tweet"
        }
      ],
      "url": "https://example.com/link-94089/profile-41921/your_username/status/2008988692782157135",
      "icon": "retweet_icon"
    }
  ],
  "pagination": {
    "nextCursor": "DAACDAABCgABF1jG7mhWwAAIAAIAAAABCAAD15VmQggABLFiayQACwACAAAAC0Faa2p5cE4zWGpZAAA",
    "prevCursor": null
  }
}

Notifications

Description

Parameters

Code Examples

Response

Success Response (200 OK)

API Playground

Sensitive Credentials Required