Check Balance¶
Method: GET
Endpoint: {{apiRoute}}/me/balances
This endpoint allows you to check your current usage balances, depending on the limits defined by your Tweet Binder subscription.
Balances are renewed monthly and do not accumulate from one month to the next.
What You’ll See in the Balance¶
The response includes several different usage limits and counters. Here's what each of them means:
1. Posts (Tweets)¶
This is the main quota and limits how many tweets you can analyze across all your reports.
- Example: If your balance shows 10,000 posts, you could:
- Create 2 reports of 5,000 tweets each, or
- Create 4 reports of 2,500 tweets each.
Each time you create a report, the number of tweets (aka publications) used is deducted from this balance.
2. Reports¶
API subscriptions allow unlimited reports, as long as you stay within your posts limit.
Reports can be of different types:
- Historical reports
- 7-day reports
- Live tracking reports
3. Clones¶
This is the number of times you are allowed to clone an existing report.
Cloning is useful when you want to:
- Create a backup before making changes.
- Duplicate a structure or setup for similar tracking needs.
4. Twitter Parallel Streams¶
This value indicates how many live reports you can have running at the same time.
- If your balance shows
3
, you can monitor 3 live streams concurrently. - Useful for tracking multiple hashtags or accounts in real-time.
5. Twitter Parallel User Trackers¶
This value limits how many user tracking reports can run in parallel.
- Example: If your limit is
2
, you can track two Twitter users at once in real time.
6. Twitter Count Reports (Historical or 7-Day)¶
This shows how many count-only reports you can create, either for:
- Historical data
- Recent 7-day periods
Count reports are simpler and typically used when you only need tweet volumes, not full content.
Summary¶
Use this endpoint to monitor your available usage and plan accordingly. Always make sure you have enough:
- Posts to cover your report size
- Clones to back up reports
- Parallel streams/trackers to run live monitoring
Each field in the /me/balances
response corresponds to a quota that resets every month.