Documentation

Introduction

The api is made for making requests for the database. For this perticular functionality movie information is provided as an output.

How to start?

To access and start working with the api following steps should be taken.

• Register an account. Register now. If you are already registered with the website click here and login
• Login with an account. click here
• Go to this page. click here click Generate a key.
• The key is valid for 10 days and only 50 requests can be made.

How to use API

Api is accessed using GET method.

api link: api/rest/?key=12345&type=request&user_id=123

• key is a 12 character long random key which is a unique one. You can get one by going to this link.click here
• Type
  • Info outputs the number of requests made and remaining requests.
    • api/rest/?key=12345&type=info
    • You will see like 10/50. The first number is requests made till date. The second number is total allowed requests.
  • Request
    • api/rest/?key=12345&type=request&searchBy=title&title=home
    • searchBy term can be used to search by either title, actor or year. Once you enter searchBy term enter the term value like above.
      Examples
      • api/rest/?key=12345&type=request&searchBy=title&title=home
      • api/rest/?key=12345&type=request&searchBy=actor&actor=Daniel Stern
      • api/rest/?key=12345&type=request&searchBy=year&year=2020
  • User ID
    • is your personal user id which you can see by click here.
    • Or by using login and then going to profile page at click here

Request output format

The request output will be in json format.

• Following is an info type example

  



• Following is an request type example

  

Sample code

• web address /api/rest?key=Your Key&type=info&user_id=Your user id
• web address /api/rest?key=Your Key&type=request&user_id=Your user id

Max limit is 10 results per request