Please note: This API has been adapted to match the specification from other services. However there are small differences, be aware of them!
Please note: Make sure to use the API with https only, http requests will result in a HTTP 302 redirect to https.
Status Codes:
200: Everything is OK. Request succeeded
400: Bad request (e.g. wrong parameters)
403: Permission denied (wrong api key or action on a file which doesnt belong to you)
404: File not found
409: Conflict
451: Unavailable For Legal Reasons
Account
My Account functions
Account Info
GET
https://api.videovard.sx/v2/api/account/get?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:30:07",
"status": 200,
"result": {
"email": "myemail@gmail.com",
"balance": "0.00000",
"storage_used" :"24186265",
"storage_left": 128824832615,
}
}
Stats
Views From Date to Date
GET
https://api.videovard.sx/v2/api/stats/get?key=key&last=last
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
last | Number of days | 1 | Number |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:30:07",
"status": 200,
"result": [
{
"downloads": "0",
"views_tor": "1",
"views_adb": "1",
"views_vpn": "1",
"views_paid": "1",
"views": "0",
"day": "2017-09-12",
"profit_total": "0.00000",
}
]
}
Upload
Remote Upload
Check Remote Status
GET
https://api.videovard.sx/v2/api/remote/list?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg":"OK",
"server_time":"2021-02-13 13:46:10",
"status":200,
"result":
{
"queued_urls":0,
"failed_urls":0,
"working_urls":0
},
}
Add URL To Queue
GET
https://api.videovard.sx/v2/api/remote/add?key=key&url=url
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
url | URL to video file | https://site.com/v.mkv | Url |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:29:54",
"status": 200,
"result": {
"filecode": "jthi5jdsu8t9"
}
}
Delete Failed Remote
GET
https://api.videovard.sx/v2/api/remote/delete?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"status": 200,
"msg": "OK",
"server_time": "2021-01-05 16:38:45"
}
Get Upload Server
GET
https://api.videovard.sx/v2/api/upload/server?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:29:54",
"status": 200,
"result": "https://content-videovard-delivery-s01.videovard.to/api/upload/01"
}
Upload to Server
POST
https://content-videovard-delivery-s01.videovard.to/api/upload/01
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
api_key | API key | 1l5ftrilhllgwx2bo | String | |
file | Your selected file | File |
Request
$cf = new CURLFile("FILE-TO-UPLOAD.mp4");
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://content-videovard-delivery-s01.videovard.to/api/upload/01");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, ['api_key' => '1l5ftrilhllgwx2bo', 'file' => $cf]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
Response
200
Headers
Content-Type:application/json
Body
{
"status":"200",
"file_codes":"673odahq891u"
}
if multiple files uploaded
{
"status":"200",
"file_codes":"673odahq891u,bcdeffjk30lk"
}
File
Get info/check file(s)
GET
https://api.videovard.sx/v2/api/file/info?key=key&file_code=file_code
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code, or list separated by comma | gi4o0tlro01u,gi4o0tlro012 | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": [
{
"status": 200,
"filecode": "gi4o0tlro01u",
"name": "4K Time Lapse in the EOS 6D Mark II",
"canplay": 1,
"views_started": "1",
"views": "0",
"length": "20",
"uploaded": "2017-08-10 05:07:17"
},
{
"status": 404,
"filecode": "gi4o0tlro012"
}
]
}
Get files list
GET
https://api.videovard.sx/v2/api/file/list?key=key&page=page&per_page=per_page&fld_id=fld_id&public=public&created=created&title=title
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
page | page number | 2 | Number | |
per_page | number of results per page | 20 | Number | |
fld_id | folder id | 15 | Number | |
public | show public (1) or private (0) files only | 1 | Number | |
created | show only files uploaded after timestamp. Specify number to show only files uploaded X minutes ago. | 2018-06-21 05:07:10 | String | |
title | filter video titles | Iron man | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": [
{
"status": 200,
"filecode": "gi4o0tlro01u",
"name": "4K Time Lapse in the EOS 6D Mark II",
"canplay": 1,
"views_started": "1",
"views": "0",
"length": "20",
"uploaded": "2017-08-10 05:07:17"
},
{
"status": 404,
"filecode": "gi4o0tlro012"
}
]
}
Get recently removed files
GET
https://api.videovard.sx/v2/api/files/deleted?key=key&last=last
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
last | number of files limit | 20 | Number |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg":"OK",
"server_time":"2017-08-11 04:28:53",
"status":200,
"result":
[
{
"file_code":"gtl2mhgw4is7",
"title":"New title",
"deleted":"2017-08-11 20:00:01",
"deleted_ago_sec":"194316"
},
{
"file_code":"uoyagho8c707",
"title":"000-video-sample2s",
"deleted":"2017-08-10 20:30:02"
"deleted_ago_sec":"278915"
}
]
}
File Rename
GET
https://api.videovard.sx/v2/api/file/rename?key=key&file_code=file_code&title=title
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code, or list separated by comma | gi4o0tlro01u,gi4o0tlro012 | String | |
title | new file title | cool video | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": [
{
"status": 200,
"filecode": "gi4o0tlro01u",
"name": "4K Time Lapse in the EOS 6D Mark II",
"canplay": 1,
"views_started": "1",
"views": "0",
"length": "20",
"uploaded": "2017-08-10 05:07:17"
},
{
"status": 404,
"filecode": "gi4o0tlro012"
}
]
}
Clone file
GET
https://api.videovard.sx/v2/api/file/clone?key=key&file_code=file_code
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code | gi4o0tlro01u,gi4o0tlro012 | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": {
"filecode": "gtl2mhgw4is7",
"url": "https://videovard.sx/v/gtl2mhgw4is7"
}
}
Set file(s) folder
GET
https://api.videovard.sx/v2/api/file/set_folder?key=key&file_code=file_code&fld_id=fld_id
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code, or list separated by comma | gi4o0tlro01u,gi4o0tlro012 | String | |
fld_id | folder id | 15 | Number |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200
}
Folder
Get folder/file list
GET
https://api.videovard.sx/v2/api/folder/list?key=key&fld_id=fld_id
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
fld_id | folder id | 1 | Number |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": {
"folders": [
{
"name": "Sub1",
"fld_id": "24"
}
],
"files": [
{
"link": "https://videovard.sx/v/4w0sy8e63f0c",
"uploaded": "2017-07-18 04:06:39",
"file_code": "4w0sy8e63f0c",
"fld_id": "16",
"title": "000 video sample2 s",
"canplay": 0
}
]
}
}
Create new folder
GET
https://api.videovard.sx/v2/api/folder/create?key=key&parent_id=parent_id&name=name
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
parent_id | parent folder id | 1 | Number | |
name | Folder name | New Folder | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": {
"fld_id": "26"
}
}
Rename Folder
GET
https://api.videovard.sx/v2/api/folder/rename?key=key&fld_id=fld_id&name=name
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
fld_id | folder id | 1 | Number | |
name | Folder name | New Folder | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": "true"
}
Images
This function allows to obtain multiple image types for your needs.
Splash 4x4
GET
https://api.videovard.sx/v2/api/image/splash?key=key&file_code=file_code
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code | ol5h2yoeras2 | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"server_time":"2021-02-13 14:42:25",
"msg":"OK",
"status":200
"result":
[
{
"filecode":"ol5h2yoeras2",
"file_name":"The Stand S01E09",
"splash_url":"https://thumbs.videovard.sx/ol5h2yoeras2_splash.jpg"
}
]
}
Single (Poster)
GET
https://api.videovard.sx/v2/api/image/single?key=key&file_code=file_code
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code | ol5h2yoeras2 | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"server_time":"2021-02-13 14:42:25",
"msg":"OK",
"status":200
"result":
[
{
"filecode":"ol5h2yoeras2",
"file_name":"The Stand S01E09",
"splash_url":"https://thumbs.videovard.sx/ol5h2yoeras2.jpg"
}
]
}
Thumbnail
GET
https://api.videovard.sx/v2/api/image/thumb?key=key&file_code=file_code
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
file_code | file code | ol5h2yoeras2 | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"server_time":"2021-02-13 14:42:25",
"msg":"OK",
"status":200
"result":
[
{
"filecode":"ol5h2yoeras2",
"file_name":"The Stand S01E09",
"splash_url":"https://thumbs.videovard.sx/ol5h2yoeras2_t.jpg"
}
]
}
Encoding
Please note: Encoding list operates with four different statuses.
PENDING - Means that your file is pending in queue.
ENCODING - Means that your file is being encoded now.
STUCK - Means that your file have STUCK for unknown reason.
ERROR - Means that we was not able to encode your file.
Show Running Encodings
GET
https://api.videovard.sx/v2/api/encoding/list?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"server_time":"2021-02-13 14:42:25",
"msg":"OK",
"status":200
"result":
[
{
"progress":0,
"status":"ENCODING",
"name":"01x20 - Tiabeanie hace aguas 1080p AC3 6ch (h265) (0,46 G)",
"link":"https://videovard.sx/v/6m2bh98ls4eb"
}
]
}
Restart STUCK Encodings
GET
https://api.videovard.sx/v2/api/encoding/restart?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200
}
Delete Stuck/Failed Encodings
GET
https://api.videovard.sx/v2/api/encoding/delete?key=key
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200
}
DMCA
Get list of files that received DMCA Complaint.
Please note: Files included in this list will be removed within 24 hours.
Please note: del_time provides you exact date & time when file will be removed.
Get files scheduled for DMCA delete
GET
https://api.videovard.sx/v2/api/dmca/list?key=key&last=last
Parameters
Name | Description | Example: | Required | Type |
---|---|---|---|---|
key | API key | 1l5ftrilhllgwx2bo | String | |
last | number of files limit | 20 | Number |
Request
Response
200
Headers
Content-Type:application/json
Body
{
"msg": "OK",
"server_time": "2017-08-11 04:28:53",
"status": 200,
"result": [
{
"file_code": "gtl2mhgw4is7",
"del_time": "2017-08-11 16:31:53"
},
{
"file_code": "uoyagho8c707",
"del_time": "2017-08-11 16:30:23"
}
]
}