API Docs/Get Started/Introduction

API Reference

Getting Started with TweetsMash API

The TweetsMash API is a REST API at api.tweetsmash.com/v1 for your 𝕏 (Twitter) bookmarks and labels. Authenticate with a Bearer token and make your first request in a few minutes.

Base URL — all requests go to https://api.tweetsmash.com. Include your API key in the Authorization header on every request.

Authentication

All API requests require authentication using your API key. Follow these steps to get your API key:

Visit the API Integration Page

Go to the TweetsMash API integration page to generate your API key.

Open API Integration Page

Generate Your API Key

Once on the integration page, you'll see a button to generate your API key. Click it to create a new key.

Note: Your API key is sensitive information. Keep it secure and never share it publicly.

Use Your API Key

Include your API key in the Authorization header of your requests:

›Authorization: Bearer YOUR_API_KEY_HERE

Quick Start Example

Here's a simple example of how to fetch your bookmarks using cURL:

cURL Command:

cURL

curl -X GET "https://api.tweetsmash.com/v1/bookmarks" \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Response Example:

JSON

{
  "status": true,
  "data": [
    {
      "post_id": "1938682607145034084",
      "tweet_details": {
        "text": "Your tweet content here...",
        "link": "https://twitter.com/username/status/1938682607145034084",
        "posted_at": "2025-06-27T19:35:27+00:00"
      },
      "author_details": {
        "name": "Author Name",
        "username": "username"
      }
    }
  ],
  "meta": {
    "next_cursor": "MTc1OTYxNw==",
    "limit": 20,
    "total_count": 396
  }
}

Rate Limits

To ensure fair usage, API requests are subject to rate limits:

100 requests per hour per API key

Error Handling

The API returns standard HTTP status codes and error messages:

Status

Meaning

401

Unauthorized - Invalid or missing API key

402

Subscription Required - Upgrade your plan

429

Too Many Requests - Rate limit exceeded

500

Internal Server Error - Something went wrong

Next Steps

Now that you have your API key, explore the available endpoints:

Bookmarks

Fetch and manage your saved tweets with filtering and pagination options.

View Documentation →

Labels

Manage labels for organizing your bookmarks and content.