Created Movie Lookup (markdown)

2024-10-03 22:57:18 +02:00 · 2018-05-26 15:38:44 +08:00 · 2018-05-26 15:38:44 +08:00 · 1945a80cf1
commit 1945a80cf1
parent 3c2c2cf4d5
1 changed files with 83 additions and 0 deletions
--- a/Movie-Lookup.md
+++ b/Movie-Lookup.md
@ -0,0 +1,83 @@
+## GET ##
+
+##### Summary #####
+Searches for new movies on trakt
+
+##### Search by term ######
+**Endpoint: "/movie/lookup"**
+
+Required:
+`term` = Either the Movie's Name, using `%20` to signify spaces, as in `term=Star%20Wars`
+
+##### Search by The Movie Database ID ######
+**Endpoint: "/movie/lookup/tmdb"**
+
+Required:
+`tmdbId` =  `tmdbId=348350`
+
+##### Search using IMDB id ######
+**Endpoint: "/movie/lookup/imdb"**
+
+Required:
+`imdbId` =  `tmdbId=tt3778644`
+
+#### Full Breakdown: ####
+
+```
+curl --request GET "localhost:8989/api/movie/lookup?term=star%20wars&apikey=YOURAPIKEY"
+```
+  
+-- or --
+
+```
+curl --request GET "localhost:8989/api/movie/lookup/tmdb?tmdbId=348350&apikey=YOURAPIKEY"
+```
+-- or --
+
+```
+curl --request GET "localhost:8989/api/movie/lookup/imdb?imdbId=tt3778644&apikey=YOURAPIKEY"
+```
+##### Returns Array ######
+
+```JSON
+[
+    {
+    "title": "Star Wars",
+    "alternativeTitles": [],
+    "secondaryYearSourceId": 0,
+    "sortTitle": "star wars",
+    "sizeOnDisk": 0,
+    "status": "released",
+    "overview": "Princess Leia is captured and held hostage by the evil Imperial forces in their effort to take over the galactic Empire. Venturesome Luke Skywalker and dashing captain Han Solo team together with the loveable robot duo R2-D2 and C-3PO to rescue the beautiful princess and restore peace and justice in the Empire.",
+    "inCinemas": "1977-05-25T00:00:00Z",
+    "images": [
+      {
+        "coverType": "poster",
+        "url": "http://image.tmdb.org/t/p/original/btTdmkgIvOi0FFip1sPuZI2oQG6.jpg"
+      }
+    ],
+    "downloaded": false,
+    "remotePoster": "http://image.tmdb.org/t/p/original/btTdmkgIvOi0FFip1sPuZI2oQG6.jpg",
+    "year": 1977,
+    "hasFile": false,
+    "profileId": 0,
+    "pathState": "dynamic",
+    "monitored": false,
+    "minimumAvailability": "tba",
+    "isAvailable": true,
+    "folderName": "",
+    "runtime": 0,
+    "tmdbId": 11,
+    "titleSlug": "star-wars-11",
+    "genres": [],
+    "tags": [],
+    "added": "0001-01-01T00:00:00Z",
+    "ratings": {
+      "votes": 8854,
+      "value": 8.1
+    },
+    "qualityProfileId": 0
+  },
+...
+]
+```