Complete XUI.ONE Admin API Documentation Released! Professional • Interactive • Free & Open Source
What's New?We're excited to announce the release of comprehensive, professional API documentation for the XUI.ONE IPTV Panel Admin API!
After extensive work, we've created a complete reference with 111 fully documented endpoints across 15 categories, available as an interactive Swagger UI with live examples.
What's Included?
Interactive Swagger UI- Try endpoints directly in your browser
- Real-time testing with your own API credentials
- Automatic request/response examples
- Professional OpenAPI 3.0 specification
Complete Coverage (111 Endpoints)Category 1: Authentication
Category 2: GET INFO (11 endpoints)
Category 3: Line API (8 endpoints)
Category 4: Logs & Events (11 endpoints)
Category 5: User API (6 endpoints)
Category 6: MAG API (9 endpoints)
Category 7: Enigma API (9 endpoints)
Category 8: Streams API (6 endpoints)
Categories 9-13: Content Management
Category 14: Server API (8 endpoints)
Category 15: Settings & System (14 endpoints)
- User authentication and API key management
Category 2: GET INFO (11 endpoints)
- Query lines, users, streams, channels, movies, series
- MAG devices, Enigma2 devices, packages
Category 3: Line API (8 endpoints)
- Create, edit, delete subscription lines
- Enable, disable, ban/unban operations
Category 4: Logs & Events (11 endpoints)
- Activity logs, live connections, credit logs
- Stream errors, login logs, MAG events
Category 5: User API (6 endpoints)
- Create and manage admin, reseller, and user accounts
- Credit management for resellers
Category 6: MAG API (9 endpoints)
- Complete MAG device management
- Convert MAG devices to M3U lines
Category 7: Enigma API (9 endpoints)
- Full Enigma2 device support
- Device conversion capabilities
Category 8: Streams API (6 endpoints)
- Create and manage live TV streams
- Start/stop stream encoding
Categories 9-13: Content Management
- Channels, Radio Stations, Movies, Series, Episodes
- Complete VOD and live content control
Category 14: Server API (8 endpoints)
- Server installation and management
- Load balancer configuration
- Server statistics and monitoring
Category 15: Settings & System (14 endpoints)
- Panel settings, categories, bouquets
- Database backup/restore
- Cache management, nginx reload
Code Examples in Multiple LanguagesEvery endpoint includes working examples in:
- Python (with complete manager classes)
- PHP (production-ready code)
- JavaScript (Node.js and Browser)
- cURL (command-line testing)
Example: Create a Subscription Line
Python:
Python:
manager = XUILineManager(base_url, api_key)
result = manager.create_line(
username="customer001",
password="secure123",
exp_date="2025-12-31",
max_connections=1,
bouquets_selected=[1, 2, 3]
)PHP:
PHP:
$manager = new XUILineManager($baseUrl, $apiKey);
$result = $manager->createLine(
"customer001",
"secure123",
["exp_date" => "2025-12-31"]
);cURL:
Bash:
curl -X POST "http://your-server.com/access/?api_key=KEY&action=create_line" \
-d "username=customer001" \
-d "password=secure123" \
-d "exp_date=2025-12-31" | 111 Fully Documented Endpoints | Every single API action covered |
| | Interactive Testing | Try APIs directly in your browser |
| | Complete Code Examples | Copy-paste ready code |
| | Best Practices | Security, validation, error handling |
| | Real Use Cases | Practical examples for common tasks |
| | Professional Quality | Industry-standard OpenAPI spec |
| | Always Up-to-Date | Version controlled on GitHub |
| | 100% Free | Open source and community-driven |
What Can You Build?With this documentation, you can easily:
Automate subscription management - Bulk create/edit/delete lines
Build custom dashboards - Real-time monitoring and analytics
Create billing systems - Integrate with payment processors
Mobile apps - Native iOS/Android subscription managers
Notification systems - Alert on expirations, connection issues
Business intelligence - Advanced reporting and insights
Reseller portals - White-label customer management
DevOps automation - CI/CD, monitoring, backups
Documentation HighlightsComprehensive Guides for Each Category:
Each category includes:
Detailed endpoint descriptions
Common use cases and examples
Important notes and warnings
Security best practices- Batch operation examples
Error handling patterns
Special Features:
- Build real-time dashboards
- Connection sharing detection
- Stream health monitoring
- Security alert systems
- MAG and Enigma2 support
- Device conversion tools
- MAC address validation
- Bulk registration scripts
- Stream, channel, and VOD management
- Automated content organization
- Metadata management
- EPG integration examples
Bonus: Reusable Code LibrariesThe documentation includes complete, production-ready manager classes:
- XUILineManager - Complete line management
- XUIUserManager - User account control
- XUIMAGManager - MAG device handling
- XUIMonitor - Real-time monitoring
- XUIStreamsManager - Stream control
Just copy, customize, and deploy!
Community Contributions Welcome!This is an open-source project and we'd love your help to make it even better!
Ways to Contribute:
Report issues or bugs- Suggest improvements
- Add more examples
Translate to other languages
Star the repo on GitHub
Share with fellow developers
How to Get StartedQuick Start in 4 Steps:
STEP 1: Visit the documentation
https://worldofiptvcom.github.io/xui-one-api-docs/
STEP 2: Configure your server settings
- Server URL/IP
- Protocol (HTTP/HTTPS)
- Custom Port
- Access Code
STEP 3: Enter your API key
(Generate from XUI.ONE admin profile → Management → Access Control)
STEP 4: Click "Authorize" and start testing!
Need help generating your API key? said:
Feedback & SupportHave questions or suggestions?
- Reply to this thread
- Report issues on GitHub
- Start a discussion
Contact the maintainers
By the Numbers
111 Endpoints | 15 Categories | 4 Languages |
2,720+ Lines of Code | 15 Doc Files | 100% Free |
Special ThanksBig shoutout to everyone who requested this, provided feedback, and helped test the documentation. This project exists because of community demand - thank you!
Quick Links| Live Documentation | https://worldofiptvcom.github.io/xui-one-api-docs/ |
 GitHub Repository | https://github.com/worldofiptvcom/xui-one-api-docs |
| Getting Started | Getting Started Guide |
| Category Docs | Browse on GitHub |
Spread the Word!If you find this useful, please:
- Star the GitHub repository
Share with fellow XUI.ONE users- Leave feedback and suggestions
Contribute improvements
Let's build amazing things together!
Happy Coding!
Compatible with XUI.ONE v1.5.5+ | API Version 1.5.13
Compatible with XUI.ONE v1.5.5+ | API Version 1.5.13
