API Documentation
Pages: API Tokens · Interactive API Docs
The Statbate Plus API provides programmatic access to analytics data for Studio Plus accounts. Use the in-app interactive docs for exact request and response schemas; use this page for access rules, endpoint families, and production limits.
Access
- API access is included with Studio Plus.
- Create dedicated API tokens from plus.statbate.com/api/tokens.
- Send the token as a bearer token:
Authorization: Bearer your-api-token-here
The API also accepts your account identifier as a bearer token for quick testing, but a dedicated API token is safer for scripts and integrations.
Endpoint Families
| Area | Examples | Use |
|---|---|---|
| Models | /model/{site}/{name}/info, /activity, /tips, /sessions, /chat | Model profile, earnings, sessions, and chat history |
| Members | /members/{site}/{name}/info, /tips, /model/{model}, /activity, /top-models | Member spending and activity analysis |
| Batch members | /members/{site}/info/batch, /model-spending/batch, /top-models/batch | Efficient bulk lookups for up to 100 members at a time |
| Messages | /messages/search | Global message search with room, sender, text, page, and cursor filters |
| Tags | /tags, /tags/search | Tag metadata and search |
| Live room data | /room/{site}/{roomname}/online-users | Current online user list where supported |
Rate Limits
Rate limits use multiple buckets. A request must fit under every bucket that applies to its route.
| Bucket | Paid Studio Plus limit | Scope |
|---|---|---|
| General API account bucket | 120 requests/minute | Shared by authenticated API endpoints that use the general API throttle |
| General API IP bucket | 600 requests/minute | Shared by traffic from the same real client IP |
/messages/search account bucket | 120 requests/minute | Separate from the general API bucket; split by query shape |
/messages/search IP bucket | 180 requests/minute | Separate from the general API IP bucket; split by query shape |
| Batch endpoint account bucket | 120 requests/minute | Per batch endpoint bucket |
| Batch endpoint IP bucket | 600 requests/minute | Per batch endpoint bucket and real client IP |
An authenticated principal is the Statbate account/user, not each individual API token. Multiple API tokens under one account share the same 120/min account bucket. Using multiple IP addresses does not increase one account above 120/min. Multiple accounts or tokens on the same IP can still hit the shared 600/min IP bucket.
Only the per-minute buckets above are enforced. Parallel requests can still receive 429 Too Many Requests when one of those buckets is exhausted.
Rate-limit responses include standard headers such as X-RateLimit-Limit and X-RateLimit-Remaining. On 429 responses, use Retry-After and X-RateLimit-Reset for backoff.
Batch Endpoint Limits
| Endpoint | Input cap | Date/range cap | Notes |
|---|---|---|---|
POST /members/{site}/info/batch | 100 names | Fixed trailing 30-day daily token payload | No custom range; no field filtering; snapshot-backed fields refresh about every 5 minutes |
POST /members/{site}/model-spending/batch | 100 usernames or names | 31 days | Requires model_username or model; optimized for "member spent on this model" lookups |
POST /members/{site}/top-models/batch | 100 names | 31 days | Returns up to 50 top models per member |
Batch endpoints are designed to reduce request volume. If you are calling many single-member endpoints in a loop, check whether a batch endpoint can replace that pattern before requesting higher raw limits.
Messages Search
GET /messages/search supports room, sender, text query, date range, zero-based page pagination, and opaque cursor / next_cursor pagination. per_page is clamped to 10-500. Page-mode totals are windowed, not exact full-result counts.
Its rate-limit buckets are separate from the general API buckets. The account limit is still 120/min, but it is counted separately from the general API limit. The IP limit is lower at 180/min. Message-search limits are also split by query shape, so browsing a room and running text searches do not necessarily consume the same exact limiter key.
Higher Limits And API Features
If current limits are not enough, contact support before building around higher request volume. In many cases, the same use case can be handled with a batch endpoint, a different endpoint shape, or a more efficient request pattern.
When requesting higher limits or a new API feature, include:
- endpoints you call
- expected request volume
- whether the workload is real-time or batch
- data you are trying to collect
- whether a batch endpoint or different response shape would solve the problem
Contact:
- Email: [email protected]
- Telegram: @statbate_support