filmaffinity-API

FilmAffinity-API is a public and non offical API wich allow you to get information about films from FilmAffinity website. You can search films and get their complet information, including cast, synopsis and cover.

This API is written in PHP and uses Slim 4 framework.

Installation

Server prerequisites:

• PHP 8.0 or later.
• Apache's mod_rewrite and mod_headers modules enabled.
• Composer

Install instructions:

• Unzip the API files in an empty folder in your server.
• Make sure that the HTTP shared folder match with the API public folder.
• log folder needs read and write permissions:

user@server:~# chmod 777 -R log

• Run composer to install the project dependencies:

user@server:~# composer install

• Rename config/.env.example to config/.env to activates environment settings.
• Setup API settings in config/.env file.

API Public methods

The API has the following public methods:

• Search films.
• Advanced search films.
• Get film information.
• Get genres.
• Get countries.

Method name	API endpoint	HTTP method	Input
Search films	search/simple	POST	Simple Search JSON
Advanced search films	search/advanced	POST	Advanced Search JSON
Get film	films/:id	GET	URL parameter (:id)
Get genres	genres	GET	-
Get countries	countries	GET	-

Basic usage

Simple search

http://<server_domain_api>/search/simple

INPUT

{"text": "pulp fiction"}

OUTPUT

{
  "status": "OK",
  "statusCode": 200,
  "response": {
    "total": 2,
    "results": [
      {
        "id": 160882,
        "title": "Pulp Fiction (1994)"
      },
      {
        "id": 991349,
        "title": "8 Bit Cinema: Pulp Fiction (C) (2014)"
      }
    ]
  }
}

Advanced search

http://<server_domain_api>/search/advanced

INPUT

{
  "text": "pulp fiction",
  "year_from": 1992,
  "year_to": 2000
}

OUTPUT

{
  "status": "OK",
  "statusCode": 200,
  "response": {
    "total": 1,
    "results": [
      {
        "id": 160882,
        "title": "Pulp Fiction (1994)"
      }
    ]
  }
}

Get film information

http://<server_domain_api>/films/160882

OUTPUT

{
  "status": "OK",
  "statusCode": 200,
  "response": {
    "filmAfinityId": "160882",
    "title": "Pulp Fiction",
    "originalTitle": "Pulp Fiction",
    "year": "1994",
    "duration": "153",
    "coverUrl": "https://pics.filmaffinity.com/pulp_fiction-210382116-large.jpg",
    "coverFile": "pulp_fiction-210382116-large.jpg",
    "rating": "8,6",
    "country": "Estados Unidos",
    "directors": ["Quentin Tarantino"],
    "screenplay": "Quentin Tarantino, Roger Avary",
    "soundtrack": "Varios",
    "photography": "Andrzej Sekula",
    "cast": ["John Travolta", "Samuel L. Jackson", "Uma Thurman", "Bruce Willis", "Ving Rhames", "Harvey Keitel", "Tim Roth", "Amanda Plummer", "María de Medeiros", "Eric Stoltz", "Rosanna Arquette", "Christopher Walken", "Paul Calderon", "Bronagh Gallagher", "Peter Greene", "Stephen Hibbert", "Angela Jones", "Phil LaMarr", "Robert Ruth", "Julia Sweeney", "Quentin Tarantino", "Frank Whaley", "Duane Whitaker", "Steve Buscemi", "Burr Steers"],
    "producer": "Miramax, Band Apart, Jersey Films. Lawrence Bender",
    "genres": ["Thriller", "Crimen", "Historias cruzadas", "Película de culto", "Comedia negra"],
    "synopsis": "Jules y Vincent, dos asesinos a sueldo con no demasiadas luces, trabajan para el gángster Marsellus Wallace. Vincent le confiesa a Jules que Marsellus le ha pedido que cuide de Mia, su atractiva mujer. Jules le recomienda prudencia porque es muy peligroso sobrepasarse con la novia del jefe. Cuando llega la hora de trabajar, ambos deben ponerse \"manos a la obra\". Su misión: recuperar un misterioso maletín."
  }
}

Get genres

http://<server_domain_api>/genres

OUTPUT

{
  "status": "OK",
  "statusCode": 200,
  "response": [
    {
      "code": "AC",
      "description": "Acción"
    },
    {
      "code": "AN",
      "description": "Animación"
    },
    {
      "code": "AV",
      "description": "Aventuras"
    },
    {
      "code": "BE",
      "description": "Bélico"
    }
  ]
}

Get countries

http://<server_domain_api>/countries

OUTPUT

{
  "status": "OK",
  "statusCode": 200,
  "response": [
    {
      "code": "AF",
      "name": "Afganistán"
    },
    {
      "code": "AL",
      "name": "Albania"
    },
    {
      "code": "DE",
      "name": "Alemania"
    },
    {
      "code": "FD",
      "name": "Alemania del Este (RDA)"
    }
  ]
}

You must inform the country/genre code in the body request of advances search if you want use these filters.