Skip to main content

Documentation Index

Fetch the complete documentation index at: https://rocks.docs.rive.wtf/llms.txt

Use this file to discover all available pages before exploring further.

Every API key is tied to one IP. To apply for a key, DM southctrl on Discord.
Use the endpoint paths below, replace the required params, and send Authorization: Bearer YOUR_API_KEY.

​
Quick Start

1

Choose an endpoint

Select from user profiles, individual tweets, or user tweet feeds.
2

Provide required parameters

Username for profiles/feeds, or tweet URL for individual tweets.
3

Call the API

Send the request with your Bearer token.
4

Use the data

Access rich profile data, tweet content, media, engagement metrics, and more.
Powered by Gherila - provides comprehensive Twitter/X data including media, hashtags, mentions, engagement metrics, and verification status.

​
Get User Profile

Get comprehensive information about a Twitter/X user including bio, stats, verification status, and bio links.

​
Endpoint

GET /api/twitter/user

​
Query Parameters

​
username
string
required
Twitter/X username (without @ symbol).

​
Example Request

curl -X GET "https://rocks.rive.wtf/api/twitter/user?username=elonmusk" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "username": "elonmusk",
  "id": 44196397,
  "avatar": "https://pbs.twimg.com/profile_images/1815749056821346304/jS8I28PL.jpg",
  "banner": "https://pbs.twimg.com/profile_banners/44196397/1690621312",
  "bio": "Tesla, SpaceX, Neuralink, xAI, Boring Company",
  "display_name": "Elon Musk",
  "location": "Texas, USA",
  "verified": true,
  "verified_type": "Blue",
  "created_at": "2009-06-02T20:12:29.000Z",
  "followers": 233388876,
  "following": 1279,
  "posts": 4335,
  "liked_posts": 204057,
  "tweets": 95649,
  "pinned_tweets": ["1234567890123456789"],
  "biolinks": [
    {
      "display_url": "tesla.com",
      "expanded_url": "https://www.tesla.com",
      "url": "https://t.co/abc123"
    }
  ],
  "url": "https://x.com/elonmusk"
}

​
Response Fields

​
username
string
Twitter/X handle (without @ symbol)
​
id
integer
Unique Twitter user ID
​
avatar
string
URL to the user’s profile picture
​
banner
string
URL to the user’s profile banner image (null if not set)
​
bio
string
User’s biography/description text
​
display_name
string
Display name shown on the profile
​
location
string
User’s location as set in their profile
​
verified
boolean
Whether the account has verification status
​
verified_type
string
Type of verification (e.g., “Blue”, “Business”, “Government”)
​
created_at
string
ISO 8601 timestamp of when the account was created
​
followers
integer
Number of followers
​
following
integer
Number of accounts the user is following
​
posts
integer
Number of media posts
​
liked_posts
integer
Total number of likes the user has given
​
tweets
integer
Total number of tweets posted
​
pinned_tweets
array
Array of pinned tweet IDs (null if none)
​
biolinks
array
Array of links in the user’s bio
​
url
string
Direct link to the user’s Twitter/X profile

​
Get Tweet Details

Get comprehensive information about a specific tweet including text, media, engagement metrics, and author details.

​
Endpoint

GET /api/twitter/tweet

​
Query Parameters

​
url
string
required
Full Twitter/X tweet URL (e.g., https://twitter.com/username/status/1234567890)

​
Example Request

curl -X GET "https://rocks.rive.wtf/api/twitter/tweet?url=https://twitter.com/elonmusk/status/1234567890" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "id": 1234567890,
  "text": "This is a sample tweet with #hashtags and @mentions",
  "author": {
    "username": "elonmusk",
    "id": 44196397,
    "avatar": "https://pbs.twimg.com/profile_images/...",
    "display_name": "Elon Musk",
    "verified": true
  },
  "lang": "en",
  "likes": 125000,
  "replies": 3500,
  "retweets": 45000,
  "quote": 2000,
  "retweeted": false,
  "created_at": "2024-01-15T10:30:00.000Z",
  "views": 5000000,
  "bookmarks": 8500,
  "is_quote": false,
  "quote_url": null,
  "hashtags": ["hashtags"],
  "mentions": ["mentions"],
  "media": [
    {
      "type": "photo",
      "image_url": "https://pbs.twimg.com/media/...",
      "video_url": null
    }
  ]
}

​
Response Fields

​
id
integer
Unique tweet ID
​
text
string
Full text content of the tweet
​
author
object
Author profile information (same structure as user profile endpoint)
​
lang
string
Language code of the tweet (e.g., “en”, “es”, “ja”)
​
likes
integer
Number of likes on the tweet
​
replies
integer
Number of replies to the tweet
​
retweets
integer
Number of retweets
​
quote
integer
Number of quote tweets
​
retweeted
boolean
Whether the tweet is a retweet
​
created_at
string
ISO 8601 timestamp of when the tweet was posted
​
views
integer
Number of views the tweet has received
​
bookmarks
integer
Number of times the tweet has been bookmarked
​
is_quote
boolean
Whether the tweet is a quote tweet
​
quote_url
string
URL of the quoted tweet (null if not a quote)
​
hashtags
array
Array of hashtag strings (without # symbol)
​
mentions
array
Array of mentioned usernames (without @ symbol)
​
media
array
Array of media objects attached to the tweet

​
Get User Tweets

Get the 20 most recent tweets from a specific user’s timeline.

​
Endpoint

GET /api/twitter/user/tweets

​
Query Parameters

​
username
string
required
Twitter/X username (without @ symbol)

​
Example Request

curl -X GET "https://rocks.rive.wtf/api/twitter/user/tweets?username=elonmusk" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "tweets": [
    {
      "id": 1234567890,
      "text": "First tweet text...",
      "author": {
        "username": "elonmusk",
        "id": 44196397,
        "verified": true
      },
      "lang": "en",
      "likes": 50000,
      "replies": 1200,
      "retweets": 15000,
      "views": 2000000,
      "created_at": "2024-01-15T10:30:00.000Z",
      "media": []
    },
    {
      "id": 1234567891,
      "text": "Second tweet text...",
      "author": {
        "username": "elonmusk",
        "id": 44196397,
        "verified": true
      },
      "lang": "en",
      "likes": 75000,
      "replies": 2500,
      "retweets": 25000,
      "views": 3500000,
      "created_at": "2024-01-14T15:20:00.000Z",
      "media": [
        {
          "type": "photo",
          "image_url": "https://pbs.twimg.com/media/..."
        }
      ]
    }
  ]
}

​
Response Fields

​
tweets
array
Array of tweet objects (up to 20 most recent tweets). Each tweet has the same structure as the individual tweet endpoint response.
​
tweets
array
Array of tweet objects (up to 20 most recent tweets). Each tweet has the same structure as the individual tweet endpoint response.
All endpoints return public data only. Protected or private accounts may return limited data or errors.
The API uses Gherila to access Twitter’s internal GraphQL endpoints, providing richer data than the public API including view counts, bookmarks, and detailed media information.

​
Use Cases

Social Analytics

Track engagement metrics, follower growth, and tweet performance

Content Aggregation

Build Twitter feed aggregators and content curation tools

Profile Verification

Verify Twitter accounts and display verification badges

Media Extraction

Extract images and videos from tweets for archival or display

Bot Integration

Display Twitter content in Discord/Slack bots with rich embeds

Sentiment Analysis

Analyze tweet content, hashtags, and engagement patterns

​
Error Responses

All endpoints may return the following error responses:
Status CodeDescription
400Missing required parameters (username or url)
404User not found or tweet doesn’t exist
500Twitter API error or server error
Example error response: 
{
  "error": "No x account found for given username `invaliduser`."
}