API Documentation
Complete REST API for integrating IPTV Secure Links with your applications and automation workflows.
Getting Started
The IPTV Secure Links API provides programmatic access to all scanning, link management, and export functionality. All endpoints return JSON responses.
Authentication
Currently, the public API is open for read access. For write operations, include your API key in the header:
Base URL
Endpoints
Retrieve a list of IPTV links with optional filtering.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| status | string | Filter by status: VALID, INVALID, PENDING, ERROR |
| portal | string | Filter by portal URL (partial match) |
| limit | integer | Results per page (default: 20, max: 100) |
| offset | integer | Offset for pagination |
| since | integer | Unix timestamp - only links created after this time |
Example Response
Start a new MAC scanning job. Results are automatically saved to the database.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| urls | string | Yes | Portal URLs, one per line |
| macs | string | No* | MAC addresses, one per line |
| use_example | boolean | No | Generate example MACs |
| example_count | integer | No | Number of example MACs (default: 100) |
| thread_count | integer | No | Concurrent threads (default: 4, max: 16) |
| output_type | string | No | MAC_AND_IPTV_S_LINKS, MAC_ONLY, IPTV_S_LINKS |
* Required if use_example is false
Example Request
Submit a single IPTV link manually. Useful for importing existing links.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| portal_url | string | Yes | Portal URL |
| mac | string | Yes | MAC address (XX:XX:XX:XX:XX:XX) |
| status | string | No | VALID, INVALID, PENDING, ERROR (default: VALID) |
| exp_date | string | No | Expiry date |
| username | string | No | Account username |
| password | string | No | Account password |
| secure_link | string | No | Pre-generated secure link |
Get current site statistics.
Response Fields
| Field | Type | Description |
|---|---|---|
| totalLinks | integer | Total valid links |
| totalScans | integer | Total scan jobs |
| totalPortals | integer | Unique portals |
| todayLinks | integer | Links discovered today |
| lastUpdate | integer | Unix timestamp of last update |
Export links in various formats. Supports json, csv, and txt.
Path Parameters
| Parameter | Description |
|---|---|
| format | Export format: json, csv, or txt |
Query Parameters
| Parameter | Description |
|---|---|
| portal | Filter by portal URL |
| date_from | Start date (YYYY-MM-DD) |
| status | Filter by status |
Quick Reference
Status Codes
- VALID Active working link
- INVALID MAC rejected by portal
- PENDING Scan in progress
- ERROR Connection failed
- NEW Discovered in last hour
Rate Limits
60 requests/minute for public API
1000 requests/minute with API key
Response Codes
- 200 OK - Success
- 400 Bad Request - Invalid parameters
- 401 Unauthorized - Invalid API key
- 429 Too Many Requests - Rate limited
- 500 Server Error - Internal error