{"id":25541243,"url":"https://github.com/shin202/flixhq-core","last_synced_at":"2025-04-11T17:02:08.334Z","repository":{"id":65688660,"uuid":"594307268","full_name":"shin202/flixhq-core","owner":"shin202","description":"Nodejs library that provides an Api for obtaining the movies information from FlixHQ website.","archived":false,"fork":false,"pushed_at":"2024-02-20T08:56:18.000Z","size":139,"stargazers_count":26,"open_issues_count":8,"forks_count":15,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-22T10:37:17.606Z","etag":null,"topics":["api","apis","core","crawler","library","movies","movies-api","node-js","nodejs","scraper","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/flixhq-core","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shin202.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-28T05:52:59.000Z","updated_at":"2025-02-07T15:05:59.000Z","dependencies_parsed_at":"2025-02-20T06:33:20.891Z","dependency_job_id":"bf2ab398-12bd-48f0-8344-c60f4c504e73","html_url":"https://github.com/shin202/flixhq-core","commit_stats":{"total_commits":54,"total_committers":3,"mean_commits":18.0,"dds":0.2407407407407407,"last_synced_commit":"a2436f0d51c88571839715f1392d9b73d36a8b08"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shin202%2Fflixhq-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shin202%2Fflixhq-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shin202%2Fflixhq-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shin202%2Fflixhq-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shin202","download_url":"https://codeload.github.com/shin202/flixhq-core/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248446655,"owners_count":21105130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","apis","core","crawler","library","movies","movies-api","node-js","nodejs","scraper","typescript"],"created_at":"2025-02-20T06:33:11.304Z","updated_at":"2025-04-11T17:02:08.304Z","avatar_url":"https://github.com/shin202.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# FLIXHQ CORE\n\nNodejs library that provides an Api for obtaining the movies information from FlixHQ website.\n\n```ts\nimport { MOVIES } from 'flixhq-core'\n\nconst flixhq = new MOVIES.FlixHQ();\n```\n\n## Installation\n\nInstall with npm\n\n```bash\n  npm install flixhq-core\n```\n    \n## Methods\n\n- [home](#home)\n- [fetchGenresList](#fetchgenresList)\n- [fetchCountriesList](#fetchcountriesList)\n- [fetchMovieByCountryOrGenre](#fetchmoviebycountryorgenre)\n- [fetchMovieByType](#fetchmoviebytype)\n- [fetchMovieByTopIMDB](#fetchmoviebytopimdb)\n- [fetchMovieInfo](#fetchmovieinfo)\n- [fetchEpisodeServers](#fetchepisodeservers)\n- [fetchEpisodeSources](#fetchepisodesources)\n- [search](#search)\n- [fetchFiltersList](#fetchfilterslist)\n- [filter](#filter)\n\n### home\nFetch data of the FlixHQ homepage.\n\n```ts\n// Promise: \nflixhq.home().then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.home();\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an object. (*[`Promise\u003cIHomeResult\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L49-L60)*).\n\n### fetchGenresList\n```ts\n// Promise:\nflixhq.fetchGenresList().then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchGenresList();\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of genres. (*[`Promise\u003cIGenre[]\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L62-L67)*).\n\n### fetchCountriesList\n```ts\n// Promise:\nflixhq.fetchCountriesList().then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchCountriesList();\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of countries. (*[`Promise\u003cICountry[]\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L68-L72)*).\n\n### fetchMovieByCountryOrGenre\n| Parameter | Type                                                                                     | Description                                                                                                            |\n| --------- |------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|\n| filterBy  | [`Filters`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L14-L17) | Accept: \"GENRE\" or \"COUNTRY\".                                                                                          |\n| query | string                                                                                   | query that depend on the `filterBy` parameter. (*genre or country that can be found in the genres or countries list*). |\n| page (optional) | number                                                                                   | page number (*default: 1*).                                                                                            |\n\n```ts\n// Promise:\nflixhq.fetchMovieByCountryOrGenre(Filter.COUNTRY, \"US\").then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchMovieByCountryOrGenre(Filter.COUNTRY, \"US\");\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of movies/tvseries. (*[`Promise\u003cISearch\u003cIMovieResult\u003e\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*).\n\n### fetchMovieByType\n| Parameter | Type                                                                                     | Description                    |\n| --------- |------------------------------------------------------------------------------------------|--------------------------------|\n| type      | [`MovieType`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L1-L5) | Accept: \"MOVIE\" or \"TVSERIES\". |\n| page (optional) | number                                                                                   | page number (default: 1).      |\n\n```ts\n// Promise:\nflixhq.fetchMovieByType(MovieType.MOVIE).then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchMovieByType(MovieType.MOVIE);\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of movies. (*[`Promise\u003cISearch\u003cIMovieResult\u003e\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*).\n\n### fetchMovieByTopIMDB\n| Parameter | Type                                                                                     | Description |\n| --------- |------------------------------------------------------------------------------------------| ----------- |\n| type (optional) | [`MovieType`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L1-L5) | Accept: \"MOVIE\" or \"TVSERIES\" (default: \"ALL\"). |\n| page (optional) | number                                                                                   | page number (default: 1). |\n\n```ts\n// Promise:\nflixhq.fetchMovieByTopIMDB().then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchMovieByTopIMDB();\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of movies/tvseries. (*[`Promise\u003cISearch\u003cIMovieResult\u003e\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*).\n\n### fetchMovieInfo\n| Parameter | Type | Description |\n| --------- | ---- | ----------- |\n| mediaId   | string | (*can be found in the media search results.*). |\n\n```ts\n// Promise:\nflixhq.fetchMovieInfo(\"movie/watch-m3gan-91330\").then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchMovieInfo(\"movie/watch-m3gan-91330\");\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an object of movie info. (*[`Promise\u003cIMovieInfo\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L91-L104)*).\n\n### fetchEpisodeServers\n| Parameter | Type | Description |\n| --------- | ---- | ----------- |\n| mediaId   | string | (*can be found in the media search results.*). |\n| episodeId | string | (*can be found in the media info results as shown on the above method*). |\n\n```ts\n// Promise:\nflixhq.fetchEpisodeServers(\"movie/watch-m3gan-91330\", \"91330\").then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchEpisodeServers(\"movie/watch-m3gan-91330\", \"91330\");\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of the servers info. (*[`Promise\u003cIEpisodeServer\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L106-L110)*).\n\n### fetchEpisodeSources\n| Parameter | Type                                                                                              | Description |\n| --------- |---------------------------------------------------------------------------------------------------| ----------- |\n| mediaId   | string                                                                                            | (*can be found in the media search results.*). |\n| episodeId | string                                                                                            | (*can be found in the media info results as shown on the above method*). |\n| server (optional) | [`StreamingServers`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L19-L23) | Accept: \"UpCloud\" or \"VidCloud\" or \"MixDrop\" (default: \"UpCloud\"). |\n\n```ts\n// Promsie:\nflixhq.fetchEpisodeSources(\"movie/watch-m3gan-91330\", \"91330\").then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.fetchEpisodeSources(\"movie/watch-m3gan-91330\", \"91330\");\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an object of media sources and subtitles.\n\n### search\n| Parameter | Type | Description |\n| --------- | ---- | ----------- |\n| query     | string | movie or tvseries name. |\n| page (optional) | number | page number (default: 1). |\n\n```ts\n// Promise:\nflixhq.search(\"the last of us\").then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.search(\"the last of us\");\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of movies/tvseries. (*[`Promise\u003cISearch\u003cIMovieResult\u003e\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*).\n\n### fetchFiltersList\n```ts\n// Promise:\nflixhq. fetchFiltersList().then(data =\u003e console.log(data));\n\n// Async/AwaitL\n(async () =\u003e {\n    const data = await flixhq.fetchFiltersList();\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an object of filters info. (*[`Promise\u003cIMovieFilter\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L142-L149)*).\n\n### filter \n| Parameter | Type                                                                                            | Description |\n| --------- |-------------------------------------------------------------------------------------------------| ----------- |\n| options   | [`IMovieFilter`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L142-L149) | (*Includes: type, quality, released, genre, country. Can be found in the filters list as shown on the above method.*) |\n| page (optional) | number                                                                                          | page number (default: 1). |\n\n```ts\n// Promise:\nconst options = { type: 'all', quality: 'all', released: 'all', genre: 'all', country: 'all' };\n\nflixhq.filter(options).then(data =\u003e console.log(data));\n\n// Async/Await:\n(async () =\u003e {\n    const data = await flixhq.filter(options);\n    console.log(data);\n})();\n```\nreturns a promise which resolves into an array of movies/tvseries. (*[`Promise\u003cISearch\u003cIMovieResult\u003e\u003e`](https://github.com/shin202/flixhq-core/blob/main/src/types/types.ts#L74-L80)*).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshin202%2Fflixhq-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshin202%2Fflixhq-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshin202%2Fflixhq-core/lists"}