Check out VRCPulseIntegrations
API
Read-only HTTP API for the groups and worlds registered to an account. Available on the Pro and Ultra plans.
API keys
- Open Settings, Developer, API Keys, and choose New key.
- Store the key. It is displayed once and cannot be retrieved later.
| Property | Value |
|---|---|
| Keys per account | 10 |
| Access | Read-only |
| Scope | Assets registered to the owning account |
Authentication
Base URL: https://app.vrcpulse.com/api/v1. Send the key as a bearer token on every request:
curl https://app.vrcpulse.com/api/v1/groups \
-H "Authorization: Bearer YOUR_API_KEY"| Status | Meaning |
|---|---|
401 | Missing or invalid API key |
403 | Plan does not include API access, workspace is read-only, or the group is not owned by the account |
404 | World or instance not found for the account |
429 | Rate limit exceeded |
Rate limits
| Plan | API access | Requests per minute |
|---|---|---|
| Free | No | n/a |
| Supporter | No | n/a |
| Pro | Yes | 60 |
| Ultra | Yes | 120 |
Limits apply per account across all of its keys, in a fixed one-minute window. Every response includes:
| Header | Value |
|---|---|
RateLimit-Limit | Requests allowed in the current window |
RateLimit-Remaining | Requests remaining in the current window |
RateLimit-Reset | Unix time in seconds when the window resets |
Retry-After | Seconds to wait; sent with 429 responses |
Reference
Endpoints, parameters, and response schemas are documented in the API reference.