API & Dev
Developer Portal
Integrate ListenX stats into your own apps with our public API.
• Base URL
http://localhost:3000
All endpoints are prefixed with this base URL. The API is public and requires no authentication for read-only stats endpoints.
• Endpoints
GET
/stats
Returns live bot statistics including server count, user count, ping, and uptime in seconds.
GET http://localhost:3000/stats
{
"servers": 1240,
"users": 83400,
"ping": 42,
"uptime": 864000
}
GET
/status
Returns bot online/offline status and current shard information.
GET http://localhost:3000/status
{
"online": true,
"shards": 2,
"version": "2.0.1"
}
GET
/ping
Simple ping endpoint. Returns current API and bot latency in milliseconds.
GET http://localhost:3000/ping
{
"api": 18,
"bot": 42
}
• Rate Limits
The public API is rate limited to protect reliability for all users.
| Tier |
Limit |
Window |
Access |
| Public |
60 requests |
1 minute |
No key needed |
| Developer |
600 requests |
1 minute |
API key required |
| Premium |
Unlimited |
— |
Premium plan required |
• Code Example — JavaScript
fetch('http://localhost:3000/stats')
.then(res => res.json())
.then(data => {
console.log('Servers:', data.servers);
console.log('Users:', data.users);
console.log('Ping:', data.ping + 'ms');
})
.catch(err => console.error('API offline', err));
• Code Example — Python
import requests
res = requests.get('http://localhost:3000/stats')
data = res.json()
print(f"Servers: {data['servers']}")
print(f"Users: {data['users']}")
print(f"Ping: {data['ping']}ms")
• Developer Contact
Need a higher rate limit, want to report an API issue, or have a collaboration idea? Reach out through the Support Server. We are always open to working with developers building on top of ListenX.
• Join Support Server
ListenX