Version 1 - 03/04/2024
Rate limit: 3-4 requests / second
API key: Account -> Settings -> Account -> API Details
Bugs/error/changes: Please report if something is not as desired.
GEThttps://voe.sx/api/account/info?key=YOUR_API_KEY
Provides some general information about the account. Cache: 5min
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"email":"email@example.com",
"balance":"0.00000",
"storage_used":2101860825,
"storage_left":-2028119001,
"premium_until":"0000-00-00 00:00:00",
"partner_until":"0000-00-00 00:00:00"
}
}
GEThttps://voe.sx/api/account/stats?key=YOUR_API_KEY
Statistics for the last 32 days.
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"2023-02-26":{
"date":"2023-03-31",
"views":0,
"views_adb":0,
"views_vpn_proxy":0,
"views_paid":0,
"views_tor":0,
"uploads":0,
"downloads":0,
"profit_total":0,
"views_total":0
},
}
}
GEThttps://voe.sx/api/upload/server?key=YOUR_API_KEY
Step 1: Get a suitable upload server.
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":"https://delivery-node-***.voe-network.net/***/01"
}
POSThttps://delivery-node-***.voe-network.net/***/01
Step 2: Upload file to delivery node (form-data)
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| file |
binary |
File to upload |
Example response
{
"success":true,
"message":"File has been uploaded successfully.",
"file":{
"id":1,
"file_code":"abc123456789",
"file_title":"File.mp4",
"encoding_necessary":false
}
}
GEThttps://voe.sx/api/upload/url?key=YOUR_API_KEY&url=YOUR_FILE_URL
Add url to remote upload queue
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| url |
string |
URL (http/https/ftp) |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"file_code":"abc123456789",
"queueID": 1
}
}
GEThttps://voe.sx/api/upload/url/list?key=YOUR_API_KEY
Show all current remote uploads
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| id |
integer |
remote upload queue id |
Example response
{
"server_time":"2024-04-03 00:00:00",
"msg":"Success",
"message":"List returned.",
"status":200,
"success":true,
"list":{
"current_page":1,
"data":[
{
"id":757602,
"folder_id":0,
"file_code":"xxxxxxxxxx",
"url":"https:\/\/tiktok.com?v=2457433",
"status":3,
"status_note":"Already completed (2).",
"created_at":"2023-11-23T06:10:03.000000Z",
"started_at":null,
"updated_at":"2023-11-23T06:11:32.000000Z",
"total_size":0,
"loaded_size":0,
"speed":0,
"estimated_duration":0,
"percent":100,
"additional_headers":null
}
],
"first_page_url":"https:\/\/voe.sx\/api\/upload\/url\/list?page=1",
"from":1,
"last_page":1,
"last_page_url":"https:\/\/voe.sx\/api\/upload\/url\/list?page=1",
"links":[
{
"url":null,
"label":"« Previous",
"active":false
},
{
"url":"https:\/\/voe.sx\/api\/upload\/url\/list?page=1",
"label":"1",
"active":true
},
{
"url":null,
"label":"Next »",
"active":false
}
],
"next_page_url":null,
"path":"https:\/\/voe.sx\/api\/upload\/url\/list",
"per_page":100,
"prev_page_url":null,
"to":1,
"total":1
}
}
GEThttps://voe.sx/api/file/clone?key=YOUR_API_KEY&file_code=xxxxxxxxx&fld_id=0
Clone existing file code, PROVIDED THE FILE OWNER HAS ALLOWED CLONING!
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| url |
string |
URL (http/https/ftp) |
| fld_id |
integer |
Folder id, not required |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"filecode":"abc123456789",
"file_name":"Test.mp4",
"url":"https://voe.sx/abc123456789",
"url_embed":"https://voe.sx/e/abc123456789"
}
}
GEThttps://voe.sx/api/file/info?key=YOUR_API_KEY&file_code=xxxxxxxxx,yyyyyyyyy
Information about file(s) / mass check. Max 500
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| file_code |
string |
File code(s), comma seperated |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":[
{
"status":200,
"fileCode":"abc123456789",
"name":"test.mp4",
"title":"test.mp4",
"length":6,
"file_size":0
},
{
"status":404,
"fileCode":"def123456789"
}
]
}
GEThttps://voe.sx/api/file/list?key=YOUR_API_KEY&page=1&per_page=20&fld_id=0&created=2018-06-21%2005%3A07%3A10&name=Iron%20man
Information about file(s)
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| page |
integer |
page number |
| per_page |
integer |
number of results per page |
| fld_id |
integer |
folder id |
| created |
datetime |
show only files uploaded after timestamp. Specify number to show only files uploaded X minutes ago. |
| name |
string |
filter file names |
| preview |
bool |
show preview url |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"current_page":1,
"data":[
{
"filecode":"abc123456789",
"name":"Test.mp4",
"title":"Test.mp4",
"uploaded":"2023-03-31 00:00:00",
"size":0,
"file_money":"0.00000"
},
],
"first_page_url":"https://voe.sx/api/file/list?page=1",
"from":1,
"last_page":1,
"last_page_url":"https://voe.sx/api/file/list?page=1",
"links":[
{
"url":null,
"label":"« Previous",
"active":false
},
{
"url":"https://voe.sx/api/file/list?page=1",
"label":"1",
"active":true
},
{
"url":null,
"label":"Next »",
"active":false
}
],
"next_page_url":null,
"path":"https://voe.sx/api/file/list",
"per_page":100,
"prev_page_url":null,
"to":5,
"total":5
}
}
GEThttps://voe.sx/api/file/rename?key=YOUR_API_KEY&file_code=xxxxxxxx&title=sample
Rename file title
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| file_code |
string |
file code(s), or list separated by comma |
| title |
string |
new file title |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":"File has been updated."
}
GEThttps://voe.sx/api/file/set_folder?key=YOUR_API_KEY&file_code=xxxxxx&fld_id=0
Move file(s) to folder
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| file_code |
string |
file code(s), or list separated by comma |
| fld_id |
integer |
folder id |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true
}
GEThttps://voe.sx/api/file/delete?key=YOUR_API_KEY&del_code=xxxxxxxxxx
Delete file(s)
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| del_code |
string |
file code(s), or list separated by comma to delete |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true
}
GEThttps://voe.sx/api/folder/list?key=YOUR_API_KEY&fld_id=0
List folder files
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| fld_id |
integer |
folder id |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"folders":[
{
"fld_id":1,
"name":"Test Folder"
},
],
"files":{
"current_page":1,
"data":[
{
"file_code":"abc123456789",
"file_fld_id":0,
"name":"test.mp4",
"title":"test.mp4",
"views":0,
"uploaded":"2023-03-31 00:00:00",
"length":6,
"file_size":0,
"revenue":"0.00000",
"link":"https://voe.sx/abc123456789",
"link_embed":"https://voe.sx/e/abc123456789"
},
],
"first_page_url":"https://voe.sx/api/folder/list?page=1",
"from":1,
"last_page":1,
"last_page_url":"https://voe.sx/api/folder/list?page=1",
"links":[
{
"url":null,
"label":"« Previous",
"active":false
},
{
"url":"https://voe.sx/api/folder/list?page=1",
"label":"1",
"active":true
},
{
"url":null,
"label":"Next »",
"active":false
}
],
"next_page_url":null,
"path":"https://voe.sx/api/folder/list",
"per_page":100,
"prev_page_url":null,
"to":3,
"total":3
}
}
}
GEThttps://voe.sx/api/folder/create?key=YOUR_API_KEY&parent_id=0
Create new folder
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| parent_id |
integer |
parent folder id, root path = 0 |
| name |
string |
Folder name |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":{
"fld_id":1
}
}
GEThttps://voe.sx/api/folder/rename?key=YOUR_API_KEY&fld_id=0
Rename folder
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| fld_id |
integer |
folder id |
| name |
string |
Folder name |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true
}
GEThttps://voe.sx/api/files/deleted?key=YOUR_API_KEY&last=last&pagination=true
List deleted files
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| last |
integer |
number of last files |
| pagination |
bool |
default value false, if true then a pagination will be used. Otherwise a maximum of 250 file reports will be issued. true will become the standard in the long term and should be used. |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":[
{
"file_code":"abc123456789",
"name":"Test.mp4",
"deleted":"2023-03-31 00:00:00",
"del_time":"2023-03-31 00:00:00",
"deleted_ago_sec":973
},
],
"limit":250
}
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"files":{
"current_page":1,
"data":[
{
"file_code":"abc123456789",
"name":"Test.mp4",
"deleted":"2023-03-31 00:00:00",
"del_time":"2023-03-31 00:00:00",
"deleted_ago_sec":973
},
],
"first_page_url":"https://voe.sx/api/files/deleted?page=1",
"from":1,
"last_page":1,
"last_page_url":"https://voe.sx/api/files/deleted?page=1",
"links":[
{
"url":null,
"label":"« Previous",
"active":false
},
{
"url":"https://voe.sx/api/files/deleted?page=1",
"label":"1",
"active":true
},
{
"url":null,
"label":"Next »",
"active":false
}
],
"next_page_url":null,
"path":"https://voe.sx/api/files/deleted",
"per_page":100,
"prev_page_url":null,
"to":5,
"total":5
}
}
GEThttps://voe.sx/api/dmca/list?key=YOUR_API_KEY&last=last&pending=true&pagination=true
List deleted dmca files
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| last |
integer |
number of last files |
| pending |
bool |
default value false, if true then only reports with future del_time are displayed. |
| pagination |
bool |
default value false, if true then a pagination will be used. Otherwise a maximum of 2500 reports will be issued. true will become the standard in the long term and should be used. |
Example response
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"result":[
{
"file_code":"abc123456789",
"name":"Test.mp4",
"deleted":"2023-03-31 00:00:00",
"del_time":"2023-03-31 00:00:00",
"deleted_ago_sec":973
},
],
"limit":1000
}
{
"server_time":"2023-03-31 00:00:00",
"msg":"OK",
"message":"successful.",
"status":200,
"success":true,
"files":{
"current_page":1,
"data":[
{
"title":"Test.mp4",
"name":"Test.mp4",
"file_code":"abc123456789",
"created":"2023-03-31 00:00:00",
"deleted":"2023-03-31 00:00:00",
},
],
"first_page_url":"https://voe.sx/api/dmca/list?page=1",
"from":1,
"last_page":1,
"last_page_url":"https://voe.sx/api/dmca/list?page=1",
"links":[
{
"url":null,
"label":"« Previous",
"active":false
},
{
"url":"https://voe.sx/api/dmca/list?page=1",
"label":"1",
"active":true
},
{
"url":null,
"label":"Next »",
"active":false
}
],
"next_page_url":null,
"path":"https://voe.sx/api/dmca/list",
"per_page":100,
"prev_page_url":null,
"to":5,
"total":5
}
}
GEThttps://voe.sx/api/settings/domain?key=YOUR_API_KEY
Outputs the current Adblock domain. The entry should be cached (5 minutes) by local caching at the site operator. This feature is only available to webmaster package or partner accounts. This function serves to avoid a redirection via our main domain.
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
Example response
{
"server_time":"2023-03-31 00:00:00",
"domain":"voe.sx",
"url":"https://voe.sx",
"status":200,
"success":true,
}
GEThttps://voe.sx/api/reseller/premium/generate?key=YOUR_API_KEY
Generates one or more Premium Keys. Duration is transmitted in months. Billing takes place afterwards or in advance. The keys have a validity period of 2 years after generation.
Query parameters
| Name |
Type |
Description |
| key |
string |
API key from account settings. |
| days |
integer |
Premium duration, in days. Check the reseller management panel for correct day numbers. |
| amount |
integer |
The number of keys to be generated. |
Example response
{
"server_time":"2024-01-01 00:00:00",
"status":200,
"message":"Purchase completed.",
"keys":[
{
"key":"XXXXX-XXXXX-XXXXX-XXXXX",
"days":5
}
],
"success":true
}