Searching

The IMVDb API allows you to search videos and entities.

Pagination

All searches via the IMVDb API have pagination built in. You can send the following parameters with any search to affect the pagination:

Additionally, each search request returns the following variables:

{
    "total_results": 35,
    "current_page": 1,
    "per_page": 25,
    "total_pages": 2,
    "results": []
}

Searching Videos

To search videos, simply send a UTF-8, URL-encoded to the video search endpoint:

http://imvdb.com/api/v1/search/videos?q=Abba+Mamma+Mia

The search will return the number of total hits,

{
"total": 35,
"current_page": 1,
"per_page": 25,
"total_pages": 2,
"results": [
{
    "id": 938884056168,
    "production_status": "r",
    "song_title": "Mamma Mia",
    "song_slug": "mamma-mia",
    "url": "http://imvdb.dev/video/abba/mamma-mia",
    "multiple_versions": false,
    "version_name": null,
    "version_number": 1,
    "is_imvdb_pick": false,
    "aspect_ratio": null,
    "year": 1975,
    "verified_credits": false,
    "image": {
        "o": "https://s3.amazonaws.com/images.imvdb.com/video/{...}.jpg",
        "l": "https://s3.amazonaws.com/images.imvdb.com/video/{...}.jpg",
        "b": "https://s3.amazonaws.com/images.imvdb.com/video/{...}.jpg",
        "t": "https://s3.amazonaws.com/images.imvdb.com/video/{...}.jpg"
    },
    "artists": [
        {
            "name": "Abba",
            "slug": "abba",
            "url": "http://imvdb.dev/n/abba",
            "discogs_id": 69866
        }
    ]
}]

Searching Entities

To search entities, include a UTF-8, URL-encoded query string to the search entities endpoint:

http://imvdb.com/api/v1/search/entities?q=michel+gondry

{
"total_results": 1,
"current_page": 1,
"per_page": 25,
"total_pages": 1,
"results": [
    {
        "id": 634,
        "name": "Michel Gondry",
        "slug": "michel-gondry",
        "url": "http://imvdb.dev/n/michel-gondry",
        "discogs_id": 347688,
        "byline": "Director",
        "bio": null,
        "image": null,
        "artist_video_count": 0,
        "featured_video_count": 0
    }
]}