Summary

This API call returns a list of the user's active videos along with it's relevant metadata. 20 videos are returned by default but this is customisable.

Endpoint

 /api/{username}/videos.xml

Formats

  • XML
  • JSON

Arguments

  • username is the vzaar login name for the user. Note: This must be the actual username and not the email address

Parameters

  • count, integer - Specifies the number of videos to retrieve per page. Default is 20. Maximum is 100
  • page, integer - Specifies the page number to retrieve. Default is 1
  • sort, string - Values can be asc (least_recent) or desc (most_recent). Defaults to desc
  • status, string - Values can be processing, active, replaced, deleted and failed
  • title, string - Return only videos with title containing given string
  • labels, string - Return only videos including given label(s) (labels must be comma separated e.g "foo, bar")

HTTP Methods

  • GET

Authentication

Response

<?xml version="1.0" encoding="UTF-8"?>
  <videos type="array">
  <video>
  <version>integer</version>
  <id>integer</id>
  <title>string</title>
  <description>string</description>
  <created_at>dateTime</created_at>
  <url>url</url>
  <thumbnail>url</thumbnail>
  <play_count>integer</play_count>
  <user>
  <author_name>string</author_name>
  <author_url>url</author_url>
  <author_account>string</author_account>
  <video_count>integer</video_count>
  </user>
  </video>
  </videos>

Description

  • version - This is the vzaar API version number. The current version is 1.0
  • id - This is the video ID number
  • title - This is the video title. It may be null.
  • description - This is the video description. It may be null.
  • created_at - This is the date time the video was uploaded. Will be in UTC format
  • url - This is a link to the video page
  • thumbnail_url - This will be a URL link that points to the video thumbnail. This is usually 120x90px
  • play_count - This will be the number of times the video has been played
  • author_name - This is the vzaar user name (i.e. their login)
  • author_url - This is a link to the vzaar user summary page
  • author_account - This is a number representing the users vzaar account. 1 represents a free account
  • video_count - This is the numbers of active video in the users account
  • duration - The duration of the video in seconds
  • width - The width of the video
  • height - The height of the video

Example

Call: http://vzaar.com/api/vzaar/videos.xml?title=vzaar

Response

<?xml version="1.0" encoding="UTF-8"?>
  <videos type="array">
  <video>
  <version>1.0</version>
  <id>21791</id>
  <title>vzaar upload demo</title>
  <created_at>2009-03-20T08:20:14+00:00</created_at>
  <url>http://vzaar.com/videos/21791</url>
  <thumbnail_url>http://vzaar.com/videos/21791.thumb</thumbnail_url>
  <play_count>4</play_count>
  <user>
  <author_name>video</author_name>
  <author_url>http://vzaar.com/users/video</author_url>
  <author_account>1</author_account>
  <video_count>1</video_count>
  </user>
  <duration>12.9</duration>
  </video>
  <video>
  <version>1.0</version>
  <id>19926</id>
  <title>vzaar-video advert</title>
  <created_at>2009-02-16T17:00:26+00:00</created_at>
  <url>http://vzaar.com/videos/19926</url>
  <thumbnail_url>http://vzaar.com/videos/19926.thumb</thumbnail_url>
  <play_count>6</play_count>
  <user>
  <author_name>ianjsnead</author_name>
  <author_url>http://vzaar.com/users/ianjsnead</author_url>
  <author_account>1</author_account>
  <video_count>15</video_count>
  </user>
  <duration>12.72</duration>
  </video>
  </videos>


contact us   by phone, mail or twitter...
libraries
ruby java php .net node
affiliates
affiliate program


Powered by Olark