Welcome to the movies-api
repository! This open-source project provides a comprehensive API (both GraphQL and RESTful) for accessing a wide range of movie data. Whether you're looking for a specific title or exploring different genres, our API makes it easy to access the information you need.
- GraphQL & RESTful API: Two ways to interact with our movie database.
- Bearer Token Authorization: Secure access to our API endpoints.
- Extensive Movie Data: Access a wide range of movie information.
The base URL for our API is https://0kadddxyh3.execute-api.us-east-1.amazonaws.com
. All endpoints are prefixed with this base URL.
To use our API, first, obtain a bearer token:
- Send a
GET
request to/auth/token
. - Use this token in the Authorization header of your subsequent API calls.
- Open the GraphQL sandbox endpoint and click on the connection settings
- Update the headers by adding the
Authorization
bearer token
Here's a list of our available API endpoints:
GET /auth/token
: Fetch a valid token to be used in the queries belowGET /healthcheck
: Check status of the appGET /genres/movies
: Fetch a list of all movie IDs grouped by genre- Query Parameters:
page
: the page number to be fetched, starting at page 1 (default = 1)limit
: the number of items per page (default = 25)
- Query Parameters:
GET /movies
: Fetch a list of all movies- Query Parameters:
page
: the page number to be fetched, starting at page 1 (default = 1)limit
: the number of items per page (default = 25)search
: searches for a movie title (simple string match in the whole title string)genre
: searches for a movie genre (exact match)
- Query Parameters:
GET /movies/{id}
: Fetch details of a specific movieGET /movies/titles
: Fetch a list of all movie IDs and titles- Query Parameters:
page
: the page number to be fetched, starting at page 1 (default = 1)limit
: the number of items per page (default = 25)
- Query Parameters:
GET /movies/genres/{id}
: Fetch stats details of a movie genre
GraphQL queries can be accessed using the endpoint /graphql
. Open the sandbox at /graphql
and take a look at the query schema documentation.
This project is licensed under the MIT license.