> ## Documentation Index > Fetch the complete documentation index at: https://docs.sorsa.io/llms.txt > Use this file to discover all available pages before exploring further. # Api Reference Guide # Complete API Reference: All Sorsa Endpoints All Sorsa API endpoints are listed below, organized by category. Every endpoint uses the same base URL (`https://api.sorsa.io/v3`) and authenticates via the `ApiKey` header. Every call costs exactly 1 request from your quota, regardless of which endpoint you use, and new accounts start with 100 free requests to test all 40 endpoints (no card required). For detailed parameter tables, response schemas, and interactive testing, click the **Docs** link next to each endpoint. You can also test any endpoint without code using the [API Playground](https://api.sorsa.io/playground). *** ## Users Data Endpoints for retrieving user profiles, follower and following lists, and account metadata. | Endpoint | Method | Description | Docs | | :-------------------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ | | `/info` | GET | Full profile for a single account (bio, counts, verified status, avatar). Accepts `username`, `user_id`, or `user_link`. | [Docs](https://docs.sorsa.io/api-reference/users-data/user-profile) | | `/info-batch` | GET | Profiles for up to 100 accounts in one request. Accepts `usernames[]` or `user_ids[]`. | [Docs](https://docs.sorsa.io/api-reference/users-data/user-profile-batch) | | `/about` | GET | Account metadata: country, username change count and date, X Premium (Blue) status and start date, account source, and affiliate handle. | [Docs](https://docs.sorsa.io/api-reference/users-data/account-about-info) | | `/followers` | GET | Paginated follower list with full profiles. Up to 200 users per page. | [Docs](https://docs.sorsa.io/api-reference/users-data/followers) | | `/follows` | GET | Paginated following list with full profiles. Up to 200 users per page. | [Docs](https://docs.sorsa.io/api-reference/users-data/following) | | `/verified-followers` | GET | Paginated list of only verified followers. | [Docs](https://docs.sorsa.io/api-reference/users-data/verified-followers) | **Related guides:** [Followers & Following](https://docs.sorsa.io/followers-and-following) | [Audience Geography](https://docs.sorsa.io/Audience-Geography) | [Competitor Analysis](https://docs.sorsa.io/Competitor-Analysis) *** ## Tweets Endpoints for retrieving tweet content, engagement metrics, replies, quotes, retweeters, long-form articles, and trending topics. | Endpoint | Method | Description | Docs | | :----------------- | :----- | :--------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------ | | `/tweet-info` | POST | Full data for a single tweet (text, metrics, author profile). Body: `tweet_link`. | [Docs](https://docs.sorsa.io/api-reference/tweets/tweet-data) | | `/tweet-info-bulk` | POST | Full data for up to 100 tweets in one request. Body: `tweet_links[]`. | [Docs](https://docs.sorsa.io/api-reference/tweets/tweet-data-batch) | | `/user-tweets` | POST | Paginated timeline of a user's tweets. Body: `user_link`, `username`, or `user_id`. | [Docs](https://docs.sorsa.io/api-reference/tweets/user-tweets) | | `/comments` | POST | Replies under a specific tweet. Body: `tweet_link` (optional `order_by`: `Relevance`, `Recency`, `Likes`). | [Docs](https://docs.sorsa.io/api-reference/tweets/tweet-comments) | | `/quotes` | POST | Quote tweets of a specific tweet. Body: `tweet_link`. | [Docs](https://docs.sorsa.io/api-reference/tweets/quote-tweets) | | `/retweeters` | POST | Users who retweeted a tweet (returns user profiles, not tweets). Body: `tweet_link`. | [Docs](https://docs.sorsa.io/api-reference/tweets/retweeters-list) | | `/article` | POST | Full content of an X Article (long-form post). Body: `tweet_link`. | [Docs](https://docs.sorsa.io/api-reference/tweets/article-data) | | `/trends` | GET | Trending topics for a location. Query: `woeid` (Where On Earth IDentifier). | [Docs](https://docs.sorsa.io/api-reference/tweets/trends-list) | **Related guides:** [Search Tweets](https://docs.sorsa.io/search-tweets) | [Tweet Engagement](https://docs.sorsa.io/tweet-engagement) | [X Articles](https://docs.sorsa.io/x-articles) | [Historical Data](https://docs.sorsa.io/historical-data) *** ## Search Endpoints for searching tweets, mentions, and user profiles, and for looking up X Spaces. | Endpoint | Method | Description | Docs | | :--------------- | :----- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------- | | `/search-tweets` | POST | Search tweets by keyword with full X operator support. Body: `query`, `order`, `next_cursor`. | [Docs](https://docs.sorsa.io/api-reference/search/search-tweets) | | `/mentions` | POST | Tweets mentioning a specific handle, with engagement and date filters. Body: `query`, `order`, `min_likes`, `min_retweets`, `min_replies`, `since_date`, `until_date`. | [Docs](https://docs.sorsa.io/api-reference/search/search-mentions) | | `/search-users` | POST | Search user profiles by keyword (matches bios, display names, handles). Body: `query`. | [Docs](https://docs.sorsa.io/api-reference/search/search-users) | | `/spaces` | GET | Full data for an X Space: metadata, creator profile, participants, settings, and stats. Query: `id` or `link`. | [Docs](https://docs.sorsa.io/api-reference/search/spaces-information) | **Related guides:** [Search Tweets](https://docs.sorsa.io/search-tweets) | [Track Mentions](https://docs.sorsa.io/search-mentions) | [Search Operators](https://docs.sorsa.io/search-operators) | [Target Audience Discovery](https://docs.sorsa.io/target-audiences-Discovery) *** ## Verification Endpoints for checking whether a user performed a specific action (follow, retweet, comment, quote, community membership). Designed for campaign and giveaway verification. | Endpoint | Method | Description | Docs | | :------------------------ | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------- | | `/check-follow` | POST | Check whether `user_2` follows `user_1` (user\_1 = the followed account, user\_2 = the potential follower). Body: one identifier for each side (`username_1`/`user_id_1`/`user_link_1` and `username_2`/`user_id_2`/`user_link_2`). | [Docs](https://docs.sorsa.io/api-reference/verification/check-follow) | | `/check-comment` | GET | Did a user comment on a specific tweet? Returns the comment tweet if found. Query: `tweet_link` + `username`/`user_id`/`user_link`. | [Docs](https://docs.sorsa.io/api-reference/verification/check-comment) | | `/check-retweet` | POST | Did a user retweet a specific tweet? Scans up to 100 retweets per request. Body: `tweet_link` + user identifier. | [Docs](https://docs.sorsa.io/api-reference/verification/check-retweet) | | `/check-quoted` | POST | Did a user quote or retweet a specific tweet? Returns `status`: `quoted`, `retweet`, or `not_found`. Body: `tweet_link` + user identifier. | [Docs](https://docs.sorsa.io/api-reference/verification/check-quote-or-retweet) | | `/check-community-member` | POST | Is a user a member of a specific X Community? Body: `community_id` + user identifier. | [Docs](https://docs.sorsa.io/api-reference/verification/check-community-membership) | **Related guide:** [Marketing Campaign Verification](https://docs.sorsa.io/Marketing-Campaign-Verification) *** ## Community Endpoints for accessing X Community data: member lists, tweet feeds, and in-community search. | Endpoint | Method | Description | Docs | | :------------------------- | :----- | :------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- | | `/community-tweets` | POST | Tweet feed from a community. Body: `community_id`, `order` (`popular` or `latest`). | [Docs](https://docs.sorsa.io/api-reference/community/community-tweets) | | `/community-search-tweets` | POST | Search tweets within a community by keyword. Body: `community_link`, `query`, `order`. | [Docs](https://docs.sorsa.io/api-reference/community/search-community-tweets) | | `/community-members` | POST | Member list of a community with profiles. Body: `community_link`. | [Docs](https://docs.sorsa.io/api-reference/community/community-members) | **Related guide:** [Lists & Communities](https://docs.sorsa.io/lists-and-communities) *** ## Lists Endpoints for accessing X List data: member profiles, list subscribers, and the combined tweet feed. | Endpoint | Method | Description | Docs | | :---------------- | :----- | :------------------------------------------------------- | :--------------------------------------------------------------- | | `/list-members` | GET | Profiles of accounts in a list. Query: `list_id`. | [Docs](https://docs.sorsa.io/api-reference/lists/list-members) | | `/list-followers` | GET | Profiles of users who follow a list. Query: `list_link`. | [Docs](https://docs.sorsa.io/api-reference/lists/list-followers) | | `/list-tweets` | GET | Recent tweets from all list members. Query: `list_id`. | [Docs](https://docs.sorsa.io/api-reference/lists/list-tweets) | **Related guides:** [Lists & Communities](https://docs.sorsa.io/lists-and-communities) | [Real-Time Monitoring](https://docs.sorsa.io/real-time-monitoring) *** ## Sorsa Score (Crypto Analytics) Endpoints for crypto-specific analytics: influence scoring, follower categorization, and recent follow activity among crypto accounts in Sorsa's database. Accepts `username`, `user_id`, or `user_link`. | Endpoint | Method | Description | Docs | | :------------------ | :----- | :--------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | | `/score` | GET | Current Sorsa Score (crypto influence metric). | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/sorsa-score) | | `/score-changes` | GET | Score delta over the last week and month. | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/sorsa-score-changes) | | `/followers-stats` | GET | Follower breakdown: influencers, projects, VCs. | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/follower-category-stats) | | `/top-followers` | GET | Top 20 followers ranked by Sorsa Score (each entry includes the follower's score). | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/top-20-followers-by-score) | | `/top-following` | GET | Top 20 followed accounts ranked by Score. | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/top-20-following-by-score) | | `/new-followers-7d` | GET | Crypto accounts that followed in the last 7 days. | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/new-followers-7-days) | | `/new-following-7d` | GET | Crypto accounts the user started following in the last 7 days. | [Docs](https://docs.sorsa.io/api-reference/sorsa-info-crypto-related/new-following-7-days) | **Related guide:** [Sorsa Score & Crypto Analytics](https://docs.sorsa.io/sorsa-score-and-crypto-analytics) *** ## Technical Utilities Endpoints for ID conversion and API key usage monitoring. | Endpoint | Method | Description | Docs | | :------------------------------ | :----- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | | `/username-to-id/{user_handle}` | GET | Convert a username to a permanent User ID. | [Docs](https://docs.sorsa.io/api-reference/technical-endpoints/convert-username-to-user-id) | | `/id-to-username/{user_id}` | GET | Convert a User ID to the current username. | [Docs](https://docs.sorsa.io/api-reference/technical-endpoints/convert-user-id-to-username) | | `/link-to-id` | GET | Extract a User ID from a profile URL. Query: `link`. | [Docs](https://docs.sorsa.io/api-reference/technical-endpoints/convert-profile-link-to-user-id) | | `/key-usage-info` | GET | Current request usage, remaining quota, and balance expiration date. No parameters. | [Docs](https://docs.sorsa.io/api-reference/technical-endpoints/api-key-usage) | **Related guides:** [ID Conversion](https://docs.sorsa.io/ID-Conversion) | [Pricing](https://docs.sorsa.io/pricing) *** ## Data Models Two core objects appear across most endpoints. For full details, including every variant, field type, and edge case, see [Response Format](https://docs.sorsa.io/response-format). ### User Object Returned by `/info` and `/info-batch`, by the follower, following, and user-search endpoints, and embedded in every tweet response as the `user` field. Some endpoints add fields (for example, follower endpoints include a `followerDate`); see [Response Format](https://docs.sorsa.io/response-format) for those variants. | Field | Type | Description | | :----------------------------- | :-------- | :------------------------------- | | `id` | string | Permanent User ID (Snowflake) | | `username` | string | Current handle | | `display_name` | string | Display name | | `description` | string | Bio text | | `location` | string | Self-reported location | | `created_at` | string | Account creation date (ISO 8601) | | `followers_count` | integer | Follower count | | `followings_count` | integer | Following count | | `favourites_count` | integer | Total likes given | | `tweets_count` | integer | Total tweets posted | | `media_count` | integer | Media posts count | | `verified` | boolean | Verification status | | `protected` | boolean | Protected (private) account | | `can_dm` | boolean | DMs open | | `possibly_sensitive` | boolean | Sensitive content flag | | `profile_image_url` | string | Avatar URL | | `profile_background_image_url` | string | Banner image URL | | `bio_urls` | string\[] | URLs extracted from bio | | `pinned_tweet_ids` | string\[] | IDs of pinned tweets | ### Tweet Object Returned by `/tweet-info`, `/search-tweets`, `/user-tweets`, `/comments`, `/quotes`, `/mentions`, `/list-tweets`, and community tweet endpoints. | Field | Type | Description | | :--------------------- | :------------- | :--------------------------------- | | `id` | string | Tweet ID (Snowflake) | | `full_text` | string | Complete tweet text | | `created_at` | string | Post timestamp (ISO 8601) | | `lang` | string | Language code | | `likes_count` | integer | Likes | | `retweet_count` | integer | Retweets | | `reply_count` | integer | Replies | | `quote_count` | integer | Quotes | | `bookmark_count` | integer | Bookmarks | | `view_count` | integer | Views | | `conversation_id_str` | string | Thread/conversation ID | | `in_reply_to_tweet_id` | string | Parent tweet ID (if reply) | | `in_reply_to_username` | string | Parent author (if reply) | | `is_reply` | boolean | Whether this is a reply | | `is_quote_status` | boolean | Whether this is a quote tweet | | `is_replies_limited` | boolean | Replies restricted by author | | `made_with_ai` | boolean | Labeled as made with AI | | `paid_partnership` | boolean | Paid partnership (branded content) | | `user` | User | Complete author profile | | `entities` | TweetEntity\[] | Attached media and link entities | | `quoted_status` | Tweet | Nested quoted tweet (if quote) | | `retweeted_status` | Tweet | Nested retweeted tweet (if RT) | ### TweetEntity Object | Field | Type | Description | | :-------- | :----- | :-------------------------------------- | | `type` | string | Entity type: `photo`, `video`, or `url` | | `link` | string | Direct link (t.co URL) | | `preview` | string | Preview/thumbnail image URL | *** ## Common Patterns **Authentication:** All requests require the `ApiKey` header. See [Authentication](https://docs.sorsa.io/authentication). **Pagination:** Endpoints returning lists use cursor-based pagination. Pass the `next_cursor` from the previous response to fetch the next page. When the cursor is absent or null, you have reached the end. See [Pagination](https://docs.sorsa.io/pagination). **Error format:** All endpoints return `{ "message": "..." }` on errors (`400`, `401`, `403`, `404`, `429`, `500`). See [Error Codes](https://docs.sorsa.io/error-codes). **Rate limit:** 20 requests per second on all standard plans. See [Rate Limits](https://docs.sorsa.io/rate-limits). **Input flexibility:** Most user-related endpoints accept three input formats: `username`, `user_id`, or `user_link` (profile URL). Provide exactly one. *** ## Next steps * [Quickstart](https://docs.sorsa.io/quickstart) - Make your first API call in under a minute * [Response Format](https://docs.sorsa.io/response-format) - Detailed field types, null handling, and object schemas * [Search Operators](https://docs.sorsa.io/search-operators) - Build advanced queries for `/search-tweets` * [Optimizing API Usage](https://docs.sorsa.io/optimizing-api-usage) - Reduce request counts with batching, deduplication, and caching