Streamio API Documentation

Videos - List

Returns a list of videos from your account filtered and sorted on the parameters your specify.

Request

Url

https://streamio.com/api/v1/videos.format

Request Method

GET

Parameters

• tags Return videos including any of the given (comma separated) tags. https://streamio.com/api/v1/videos.json?tags=awesome%2Cfunny
• tags.in Same as tags (in is short for include). https://streamio.com/api/v1/videos.json?tags.in=awesome%2Cfunny
• tags.all Returns videos including all given tags. https://streamio.com/api/v1/videos.json?tags.all=awesome%2Cfunny
• tags.nin Returns videos not including given tags. https://streamio.com/api/v1/videos.json?tags.nin=awesome%2Cfunny
• skip Skips the given number of results (useful for pagination). https://streamio.com/api/v1/videos.json?skip=5
• limit Limits the number of results to the given number (default is 20, max is 100). https://streamio.com/api/v1/videos.json?limit=1
• order Specifies the attribute on which the results should be ordered (default is created_at descending). You can specify if the ordering should be ascending or descending by adding .asc or .desc to the attribute name. https://streamio.com/api/v1/videos.json?order=created_at.asc

Response

Code

200

Body

Examples

Query on tags

Find videos tagged with "sports" or "nature" with the tags parameter.

curl -u username:password https://streamio.com/api/v1/videos.json?tags=sports%2Cnature

Find videos tagged with both "sports" and "england" with the tags.all parameter.

curl -u username:password https://streamio.com/api/v1/videos.json?tags.all=sports%2Cengland

Pagination

You can achieve pagination (split results into multiple pages) by using the skip and limit parameters.

Set the limit to 10 to receive only 10 results per request. Set skip to 0 for the first page as we want to start from the top of the result list.

curl -u username:password https://streamio.com/api/v1/videos.json?limit=10&skip=0

Now for the second page we keep the limit at 10 and set skip to 10 to get results 11-20.

curl -u username:password https://streamio.com/api/v1/videos.json?limit=10&skip=10

To get the total count for calculating the total number of pages you may use the count method.

Top 5 videos

Say we want to display a list of the 5 most popular videos. We set the order parameter to plays descending (plays.desc) and limit to 5.

curl -u username:password https://streamio.com/api/v1/videos.json?limit=5&order=plays.desc