Developers

# Collections endpoints

Collections are curated lists of videos that are constantly updated by our editorial team as new free stock videos are added to our videos library.

# List collections

This endpoint will return a paginated list of all collections in the system, which will enable users to explore the library (rather than searching).

GET /collections

# Parameters

Param Description
page Page number. Number. Default: 0
page_size Number of videos per page. Number. Default: 20

# Response

{
  "page": 0,
  "pages": 1,
  "page_size": 20,
  "total": 7,
  "hits": [
    {
      "id": "kJibI2VztM",
      "title": "Paris Is For Lovers",
      "slug": "paris-is-for-lovers",
      "description": "Paris is always a good idea. The picturesque City of Lights can feel like a dream as it bursts with old world charm. Take a stroll along the Seine, stop for a flaky croissant, and spot the Eiffel Tower far off in the distance. ",
      "cover_video": "xj9ZIsytBA",
      "tags": [
        "paris",
        "paris cafe",
        "love"
      ],
      "videos": [
        "ypWCoOJp3g",
        "YrKN1E6hBJ",
        "uksv1hYaNq",
        "jXsV4e60Sc"
      ],
      "published": false,
      "meta_title": "Free Paris is for lovers Stock Video Footage - Royalty Free Video Download | Coverr",
      "meta_description": "Beautiful Paris is for lovers stock video footage for use on your website or any project (personal or commercial). Find high quality royalty free Paris is for lovers videos on Coverr | Coverr\n",
      "cover_image": "https://storage.coverr.co/t/02nCOQJbsWWluISAnlGtvelIKFD01XnLDf"
    }
  ]
}

# Get a collection

Once you have a collection you're interested in, you can fetch its details by accessing this endpoint using the collection id as key:

GET /collections/:id

# Parameters

Param Description
id Collection's id

# Response

{
  "id": "kJibI2VztM",
  "title": "Paris Is For Lovers",
  "slug": "paris-is-for-lovers",
  "description": "Paris is always a good idea. The picturesque City of Lights can feel like a dream as it bursts with old world charm. Take a stroll along the Seine, stop for a flaky croissant, and spot the Eiffel Tower far off in the distance. ",
  "cover_video": "xj9ZIsytBA",
  "tags": [
    "paris",
    "paris cafe",
    "love"
  ],
  "videos": [
    "ypWCoOJp3g",
    "YrKN1E6hBJ",
    "uksv1hYaNq",
    "jXsV4e60Sc"
  ],
  "published": false,
  "meta_title": "Free Paris is for lovers Stock Video Footage - Royalty Free Video Download | Coverr",
  "meta_description": "Beautiful Paris is for lovers stock video footage for use on your website or any project (personal or commercial). Find high quality royalty free Paris is for lovers videos on Coverr | Coverr\n",
  "cover_image": "https://storage.coverr.co/t/02nCOQJbsWWluISAnlGtvelIKFD01XnLDf"
}

# Get videos in a collection

In order to list all videos in a specific collection, just query this endpoint:

GET /collections/:id/videos

# Parameters

Param Description
page Page number. Number. Default: 1
page_size Number of videos per page. Number. Default: 20
query Search videos by query. String. Default: '', see a note below
sort_by How to sort videos. String. Valid values: date, popularity. Default: popularity
urls Add urls property in the response. Boolean. Default: false

# Response

{
  "page": 0,
  "pages": 50,
  "page_size": 20,
  "total": 3602,
  "hits": [
    {
      "id": "S1YbPl1NfI",
      "created_at": "2020-11-12T08:55:42.710Z",
      "updated_at": "2020-11-12T08:55:42.710Z",
      "title": "Cutting Wood Building Material With a Circular Electric Saw",
      "poster": "https://storage.coverr.co/p/QatsCWWAorI71sZ33DkHZREGWruZCHsg",
      "thumbnail": "https://storage.coverr.co/t/QatsCWWAorI71sZ33DkHZREGWruZCHsg",
      "description": "A close-up of the circular miter saw lowers and cuts off material",
      "is_vertical": false,
      "tags": [
        "circular saw",
        "miter saw",
        "saw"
      ],
      "downloads": 4,
      "views": 1,
      "published_at": "2020-11-15T09:27:18.578Z",
      "aspect_ratio": "16:9",
      "duration": 11.625,
      "max_height": 1152,
      "max_width": 2048,
      "urls": {
        "mp4": "https://storage.coverr.co/videos/QatsCWWAorI71sZ33DkHZREGWruZCHsg?token={token}",
        "mp4_preview": "https://storage.coverr.co/videos/QatsCWWAorI71sZ33DkHZREGWruZCHsg/preview?token={token}",
        "mp4_download": "https://storage.coverr.co/videos/QatsCWWAorI71sZ33DkHZREGWruZCHsg/download?token={token}&filename=Cutting Wood Building Material With a Circular Electric Saw"
      }
    }
  ]
}

← Categories →