Tài liệu API dành cho Nhà phát triển
Dịch vụ cho phép làm việc với chúng tôi qua API, hữu ích khi phần mềm của bạn hỗ trợ API hoặc muốn phân phối lại proxy dưới thương hiệu của bạn. Đầu tiên hãy đăng nhập và tạo API key tại form trên đầu trang. API key được dùng cho mọi yêu cầu tới API. Bạn chỉ được phép có 1 API key. Có thể làm mới API key bất kỳ lúc nào, các key cũ sẽ tự động vô hiệu hóa.
Khuyến nghị:
1. Cập nhật quốc gia, bang/vùng và thành phố ít nhất 1 phút/lần hoặc trước khi tạo/cập nhật proxy
2. Định dạng link proxy hiếm khi thay đổi. Liên hệ hỗ trợ nếu cần định dạng đặc biệt
3. KHÔNG được bỏ qua giới hạn subaccount! Nếu bán proxy, luôn đặt giới hạn để tránh mất tiền từ tài khoản
4. Có thể dùng tên miền riêng thay thế: ping gateway kết nối của chúng tôi để lấy IP và cập nhật DNS. Chỉ hỗ trợ IPv4. Liên hệ hỗ trợ nếu cần trợ giúp.
Thông tin chung
Bắt buộc thêm API key vào header yêu cầu:
Content-Type: application/json
Authorization: ApiKey 00000000-0000-0000-0000-000000000000
Lỗi sẽ trả về mã HTTP, mô tả ngắn và cờ 'success'=false:
{
"data": {
"general": "API key not recognized or user is blocked"
},
"success": false
}
Giới hạn request được áp dụng cho tất cả API endpoints. Không gửi request quá thường xuyên để tránh lỗi 429. Kiểm tra header phản hồi để biết số request còn lại:
< X-Ratelimit-Limit: 5
< X-Ratelimit-Remaining: 4
< X-Ratelimit-Reset: 15
Số dư tài khoản
Yêu cầu lấy số dư tài khoản hiện tại:
curl -X GET https://supernovanet.org/api/v1/balance -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
### Get Balance GET https://supernovanet.org/api/v1/balance Authorization: ApiKey 00000000-0000-0000-0000-000000000000
Phản hồi thành công sẽ có dạng:
HTTP/1.1 200 OK
Date: Thu, 01 Apr 2025 00:00:00 GMT
Content-Type: application/json
Content-Length: 73
X-Ratelimit-Limit: 5
X-Ratelimit-Remaining: 4
X-Ratelimit-Reset: 15
Connection: close
{
"data": {
"balance_string": "$14.97",
"balance_float": 14.97
},
"success": true
}
Quốc gia khả dụng
Yêu cầu lấy danh sách quốc gia. Danh sách này bao gồm tất cả proxy bất kể loại, tương đương chọn tất cả loại proxy. Không thể lọc theo loại.
curl -X GET https://supernovanet.org/api/v1/inventory/countries -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
Phản hồi thành công sẽ có dạng:
{
"data": [{
"name": "France",
"iso": "FR"
},
... // More countries in the list
{
"name": "Latvia",
"iso": "LV"
}],
"success": true
}
Bang/Vùng và Quốc gia khả dụng
Yêu cầu lấy bang/vùng từ quốc gia đã chọn. Danh sách bao gồm tất cả proxy (Mobile, Residential, Mixed). Bắt buộc chỉ định quốc gia. Sẽ nhận được toàn bộ bang/vùng của quốc gia đó.
curl -X GET "https://supernovanet.org/api/v1/inventory/targeting?country=US" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
Có thể lọc thành phố theo bang bằng cách chỉ định ID bang:
curl -X GET "https://supernovanet.org/api/v1/inventory/targeting?country=US&state=4361885" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
Phản hồi thành công sẽ có dạng:
{
"data": {
"states": [{
"name": "Maryland",
"id": 4361885
},
... // More states
{
"name": "Illinois",
"id": 4896861
}
],
"cities": [{
"name": "Kissimmee",
"id": 4160983
},
... // More cities
{
"name": "Ellsworth",
"id": 4963692
}
]
},
"success": true
}
Định dạng Proxy Link
Yêu cầu lấy định dạng link proxy (cần ID định dạng để tạo link sau này)
curl -X GET https://supernovanet.org/api/v1/formats -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
Phản hồi thành công sẽ có dạng:
{
"data": [{
"id": 1,
"name": "login:pass@host:port",
"description": "No scheme: login:pass@host:port",
"format": "{login}:{password}@{host}:{port}"
},
... // More formats in the list
{
"id": 2,
"name": "login:pass@ip:port",
"description": "No scheme: login:pass@ip:port",
"format": "{login}:{password}@{ip}:{port}"
}],
"success": true
}
Subaccount đang hoạt động
Subaccount có thể coi như user trong hệ thống của bạn. Có trạng thái active/archived và giới hạn về ngày, chi phí, traffic. Là entity chính để theo dõi thống kê.
KHÔNG dùng chung subaccount cho nhiều user khác nhau do họ sẽ dùng chung mật khẩu và giới hạn!
Lấy danh sách subaccount active. Có thể chỉ định tham số tùy chọn p (trang) và l (giới hạn/trang). Mặc định có phân trang. Tối đa 300 phần tử/request.
curl -X GET "https://supernovanet.org/api/v1/subaccounts/active?p=1&l=30" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
Phản hồi thành công sẽ có dạng:
{
"data": {
"limit": 30,
"page": 1,
"total_rows": 1,
"total_pages": 1,
"rows": [{
"port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Main identificator of your Subaccount
"name": "My List №1",
"total_traffic": 0, // In Bytes
"total_spend": 0, // In Dollars
"status": 1, // See below
"amount_limit": 123, // In Dollars
"traffic_limit": 1, // In Gigabytes
"date_limit": "2025-04-20T00:00:00+00:00",
"last_bytes_at": null,
"created_at": "2025-04-16T17:35:13.313+00:00"
}]
},
"success": true
}
Các trạng thái subaccount:
WORKING = 0
PAUSED = 1
PAUSED DUE TO SUBACCOUNT LIMITS = 2
PAUSED DUE TO NO FUNDS = 3
Subaccount đã lưu trữ
Có thể lưu trữ subaccount không còn sử dụng. Lấy danh sách subaccount archived với tham số p và l tương tự. Tối đa 300 phần tử/request.
curl -X GET "https://supernovanet.org/api/v1/subaccounts/archived?p=1&l=30" -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000"
Phản hồi thành công sẽ có dạng:
{
"data": {
"limit": 30,
"page": 1,
"total_rows": 1,
"total_pages": 1,
"rows": [{
"port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Main identificator of your Subaccount
"name": "My List №1",
"total_traffic": 0,
"total_spend": 0,
"status": 1, // Status automatically set to Paused when you archive your subaccount!
"amount_limit": 123,
"traffic_limit": 1,
"date_limit": "2025-04-20T00:00:00+00:00",
"last_bytes_at": null,
"created_at": "2025-04-10T17:35:13.313+00:00",
"archived_at":"2025-04-16T18:20:44.024+00:00" // Pay attention to new field in archived
}]
},
"success": true
}
Phản hồi thành công sẽ có dạng:
Có thể thêm subaccount kèm giới hạn và mật khẩu. Nếu không chỉ định mật khẩu, hệ thống sẽ tự sinh
LUÔN đặt giới hạn nếu bạn bán lại proxy!
curl -X POST https://supernovanet.org/api/v1/subaccounts/add \ -H "Content-Type: application/json" \ -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \ -d '{ "name": "Test Subaccount", "password": "testpassword123", "amount_limit": 100.0, "traffic_limit": 1024.0, "date_limit": "2025-12-31" }'
Mô tả chi tiết các trường trong yêu cầu:
{ "name": "Test Subaccount", // Name of your Subaccount (for your convenience) "password": "testpassword123", // Password. Leave it blank and we will generate it by our own "amount_limit": 100.0, // Amount in US dollars after this subaccount will be stopped "traffic_limit": 1024.0, // Amount in Gigabytes after this subaccount will be stopped "date_limit": "2025-12-31" // Date after this subaccount will be stopped (last working date) }'
Phản hồi thành công sẽ có dạng:
{
"data": {
"port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // This identificator will be required to edit port later!
"password": "testpassword123",
"name": "Test Subaccount",
"total_traffic": 0,
"total_spend": 0,
"status": 0,
"amount_limit": 100,
"traffic_limit": 1024,
"date_limit": "2025-12-31T00:00:00+00:00",
"last_bytes_at": null,
"created_at": "2025-04-01T12:00:00.000+00:00"
},
"success": true
}
Chỉnh sửa Subaccount (Danh sách hoặc Port)
Để sửa subaccount cần có port identifier. Yêu cầu tương tự như thêm mới nhưng phải thêm trường port
Nếu không chỉ định 'port' sẽ tạo ra subaccount mới!
curl -X POST https://supernovanet.org/api/v1/subaccounts/edit \ -H "Content-Type: application/json" \ -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \ -d '{ "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", "name": "Test Subaccount", "password": "testpassword123", "amount_limit": 100.0, "traffic_limit": 1024.0, "date_limit": "2025-12-31" }'
Mô tả chi tiết các trường trong yêu cầu:
{ "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Identificator of your Subaccount. Mandatory field for edit subaccount. "name": "Test Subaccount", // Name of your Subaccount (for your convenience) "password": "testpassword123", // Password. Leave it blank and we will generate it by our own "amount_limit": 100.0, // Amount in US dollars after this subaccount will be stopped "traffic_limit": 1024.0, // Amount in Gigabytes after this subaccount will be stopped "date_limit": "2025-12-31" // Date after this subaccount will be stopped (last working date) }'
Phản hồi thành công sẽ có dạng:
{
"data": {
"port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // This identificator will be required to edit port later!
"password": "testpassword123",
"name": "Test Subaccount",
"total_traffic": 0,
"total_spend": 0,
"status": 0,
"amount_limit": 100,
"traffic_limit": 1024,
"date_limit": "2025-12-31T00:00:00+00:00",
"last_bytes_at": null,
"created_at": "2025-04-01T12:00:00.000+00:00"
},
"success": true
}
Bắt đầu, Dừng, Lưu trữ và Khôi phục
Có thể quản lý trạng thái subaccount để dừng/khởi động proxy ngay lập tức
curl -X POST https://supernovanet.org/api/v1/subaccounts/command \ -H "Content-Type: application/json" \ -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \ -d '{ "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", "command": "start" }'
Mô tả chi tiết các trường trong yêu cầu:
{ "port": "YOUR_SUBACCOUNT_IDENTIFICATOR", // Identificator of your Subaccount. Mandatory field for edit subaccount. "command": "start" // Possible values of command: 'archive' 'restore' 'pause' 'start' }'
Phản hồi thành công sẽ có dạng:
{
"data": "ok",
"success": true
}
Tạo link kết nối proxy
Để tạo link kết nối proxy, cần chỉ định subaccount, loại link, số lượng link (tối đa 10000), loại xoay vòng, quốc gia (bắt buộc), bang (tùy chọn) và thành phố (tùy chọn)
Lưu ý URL yêu cầu. Port identifier của subaccount được thể hiện trong URL!
curl -X POST https://supernovanet.org/api/v1/subaccounts/YOUR_SUBACCOUNT_IDENTIFICATOR/generate-links \ -H "Content-Type: application/json" \ -H "Authorization: ApiKey 00000000-0000-0000-0000-000000000000" \ -d '{ "link_type": 7, "mob": true, "res": true, "mix": true, "country": "US", "city": 123, "state": 45, "session": "rotate", "quantity": 1000 }'
Mô tả chi tiết các trường trong yêu cầu:
{ "link_type": 7, // Mandatory. This ID is from Proxy Link Formats "mob": true, // Mandatory. If you need Mobile proxies. Please pay attention that one of mob, res or mix fields must be true! "res": true, // Mandatory. If you need Residential proxies. Please pay attention that one of mob, res or mix fields must be true! "mix": true, // Mandatory. If you need Mixed proxies. Please pay attention that one of mob, res or mix fields must be true! "country": "US", // Mandatory! Country from list of available ones "city": 123, // Optional: city id from Available States/Regions and Countries. Ignored if no that City available. "state": 45, // Optional: city id from Available States/Regions and Countries. Ignored if no that State available. "session": "rotate", // Mandatory. Possible values: "rotate", "keep" "quantity": 1000 // Optional. Links quantity. By default is one. Up to 10000, but specify reasonable amount. }'
Phản hồi thành công sẽ có dạng:
{
"data": [
"http://YOUR_SUBACCOUNT_IDENTIFICATOR-iso-us-t-mrv-st-r-s-1cdvecqqnu:[email protected]:9090",
"http://YOUR_SUBACCOUNT_IDENTIFICATOR-iso-us-t-mrv-st-r-s-xboz8dc60t:[email protected]:9090"
],
"success": true
}