Skip to content

Postman Setup

Welcome to the Tweet Binder API v2! If you're looking to explore our API quickly and safely, Postman is the best place to start.

Using our ready-to-go collection, you can run real examples, test endpoints, and get familiar with the data responses — without writing a single line of code.

Import the API Collection into Postman

Click the button below to open our official Postman collection. You can fork it to your workspace with just one click:

Run in Postman

Tip: If you're new to Postman, check out their Quick Start Guide

⚙Set Up Your Environment

Once the collection is loaded into your Postman workspace, follow these simple steps to configure it:

Step-by-step:

  1. In Postman, go to Collections and find Tweet Binder API v2.
  2. Click the three dots ⋮ next to the collection name → choose Edit.

  3. Go to the Variables tab and set your API key:

    Variable Value
    apiKey Your_API_Key_Here

  4. Click Save.

Create a New Environment

Some request scripts store values (like report IDs) in the environment. For smooth execution:

  1. Click the gear icon (top right in Postman) → Environments.
  2. Click "Add" and create a new environment.
  3. You can name it Tweet Binder Dev, or anything you like.
  4. Leave it empty for now and activate it in the top-right dropdown.

Need help creating an environment? View guide →

You're Ready to Start!

You can now start testing endpoints such as:

  • POST /report – Create a historical or real-time report
  • GET /report/{id} – Fetch report metadata and metrics
  • GET /report/{id}/tweets – Access the actual tweet data
  • GET /user/metrics – Track user follower and mention history

All requests will use the apiKey variable automatically from your environment.

Need Help?

If you run into trouble or want to test custom use cases:

Contact Javier from the API team

We’re happy to help you debug, test advanced endpoints, or evaluate special setups.

Next Step: Review the Full API Reference

Once you're comfortable with Postman, head over to our full documentation to see every available endpoint:

Go to Full Reference