bechdeltest.com API documentation

Version 1

Using this API you can query the list. All calls look like:

http://bechdeltest.com/api/v1/method?params

License

The list and ratings are licensed under under Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0). Comments on movies are owned by whoever posted them and are not covered by this license.

Usage

Please keep in mind I'm running this site on a shared hosting plan, so if you send lots of queries in a short time, you might get me in trouble. Please be nice and definitely don't use this data on anything with a lot of traffic.

Errors

Errors generally return a JSON object with some info about the error. This object has three fields, version (currently always "v1"), status (a status code, based on HTTP errors), and description (human readable description of what went wrong).

Current error codes in use, with their description:

403 Movie not yet approved If a movie with the specified id was available but not yet approved.
404 Could not find movie If the imdbid you specified didn't match a movie in the list.
505 Invalid version requested If you use anything other than v1 in the version part of the URL.

Methods

getMovieByImdbId

Params: imdbid (the IMDb ID of the object)

Return value: A JSON object containing information about a movie. Fields returned are:

Name Value
visible Has this movie been approved (currently only approved movies are returned, so this value will always be 1).
date The date this movie was added to the list
submitterid The ID of the submitter. Since submitter information is currently not available through the API, is of no use.
rating The actual score. Number from 0 to 3 (0 means no two women, 1 means no talking, 2 means talking about a man, 3 means it passes the test).
dubious Whether the submitter considered the rating dubious.
imdbid The IMDb id.
id The bechdeltest.com unique id.
title The title of the movie. Any weird characters are HTML encoded (so Brüno is returned as "Brüno").
year The year this movie was released (according to IMDb).

Example (for call to http://bechdeltest.com/api/v1/getMovieByImdbId?imdbid=0367631):

{
    "visible":"1",
    "date":"2009-12-05 05:13:37",
    "submitterid":"270",
    "rating":"3",
    "dubious":"0",
    "imdbid":"0367631",
    "id":"551",
    "title":"D.E.B.S.",
    "year":"2004"
}

getMoviesByTitle

Params: title (the title to search for)

Return value: An array of JSON objects containing information about a movie. See above for description of the fields.

Example (for call to http://bechdeltest.com/api/v1/getMoviesByTitle?title=matrix):

[
    {
        "visible": "1",
        "date": "2008-07-21 00:00:00",
        "submitterid": "1",
        "rating": "3",
        "dubious": "0",
        "imdbid": "0234215",
        "id": "58",
        "title": "Matrix Reloaded, The",
        "year": "2003"
    },
    {
        "visible": "1",
        "date": "2008-07-21 00:00:00",
        "submitterid": "1",
        "rating": "3",
        "dubious": "0",
        "imdbid": "0242653",
        "id": "59",
        "title": "Matrix Revolutions, The",
        "year": "2003"
    },
    {
        "visible": "1",
        "date": "2008-07-20 00:00:00",
        "submitterid": "1",
        "rating": "3",
        "dubious": "0",
        "imdbid": "0133093",
        "id": "36",
        "title": "Matrix, The",
        "year": "1999"
    }
]

getAllMovieIds

Params: none

Return value: An array of JSON objects containing all bechdeltest.com and IMDb IDs. The bechdeltest.com ID can be used to link to the correct page: http://bechdeltest.com/view/id

Example:

[
    {
        "imdbid": "0000417",
        "id": "1252"
    },
    {
        "imdbid": "0000439",
        "id": "1319"
    },
    {
        "imdbid": "0000574",
        "id": "1349"
    }
    [...]
]
    

getAllMovies

Params: none

Return value: An array of JSON objects containing all information on all visible (approved) movies in the list. ID, imdbid, name, year and rating are all available. The bechdeltest.com ID can be used to link to the correct page: http://bechdeltest.com/view/id. Please don't call this method too often, be sure to cache it if you plan on using it.