Introduction

Streamlare exposes its data via an Application Programming Interface (API), so developers can interact programmatically with the Streamlare service. Our API has been adapted to match the specification of other services. However, there are slight differences.

The Base-URL for all API calls:
https://api.streamlare.com/api

All requests to the API shall be HTTP GET or POST; most calls require login & key, which can be found on your account settings.

Response format
{"status":"string | `success` or `error`","message":"string | `informational message. might vary, use the status in your code`","result":"array or object or string | `result of the request`"}

Get File

Get the file information

Request:
https://api.streamlare.com/api/file/get/{hashid}?login={login}&key={key}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
hashid File HashID WeLMEmnAjkDgPvqK yes
Response:
{"status":"success","message":"OK","result":{"hashid":"WeLMEmnAjkDgPvqK","name":"cringy_E-Girl.mp4","size":4073402,"views":0,"poster":"vjqnpawk08o17x8rtt9w.jpg","status":"converted","created_at":"2021-09-17T20:23:29.000000Z"}}

Get Files

Get the list information of your files

Request:
https://api.streamlare.com/api/file/get?login={login}&key={key}&folder={folder}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
folder Folder ID 1 no
status Get by status onqueue, transferring, processing, converting, converted, failed no
Response:
{"status":"success","message":"OK","result":[{"hashid":"WeLMEmnAjkDgPvqK","name":"cringy_E-Girl.mp4","size":4073402,"views":0,"status":"converted","created_at":"2021-07-07T18:34:33.000000Z"},{"hashid":"aXAQ9qzxEPl4mMEO","name":"eBWwyJnL9eDMbPaN","size":4073402,"views":0,"status":"converted","created_at":"2021-07-07T18:33:44.000000Z"},{"hashid":"NVGm80z55Kzr1xW3","name":"cringy_E-Girl_2.mp4 - Copy","size":4073402,"views":0,"status":"converted","created_at":"2021-07-07T18:33:02.000000Z"},{"hashid":"eBWwyJnL9eDMbPaN","name":"cringy_E-Girl_2.mp4","size":4073402,"views":8,"status":"converted","created_at":"2021-07-07T17:11:42.000000Z"}]}

Upload File

Upload a video file. Before uploading a file. You need to generate an upload URL. And that returned URL should be requested with POST and must be multipart/form-data

Request:
https://api.streamlare.com/api/file/upload/generate?login={login}&key={key}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
Response:
{"status":"success","message":"OK","result":"https:\/\/api.streamlare.com\/api\/file\/upload\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPaDLUXdNNtiyZwCpSxaltdL"}

After you generated a new upload URL. You can use that result to upload your file.

Here's an example curl command:

curl -k -F file=@/path/to/sample.mp4 -F login={login} -F key={key} -F folder={folder} https://api.streamlare.com/api/file/upload/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPaDLUXdNNtiyZwCpSxaltdL
Response:
{"status":"success","message":"OK","result":{"hashid":"9mOEbPDayyD3M1kN","folder":null,"name":"Streamlare_4.mp4","ext":"mp4","mimeType":"video\/mp4","size":4073348,"status":"converting","uploaded_at":"2021-07-09T21:32:11.000000Z"}}

Copy File

Copy/clone your file. Note: Only works if you own the video you are trying to copy.

Request:
https://api.streamlare.com/api/file/copy?login={login}&key={key}&file[]={file}&folder={folder}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
file File's hashid. string or array 9mOEbPDayyD3M1kN yes
folder Folder ID 1 no
Response:
{"status":"success","message":"OK","result":{"9mOEbPDayyD3M1kN":{"hashid":"Z4j57gDmPWn26Xbp","folder":null,"name":"cringy_E-Girl.mp4 - Copy","ext":"mp4","mimeType":"video\/mp4","size":4073402,"status":"converted","uploaded_at":"2021-07-09T21:48:32.000000Z"}}}

Move File

Move your file. Note: Only works if you own the video you are trying to move.

Request:
https://api.streamlare.com/api/file/move?login={login}&key={key}&file[]={file}&folder={folder}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
file File's hashid. string or array 9mOEbPDayyD3M1kN yes
folder Folder ID 1 yes
Response:
{"status":"success","message":"OK"}

Delete File

Delete your file. Note: Only works if you own the video you are trying to delete.

Request:
https://api.streamlare.com/api/file/delete?login={login}&key={key}&file[]={file}&folder={folder}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
file File's hashid. string or array 9mOEbPDayyD3M1kN yes
Response:
{"status":"success","message":"OK"}

Rename File

Copy/clone your file. Note: Only works if you own the video you are trying to copy.

Request:
https://api.streamlare.com/api/file/rename?login={login}&key={key}&file[]={file}&name={name}&replace={replace}&replaceWith={replaceWith}&append={append}&prepend={prepend}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
file File's hashid. string or array 9mOEbPDayyD3M1kN yes
name New file name sample.mp4 yes
replace Replace the text .mkv no
replaceWith Replace it with .mp4 no
append Append file name [Personal] no
prepend Prepend file name .mp4 no
Response:
{"status":"success","message":"OK"}

Get File Poster

Get the poster URL of the file

Request:
https://api.streamlare.com/api/file/poster/get?login={login}&key={key}&file={file}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
file File's hashid 9mOEbPDayyD3M1kN yes
Response:
{"status":"success","message":"OK","result":"https:\/\/cdn.streamlare.com\/72lvrxgmgaswa82q0pwy1o5y7ze64jvdw8mne4.jpg"}

Replace File Poster

Replace the current poster of the video file. Note: The request must be POST & it's content-type is multipart/form-data

Request:
https://api.streamlare.com/api/file/poster/replace
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
fileId File hashid 9mOEbPDayyD3M1kN yes
file Image binary (binary) yes
Response:
{"status":"success","message":"OK"}

Get File Subtitles

Get video file subtitles

Request:
https://api.streamlare.com/api/subtitle/get?login={login}&key={key}&file={file}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
file File's hashid. 9mOEbPDayyD3M1kN yes
Response:
{"status":"success","message":"OK","result":[{"hashid":"zqrm02yqw435d7kylm1peoxg96zvnlje","name":"English","lang":"en"}]}

Upload File Subtitle

Upload a new subtitle. Note: The request must be POST & it's content-type is multipart/form-data

Request:
https://api.streamlare.com/api/subtitle/upload
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
fileId File hashid 9mOEbPDayyD3M1kN yes
file Subtitle text binary (binary) yes
name Caption name English yes
lang Language en yes
Response:
{"status":"success","message":"OK","result":{"info":{"name":"English","lang":"en","uploaded_at":"2021-07-10T00:28:44.000000Z","hashid":"zqrm02yqw435d7kylm1peoxg96zvnlje"},"url":"https:\/\/cdn.streamlare.com\/zqrm02yqw435d7kylm1peoxg96zvnlje"}}

Delete File Subtitle

Delete a subtitle

Request:
https://api.streamlare.com/api/subtitle/delete?login={login}&key={key}&id={id}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
id Subtitle Hashid zqrm02yqw435d7kylm1peoxg96zvnlje yes
Response:
{"status":"success","message":"OK"}

Get Folders

Get list of folders

Request:
https://api.streamlare.com/api/folder/get?login={login}&key={key}&parent={parent}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
parent Folder's parent ID 1 no
Response:
{"status":"success","message":"OK","result":[{"id":1,"parent_id":null,"name":"My Videos","created_at":"2021-05-22T14:38:01.000000Z","folder":[]}]}

Create Folder

Create a new folder

Request:
https://api.streamlare.com/api/folder/create?login={login}&key={key}&name={name}&parent={parent}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
name New folder name My Videos yes
parent Folder's parent ID 1 no
Response:
{"status":"success","message":"OK","result":{"id":1,"name":"My Videos","parent_id":null,"created_at":"2021-07-09T23:47:10.000000Z"}}

Rename Folder

Rename a folder

Request:
https://api.streamlare.com/api/folder/rename?login={login}&key={key}&folder={folder}&name={name}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
folder Folder ID 1 yes
name New folder name My Videos The 2nd yes
Response:
{"status":"success","message":"OK"}

Delete Folder

Delete a folder

Request:
https://api.streamlare.com/api/folder/delete?login={login}&key={key}&folder={folder}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
folder Folder ID 1 yes
Response:
{"status":"success","message":"OK"}

Move Folder

Move a folder

Request:
https://api.streamlare.com/api/folder/move?login={login}&key={key}&folderFrom={folderFrom}&folderTo={folderTo}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
folderFrom Folder ID 1 yes
folderTo Folder ID 2 no
Response:
{"status":"success","message":"OK"}

Get Remotes

Get remote uploads

Request:
https://api.streamlare.com/api/remote/get?login={login}&key={key}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
Response:
{"status":"success","message":"OK","result":[{"id":21,"url":"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ","name":"watch?v=dQw4w9WgXcQ","data":{"fileId":null,"percentage":0,"size":0},"status":"pending","created_at":"2021-07-10T00:08:35.000000Z","updated_at":"2021-07-10T00:08:35.000000Z"}]}

Check Remote Status

Get remote status

Request:
https://api.streamlare.com/api/remote/status?login={login}&key={key}&id={id}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
id Remote ID 1 yes
Response:
{"status":"success","message":"OK","result":{"id":16,"url":"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ","name":"watch?v=dQw4w9WgXcQ","data":{"fileId":"JQpadWzjMD9NyAbx","percentage":100,"size":3229614.08},"status":"downloaded","created_at":"2021-06-08T21:49:37.000000Z","updated_at":"2021-06-08T21:49:43.000000Z"}}

Add Remote

Add a new remote upload. Before adding a new remote URL, you must generate a new remote upload URL. A total of 10 remote upload URL will be generated.

Request:
https://api.streamlare.com/api/remote/generate?login={login}&key={key}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
Response:
{"status":"success","message":"OK","result":["https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ","https:\/\/api.streamlare.com\/api\/remote\/add\/UtQVAoeCV6A9A5ySlchc76zTuLUlby0fSLtYSg-MoPbNLTC2yFVkeUvzAllM-rvJ"]}

And then you can finally add your URL you wanted to be remoted. Here's the list of parameters you needed:

Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
url Remote URL https://www.youtube.com/watch?v=dQw4w9WgXcQ yes
name File name My video.mp4 yes
folder Folder ID 1 no
Response:
{"status":"success","message":"OK","result":{"id":23,"url":"https:\/\/www.youtube.com\/watch?v=dQw4w9WgXcQ","name":"My video.mp4"}}

Cancel Remote

Cancel a remote

Request:
https://api.streamlare.com/api/remote/cancel?login={login}&key={key}&id={id}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
id Remote ID 12 yes
Response:
{"status":"success","message":"OK"}

Dynamic Subtitles

You can add dynamically subtitles via URL parameters.

Request:
https://streamlare.com/e/9mOEbPDayyD3M1kN?c1_label=English&c1_file=http://yoursubtitle.com/file.vtt
Parameters:
Name Description Example Required
c%_file You can add multiple subtitles by it's id. Replace '%' by your subtitle id. c1_file=https://yoursubtitle.com/file.vtt c2_file=https://yoursubtitle.com/file.vtt no
c%_label Label of your subtitle c1_label=English
c2_file=Spanish 		no

Dynamic Poster

You can change dynamically your poster via URL parameters.

Request:
https://streamlare.com/e/9mOEbPDayyD3M1kN?poster=http://yourposter.com/image.png
Parameters:
Name Description Example Required
poster URL of your poster. http://yourposter.com/image.png no

Specific Time

You can link to a specific part of your video.

Request:
https://streamlare.com/e/9mOEbPDayyD3M1kN?t=120
Parameters:
Name Description Example Required
t Time in seconds 3600 no

Get Streams URL

Get direct URL of streams file. Make sure you have enough available premium bandwidth. Check our premium plans

Request:
https://api.streamlare.com/api/premium/stream/get?login={login}&key={key}&id={id}&ip={ip}
Parameters:
Name Description Example Required
login API Login Fkfz4MGZs3V8aSzq3f50sjRFcpJU9FDb yes
key API Key IUPMWsMjrAHzdjTBoRyHCdeZ4F0mVI7d yes
id File hashid JQpadWzjMD9NyAbx yes
ip IP address of your client 127.0.0.1 yes
agent User-agent of your client Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 yes
Response:
{"status":"success","message":"OK","result":{"Original":{"label":"Original","stream":"https:\/\/cdn1.streamlarevideo.com\/EU8ovt4duC3AhWInk3_ezA\/1631945139\/eTG8JWIijSCean-mCqUbMNho8Rj6DFBTS_J54hBklGWUySDs0-ABPoRtBLXTMGdFq7uzp1Fw5ydywT8lvwP5t1zEY9NzwVyxzcCSqk8N8VynnU-1CUaAxypYoM0GNR4dws1iF9I_yp2mMmGzCrejTCxvyHQfD7CTbvZtO_ETvHkuZ2cS9hTw_822rCB0I5QwVXMfzFUt6qNoYeIwq81cYToXrqnzG1X7PCxw1UtPLgzc62t1VSvUnaeHCpKaDmBx\/2021-08-21+00-53-35.mkv.mp4","download":"https:\/\/cdn1.streamlarevideo.com\/EU8ovt4duC3AhWInk3_ezA\/1631945139\/eTG8JWIijSCean-mCqUbMNho8Rj6DFBTS_J54hBklGWUySDs0-ABPoRtBLXTMGdFq7uzp1Fw5ydywT8lvwP5t1zEY9NzwVyxzcCSqk8N8VynnU-1CUaAxypYoM0GNR4dws1iF9I_yp2mMmGzCrejTCxvyHQfD7CTbvZtO_ETvHkuZ2cS9hTw_822rCB0I5QwVXMfzFUt6qNoYeIwq81cYToXrqnzG1X7PCxw1UtPLgzc62t1VSvUnaeHCpKaDmBx\/2021-08-21+00-53-35.mkv.mp4?dl=1","expires_at":"2021-09-18T06:05:39.663033Z"}}}