IRC Driven API Usage

Use the REST API to read and manage networks, channels, and related data

Overview

The IRC Driven API is a REST API for authenticated users. It provides access to networks, channels, servers, quotes, news, and other resources. Access is scoped by role: staff and superusers can access all data; network and channel admins can access data for the networks and channels they administer.

• Authentication via token (Knox); required for all requests
• Rate limiting: 1000 requests per hour per user
• Interactive documentation (Swagger / ReDoc) for public endpoints
• Some endpoints are for internal use only and are not documented publicly

Base URL and authentication

Base URL: http://www.ircdriven.com/api/

All API requests must be authenticated. Use a Knox token in the Authorization header:

Authorization: Token <your_token>

Tokens can be created via the site (e.g. from your account or admin). Tokens expire after 24 hours by default; create a new token when needed.

Rate limiting

To keep the API fair and stable, requests are limited per authenticated user:

• 1000 requests per hour per user (token). Exceeding the limit returns 429 Too Many Requests.

If you need a higher limit for a legitimate use case, contact support.

Interactive documentation

Public API endpoints are documented in OpenAPI format. You can explore and try them here:

• Swagger UI – try requests from the browser
• ReDoc – readable API reference

Endpoints used only by internal services (e.g. crawler, indexer, bot) are not listed in the public docs.

Access scope

What you can access depends on your role:

• Staff / superuser: Full access to all networks, channels, and related resources.
• Network admin: Access to networks where you are an approved network admin, and their channels, servers, and nested resources.
• Channel admin: Access to channels where you are an approved channel admin (or network admin for that network), and their nested resources.

User, IRCLink, and some internal endpoints remain staff-only.