├── .editorconfig ├── .eslintignore ├── .eslintrc.js ├── .github ├── labeler.yml └── workflows │ ├── autoMerge.yml │ ├── ci.yml │ ├── codeql.yml │ ├── conflicts.yml │ ├── dummy-conflicts.yml │ ├── label-pr.yml │ ├── linter.yml │ └── remove-outdated-labels.yml ├── .gitignore ├── LICENSE ├── README.md ├── index.d.ts ├── index.js ├── package-lock.json ├── package.json ├── src ├── HtmlParser.js ├── TrendingRequester.js └── Youtube-Scraper.js └── test └── scraper.test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [*.md] 12 | trim_trailing_whitespace = false 13 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | _scripts 3 | dist 4 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | // https://eslint.org/docs/user-guide/configuring#using-configuration-files-1 3 | root: true, 4 | 5 | // https://eslint.org/docs/user-guide/configuring#specifying-environments 6 | env: { 7 | browser: true, 8 | node: true, 9 | jest: true 10 | }, 11 | 12 | // https://vuejs.github.io/eslint-plugin-vue/user-guide/#faq 13 | parserOptions: { 14 | parser: '@babel/eslint-parser', 15 | // Many methods now accept inputs in "Named parameters/keyword arguments" way 16 | // Which is implemented via nullish coalescing (the ?? operator) introduced in ECMAScript 2020 17 | // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing_operator 18 | ecmaVersion: 2020, 19 | sourceType: 'module', 20 | }, 21 | 22 | // https://eslint.org/docs/user-guide/configuring#extending-configuration-files 23 | // order matters: from least important to most important in terms of overriding 24 | // Prettier + Vue: https://medium.com/@gogl.alex/how-to-properly-set-up-eslint-with-prettier-for-vue-or-nuxt-in-vscode-e42532099a9c 25 | extends: [ 26 | 'prettier', 27 | 'eslint:recommended', 28 | 'standard', 29 | ], 30 | 31 | rules: { 32 | 'space-before-function-paren': 'off', 33 | 'comma-dangle': 'off', 34 | 'no-console': 'off', 35 | 'no-unused-vars': 'warn', 36 | 'no-undef': 'warn', 37 | 'object-shorthand': 'off' 38 | }, 39 | } 40 | -------------------------------------------------------------------------------- /.github/labeler.yml: -------------------------------------------------------------------------------- 1 | 'PR: waiting for review': 2 | - '*' 3 | - '.github/**/*' 4 | - 'src/**/*' 5 | - 'test/**/*' 6 | - '.editorconfig' 7 | - '.eslintignore' 8 | - '.eslintrc.js' 9 | - '.gitignore' 10 | 11 | 'PR: dependencies': 12 | - 'package-lock.json' 13 | - 'package.json' 14 | -------------------------------------------------------------------------------- /.github/workflows/autoMerge.yml: -------------------------------------------------------------------------------- 1 | name: Auto Merge PR 2 | on: 3 | pull_request_target: 4 | types: [opened, synchronize, reopened] 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - name: Auto Merge PR 12 | if: contains(${{ github.event.pull_request.base.ref }}, 'development') 13 | run: | 14 | echo ${{ secrets.GH_TOKEN }} >> auth.txt 15 | gh auth login --with-token < auth.txt 16 | rm auth.txt 17 | gh pr merge https://github.com/FreeTubeApp/yt-trending-scraper/pull/${{ github.event.pull_request.number }} --auto --squash 18 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | schedule: 5 | # once per day 6 | - cron: 0 0 * * * 7 | push: 8 | branches: 9 | - development 10 | - master 11 | pull_request: 12 | branches: 13 | - development 14 | jobs: 15 | test: 16 | runs-on: ubuntu-latest 17 | strategy: 18 | matrix: 19 | node-version: [16.x] 20 | 21 | steps: 22 | - uses: actions/checkout@v3 23 | - name: Use Node.js ${{ matrix.node-version }} 24 | uses: actions/setup-node@v3 25 | with: 26 | node-version: ${{ matrix.node-version }} 27 | cache: 'npm' 28 | - run: npm ci 29 | - run: npm run test-ci 30 | env: 31 | CI: true 32 | -------------------------------------------------------------------------------- /.github/workflows/codeql.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | 3 | on: 4 | push: 5 | branches: [ "development" ] 6 | pull_request: 7 | # The branches below must be a subset of the branches above 8 | branches: [ "development" ] 9 | schedule: 10 | - cron: '36 3 * * 5' 11 | 12 | jobs: 13 | analyze: 14 | name: Analyze 15 | runs-on: ubuntu-latest 16 | permissions: 17 | actions: read 18 | contents: read 19 | security-events: write 20 | 21 | strategy: 22 | fail-fast: false 23 | matrix: 24 | language: [ 'javascript' ] 25 | # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] 26 | # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support 27 | 28 | steps: 29 | - name: Checkout repository 30 | uses: actions/checkout@v3 31 | 32 | # Initializes the CodeQL tools for scanning. 33 | - name: Initialize CodeQL 34 | uses: github/codeql-action/init@v2 35 | with: 36 | languages: ${{ matrix.language }} 37 | # If you wish to specify custom queries, you can do so here or in a config file. 38 | # By default, queries listed here will override any specified in a config file. 39 | # Prefix the list here with "+" to use these queries and those in the config file. 40 | 41 | # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs 42 | # queries: security-extended,security-and-quality 43 | 44 | 45 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 46 | # If this step fails, then you should remove it and run the build manually (see below) 47 | - name: Autobuild 48 | uses: github/codeql-action/autobuild@v2 49 | 50 | # ℹ️ Command-line programs to run using the OS shell. 51 | # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun 52 | 53 | # If the Autobuild fails above, remove it and uncomment the following three lines. 54 | # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. 55 | 56 | # - run: | 57 | # echo "Run, Build Application using script" 58 | # ./location_of_script_within_repo/buildscript.sh 59 | 60 | - name: Perform CodeQL Analysis 61 | uses: github/codeql-action/analyze@v2 62 | with: 63 | category: "/language:${{matrix.language}}" 64 | -------------------------------------------------------------------------------- /.github/workflows/conflicts.yml: -------------------------------------------------------------------------------- 1 | name: "Conflicts" 2 | on: 3 | # So that PRs touching the same files as the push are updated 4 | push: 5 | # So that the `dirtyLabel` is removed if conflicts are resolve 6 | # We recommend `pull_request_target` so that github secrets are available. 7 | # In `pull_request` we wouldn't be able to change labels of fork PRs 8 | pull_request_target: 9 | types: [synchronize] 10 | workflow_run: 11 | workflows: ['Dummy workflow for conflicts'] 12 | types: [requested] 13 | 14 | jobs: 15 | main: 16 | runs-on: ubuntu-latest 17 | steps: 18 | - name: check if prs are dirty 19 | uses: eps1lon/actions-label-merge-conflict@releases/2.x 20 | with: 21 | dirtyLabel: "PR: merge conflicts / rebase needed" 22 | removeOnDirtyLabel: "PR: waiting for review" 23 | repoToken: "${{ secrets.GITHUB_TOKEN }}" 24 | commentOnDirty: "This pull request has conflicts, please resolve those before we can evaluate the pull request." 25 | commentOnClean: "Conflicts have been resolved. A maintainer will review the pull request shortly." 26 | -------------------------------------------------------------------------------- /.github/workflows/dummy-conflicts.yml: -------------------------------------------------------------------------------- 1 | name: Dummy workflow for conflicts 2 | on: 3 | pull_request_review: 4 | types: [submitted] 5 | jobs: 6 | dummy: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - run: echo "this is a dummy workflow that triggers a workflow_run; it's necessary because otherwise the repo secrets will not be in scope for externally forked pull requests" 10 | -------------------------------------------------------------------------------- /.github/workflows/label-pr.yml: -------------------------------------------------------------------------------- 1 | name: "Pull Request Labeler" 2 | on: 3 | pull_request_target: 4 | types: [opened, reopened] 5 | 6 | jobs: 7 | triage: 8 | permissions: 9 | contents: read 10 | pull-requests: write 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/labeler@v4 14 | with: 15 | repo-token: "${{ secrets.GITHUB_TOKEN }}" 16 | -------------------------------------------------------------------------------- /.github/workflows/linter.yml: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: Linter 4 | 5 | # Controls when the action will run. Triggers the workflow on push or pull request 6 | # events but only for the master branch 7 | on: 8 | pull_request: 9 | branches: [ master, development ] 10 | 11 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 12 | jobs: 13 | # This workflow contains a single job called "build" 14 | lint: 15 | # The type of runner that the job will run on 16 | runs-on: ubuntu-latest 17 | 18 | # Steps represent a sequence of tasks that will be executed as part of the job 19 | steps: 20 | - uses: actions/checkout@v3 21 | - name: Use Node.js 16.x 22 | uses: actions/setup-node@v3 23 | with: 24 | node-version: 16.x 25 | cache: "npm" 26 | - run: npm install 27 | - run: npm run lint 28 | -------------------------------------------------------------------------------- /.github/workflows/remove-outdated-labels.yml: -------------------------------------------------------------------------------- 1 | name: Remove outdated labels 2 | on: 3 | # https://github.community/t/github-actions-are-severely-limited-on-prs/18179/15 4 | pull_request_target: 5 | types: 6 | - closed 7 | jobs: 8 | remove-merged-pr-labels: 9 | name: Remove merged pull request labels 10 | if: github.event.pull_request.merged 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: mondeja/remove-labels-gh-action@v1.1.1 14 | with: 15 | token: ${{ secrets.GITHUB_TOKEN }} 16 | labels: | 17 | PR: waiting for review 18 | PR: WIP 19 | PR: changes requested 20 | PR: merge conflicts / rebase needed 21 | PR/Issue: dependent 22 | 23 | remove-closed-pr-labels: 24 | name: Remove closed pull request labels 25 | if: github.event_name == 'pull_request_target' && (! github.event.pull_request.merged) 26 | runs-on: ubuntu-latest 27 | steps: 28 | - uses: mondeja/remove-labels-gh-action@v1.1.1 29 | with: 30 | token: ${{ secrets.GITHUB_TOKEN }} 31 | labels: | 32 | PR: waiting for review 33 | PR: WIP 34 | PR: changes requested 35 | PR: merge conflicts / rebase needed 36 | PR/Issue: dependent 37 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | # JetBrains directory 107 | .idea/ 108 | 109 | debug/ 110 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # No Longer Maintained 2 | This repository is no longer maintained. The functionality of this project has been merged into [YouTube.js](https://github.com/LuanRT/YouTube.js). We highly recommend switching to that package in order to have the latest functionality. We cannot promise stability if you continue to use this package as is. 3 | 4 | # YouTube Trending Videos Scraper NodeJS Documentation 5 | This NodeJS library can scrape all available trending pages of YouTube without any API usage. It is developed for and tailored towards easy usage in [FreeTube](https://github.com/FreeTubeApp/FreeTube) but can be used with any other project as well. 6 | 7 | Therefore, this library does not require any API keys, with the attached maximum quotas, but instead might take longer to receive the required data. 8 | 9 | The library works as long as YouTube keeps its web page layout the same. Therefore, there is **no guarantee** that this library will work at all times. 10 | If this library should not work at some point, please create an issue and let me know so that I can take a look into it. Pull requests are also welcomed in this case. 11 | 12 | ## Installation 13 | `npm install @freetubeapp/yt-trending-scraper` 14 | 15 | ## Usage 16 | `const ytrend = require("@freetubeapp/yt-trending-scraper")` 17 | 18 | ## API 19 | **scrapeTrendingPage(_parameters_)** 20 | Returns a list of objects containing all the information of the trending videos. 21 | 22 | The parameters object can contain the following options: 23 | 24 | ``` 25 | geoLocation: String, 26 | parseCreatorOnRise: Boolean, 27 | page: String 28 | ``` 29 | 30 | 31 | __geoLocation__ is an optional parameter to change the country (e.g. JP for Japan) of the trending page. The alpha2 code of the country must be used 32 | 33 | 34 | __parseCreatorOnRise__ is an optional parameter which allows the parser to process any horizontal video list, which usually is a creator on the rise. But this is not always available, so the scraper will process as usual even when the parameter is set to true. Defaults to **false** 35 | 36 | 37 | __page__ is an optional parameter which allows to choose one of the 4 trending pages below. 38 | 39 | - `default` 40 | - `music` 41 | - `gaming` 42 | - `movies` 43 | 44 | ### Example usage 45 | 46 | ```javascript 47 | const parameters = { 48 | geoLocation: 'JP', 49 | parseCreatorOnRise: false, 50 | page: 'music' 51 | } 52 | 53 | ytrend.scrapeTrendingPage(parameters).then((data) =>{ 54 | console.log(data); 55 | }).catch((error)=>{ 56 | console.error(error); 57 | }); 58 | 59 | // The data is a list of objects containing the following attributes: 60 | { 61 | videoId: String, 62 | title: String, 63 | type: "video", 64 | author: String, 65 | authorId: String, 66 | authorUrl: String, 67 | videoThumbnails: Array[Objects], 68 | description: String, 69 | viewCount: Number, 70 | published: Number as timestamp, 71 | publishedText: String, 72 | lengthSeconds: Number, 73 | timeText: String, 74 | liveNow: false, 75 | paid: false, 76 | premium: false, 77 | isUpcoming: false, 78 | isCreatorOnRise: Boolean, // indicates whether the video is part of a creator on the rise 79 | isVerified: Boolean, 80 | isVerifiedArist: Boolean, 81 | isShort: Boolean 82 | } 83 | 84 | // The thumbnail objects: 85 | { 86 | quality: "String", 87 | url: "String", 88 | width: Number, 89 | height: Number 90 | } 91 | ``` 92 | ## Credits 93 | Thanks to PrestoN for the basic instructions and underlying request code and thanks to ~cadence for the HTML extractor RegEx. 94 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | declare module "@freetubeapp/yt-trending-scraper" { 2 | interface Thumbnail { 3 | quality: string 4 | url: string 5 | width: number 6 | height: number 7 | } 8 | interface Video { 9 | videoId: string, 10 | title: string, 11 | type: "video", 12 | author: string, 13 | authorId: string, 14 | authorUrl: string, 15 | videoThumbnails: Thumbnail[], 16 | description: string, 17 | viewCount: number, 18 | published: EpochTimeStamp, 19 | publishedText: string, 20 | lengthSeconds: number, 21 | timeText: string, 22 | liveNow: false, 23 | paid: false, 24 | premium: false, 25 | isUpcoming: false, 26 | isCreatorOnRise: boolean, 27 | isVerified: boolean, 28 | isVerifiedAuthor: boolean, 29 | isShort: boolean 30 | } 31 | interface TrendingPayload { 32 | geoLocation: string, 33 | parseCreatorOnRise: boolean, 34 | page: "default" | "music" | "gaming" | "movies" 35 | } 36 | class TrendingScraper { 37 | static scrapeTrendingPage(payload: TrendingPayload) : Promise 38 | } 39 | export default TrendingScraper 40 | } 41 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require('./src/Youtube-Scraper') 2 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@freetube/yt-trending-scraper", 3 | "version": "3.1.1", 4 | "description": "Identifies the currently trending videos on YouTube and returns all trending site information about every video without accessing the YouTube API.", 5 | "main": "index.js", 6 | "files": [ 7 | "index.js", 8 | "src/", 9 | "index.d.ts" 10 | ], 11 | "scripts": { 12 | "test": "jest --watchAll --verbose --coverage", 13 | "test-ci": "jest --verbose --ci --coverage", 14 | "lint-fix": "eslint --fix --ext .js ./", 15 | "lint": "eslint --ext .js ./" 16 | }, 17 | "repository": { 18 | "type": "git", 19 | "url": "https://github.com/FreeTubeApp/yt-trending-scraper.git" 20 | }, 21 | "publishConfig": { 22 | "access": "public" 23 | }, 24 | "keywords": [ 25 | "youtube", 26 | "youtube-fetch", 27 | "youtube-scrapper", 28 | "youtube-grabber", 29 | "youtube trending", 30 | "youtube-trending", 31 | "youtube without api", 32 | "youtube-fetcher", 33 | "trending", 34 | "youtube trending scraper", 35 | "youtube trends scraper", 36 | "youtube trends", 37 | "trends" 38 | ], 39 | "author": "GilgusMaximus ", 40 | "license": "GPLv3", 41 | "dependencies": { 42 | "axios": "^1.1.2" 43 | }, 44 | "devDependencies": { 45 | "eslint": "^8.22.0", 46 | "eslint-config-prettier": "^8.5.0", 47 | "eslint-config-standard": "^17.0.0", 48 | "eslint-plugin-import": "^2.26.0", 49 | "eslint-plugin-n": "15.6.0", 50 | "eslint-plugin-node": "^11.1.0", 51 | "eslint-plugin-prettier": "^4.2.1", 52 | "eslint-plugin-promise": "^6.0.0", 53 | "jest": "^29.1.2", 54 | "prettier": "^2.7.1" 55 | }, 56 | "types": "index.d.ts" 57 | } 58 | -------------------------------------------------------------------------------- /src/HtmlParser.js: -------------------------------------------------------------------------------- 1 | class HtmlParser { 2 | static parseNewHtml(htmlData, parseCreatorOnRise) { 3 | // matches the special setup of the video elements 4 | const jsonDataRegex = /ytInitialData = (.+)?(;<\/script>)/ 5 | const jsonObject = JSON.parse(htmlData.match(jsonDataRegex)[1]) 6 | const jsonContent = jsonObject.contents.twoColumnBrowseResultsRenderer.tabs 7 | .find(e => e.tabRenderer.selected) 8 | .tabRenderer 9 | .content 10 | let contentArrayJSON 11 | if ('sectionListRenderer' in jsonContent) { 12 | contentArrayJSON = jsonContent.sectionListRenderer.contents 13 | } else if ('richGridRenderer' in jsonContent) { 14 | contentArrayJSON = jsonContent.richGridRenderer.contents 15 | } 16 | let videos = [] 17 | const currentTime = Date.now() 18 | contentArrayJSON.forEach((data) => { 19 | if ('itemSectionRenderer' in data) { 20 | const videoList = this.buildApiOutput(data.itemSectionRenderer.contents[0].shelfRenderer.content, currentTime, parseCreatorOnRise) 21 | videos = [...videos, ...videoList] 22 | } else if ('richItemRenderer' in data) { 23 | videos.push( 24 | this.parseRichItemRenderer(data, currentTime) 25 | ) 26 | } else if ('richSectionRenderer' in data) { 27 | const videoList = this.parseRichSectionRenderer(data, currentTime) 28 | videos = [...videos, ...videoList] 29 | } 30 | }) 31 | return this.deduplicateVideoList(videos) 32 | } 33 | 34 | static deduplicateVideoList(videos) { 35 | const uniqueIds = new Set() 36 | return videos.filter((video) => { 37 | if (!uniqueIds.has(video.videoId)) { 38 | uniqueIds.add(video.videoId) 39 | return true 40 | } 41 | return false 42 | }) 43 | } 44 | 45 | // access the one video container and build and object with all the data required 46 | static buildApiOutput(videoList, currentTime, parseCreatorOnRise) { 47 | if ('horizontalListRenderer' in videoList && parseCreatorOnRise) { 48 | // we have a creator on the rise element with other structure 49 | return this.parseHorizontalVideoSection(videoList.horizontalListRenderer.items, currentTime) 50 | } else if ('expandedShelfContentsRenderer' in videoList) { 51 | // normal video section 52 | return this.parseNormalVideoSection(videoList.expandedShelfContentsRenderer.items, currentTime) 53 | } 54 | return [] 55 | } 56 | 57 | static parseHorizontalVideoSection(videoList, currentTime) { 58 | const videoEntryList = [] 59 | videoList.forEach((videoRenderer) => { 60 | videoRenderer = videoRenderer.gridVideoRenderer 61 | videoEntryList.push(this.parseVideo(videoRenderer, currentTime)) 62 | }) 63 | return videoEntryList.map(videoEntry => { 64 | videoEntry.isCreatorOnRise = true 65 | return videoEntry 66 | }) 67 | } 68 | 69 | static parseNormalVideoSection(videoList, currentTime) { 70 | const videoEntryList = [] 71 | videoList.forEach((videoRenderer) => { 72 | videoRenderer = videoRenderer.videoRenderer 73 | videoEntryList.push(this.parseVideo(videoRenderer, currentTime)) 74 | }) 75 | return videoEntryList 76 | } 77 | 78 | static parseRichItemRenderer(data, currentTime) { 79 | return this.parseVideo(data.richItemRenderer.content.videoRenderer, currentTime) 80 | } 81 | 82 | static parseRichSectionRenderer(data, currentTime) { 83 | return data.richSectionRenderer.content.richShelfRenderer.contents.map(rsr => { 84 | return this.parseRichItemRenderer(rsr, currentTime) 85 | }) 86 | } 87 | 88 | static parseVideo(videoRenderer, currentTime) { 89 | const videoEntry = { 90 | videoId: -1, 91 | title: '', 92 | type: 'video', 93 | author: '', 94 | authorId: '', 95 | authorUrl: '', 96 | videoThumbnails: [], 97 | description: '', 98 | viewCount: -1, 99 | published: -1, 100 | publishedText: '', 101 | lengthSeconds: -1, 102 | liveNow: false, 103 | paid: false, 104 | premium: false, 105 | isUpcoming: false, 106 | timeText: '', 107 | isCreatorOnRise: false, 108 | isVerified: false, 109 | isVerifiedArtist: false, 110 | isShort: false 111 | } 112 | videoEntry.videoId = videoRenderer.videoId 113 | videoEntry.title = videoRenderer.title.runs[0].text 114 | videoEntry.author = videoRenderer.shortBylineText.runs[0].text 115 | videoEntry.authorId = videoRenderer.shortBylineText.runs[0].navigationEndpoint.browseEndpoint.browseId 116 | videoEntry.authorUrl = videoRenderer.shortBylineText.runs[0].navigationEndpoint.commandMetadata.webCommandMetadata.url 117 | videoEntry.viewCount = this.calculateViewCount(videoRenderer.viewCountText.simpleText) 118 | videoEntry.publishedText = videoRenderer.publishedTimeText.simpleText 119 | videoEntry.published = this.calculatePublished(videoEntry.publishedText, currentTime) 120 | if (/\d/.test(videoRenderer.thumbnailOverlays[0].thumbnailOverlayTimeStatusRenderer.text.simpleText)) { 121 | videoEntry.timeText = videoRenderer.thumbnailOverlays[0].thumbnailOverlayTimeStatusRenderer.text.simpleText 122 | videoEntry.lengthSeconds = this.calculateLengthInSeconds(videoEntry.timeText) 123 | } else { // "SHORTS" text can be localized so if there's no number in duration, assume it's a short 124 | const lengthData = this.parseShortsLength(videoRenderer.title.accessibility.accessibilityData.label) 125 | videoEntry.lengthSeconds = lengthData.lengthSeconds 126 | videoEntry.timeText = lengthData.timeText 127 | videoEntry.isShort = true 128 | } 129 | videoEntry.videoThumbnails = this.extractThumbnailData(videoEntry.videoId) 130 | if ('ownerBadges' in videoRenderer) { 131 | videoEntry.isVerified = (videoRenderer.ownerBadges[0].metadataBadgeRenderer.style === 'BADGE_STYLE_TYPE_VERIFIED') 132 | videoEntry.isVerifiedArtist = (videoRenderer.ownerBadges[0].metadataBadgeRenderer.style === 'BADGE_STYLE_TYPE_VERIFIED_ARTIST') 133 | } 134 | // check whether the property is available, because there can be videos without description which won't have an empty property 135 | if ('descriptionSnippet' in videoRenderer) { 136 | videoEntry.description = videoRenderer.descriptionSnippet.runs[0].text 137 | } 138 | return videoEntry 139 | } 140 | 141 | // calculates the length of the video in seconds as a number from the string "hh:mm:ss" 142 | static calculateLengthInSeconds(lengthText) { 143 | let lengthSeconds = 0 144 | const hoursMinutesSeconds = lengthText.match(/(\d(\d)*)/g) 145 | // calculate the time in seconds for every entry 146 | for (let i = hoursMinutesSeconds.length - 1; i >= 0; i--) { 147 | lengthSeconds += Math.pow(60, (hoursMinutesSeconds.length - i - 1)) * hoursMinutesSeconds[i] 148 | } 149 | return lengthSeconds 150 | } 151 | 152 | // calculates the number of views from the corresponding string "xxx,xxx,xxx,xxx" 153 | static calculateViewCount(viewText) { 154 | let viewCount = 0 155 | const viewersThreeSplit = viewText.match(/(\d(\d)*)/g) 156 | for (let i = 0; i < viewersThreeSplit.length; i++) { 157 | viewCount = viewCount * 1000 + Number(viewersThreeSplit[i]) 158 | } 159 | return viewCount 160 | } 161 | 162 | // calculates the rough timestamp of the release - very exact for minutes, medium exact for hours and loosy exact for days 163 | static calculatePublished(publishText, currentTime) { 164 | const timePublishedAgo = publishText.match(/(\d(\d)*)/g) 165 | let timeSpan 166 | if (publishText.indexOf('week') > -1) { 167 | // posted x weeks ago 168 | timeSpan = Number(timePublishedAgo[0]) * 24 * 360 * 1000 * 7 169 | } else if (publishText.indexOf('day') > -1) { 170 | // posted x days ago 171 | timeSpan = Number(timePublishedAgo[0]) * 24 * 360 * 1000 172 | } else if (publishText.indexOf('hour') > -1) { 173 | // posted x hours ago 174 | timeSpan = Number(timePublishedAgo[0]) * 360 * 1000 175 | } else { 176 | // posted x minutes ago, just in case 177 | timeSpan = Number(timePublishedAgo[0]) * 60 * 1000 178 | } 179 | return currentTime - timeSpan 180 | } 181 | 182 | // creates a list of dictionaries with the relevant data for the different thumbnails 183 | // TODO maxres.jpg does not load even tho it loads in invidious 184 | static extractThumbnailData(videoId) { 185 | // TODO: make customizable 186 | return [ 187 | this.createThumbnailDictionary('maxres', `https://i.ytimg.com/vi/${videoId}/maxres.jpg`, 1280, 720), 188 | this.createThumbnailDictionary('maxresdefault', `https://i.ytimg.com/vi/${videoId}/maxresdefault.jpg`, 1280, 720), 189 | this.createThumbnailDictionary('sddefault', `https://i.ytimg.com/vi/${videoId}/sddefault.jpg`, 640, 480), 190 | this.createThumbnailDictionary('high', `https://i.ytimg.com/vi/${videoId}/hqdefault.jpg`, 480, 360), 191 | this.createThumbnailDictionary('medium', `https://i.ytimg.com/vi/${videoId}/mqdefault.jpg`, 320, 180), 192 | this.createThumbnailDictionary('default', `https://i.ytimg.com/vi/${videoId}/default.jpg`, 120, 90), 193 | this.createThumbnailDictionary('start', `https://i.ytimg.com/vi/${videoId}/1.jpg`, 120, 90), 194 | this.createThumbnailDictionary('middle', `https://i.ytimg.com/vi/${videoId}/2.jpg`, 120, 90), 195 | this.createThumbnailDictionary('end', `https://i.ytimg.com/vi/${videoId}/3.jpg`, 120, 90), 196 | ] 197 | } 198 | 199 | static createThumbnailDictionary(quality, url, width, height) { 200 | return { 201 | quality: quality, 202 | url: url, 203 | width: width, 204 | height: height 205 | } 206 | } 207 | 208 | static parseShortsLength(accessibilityData) { 209 | // "accessibilityData format: {Video Title} {x} weeks ago {y} seconds {z} views - play Short 210 | // (text is different depending on location, ex: german ip = german text) 211 | let timeText = '0' 212 | let lengthSeconds = 0 213 | const numbersAndSpacesRegex = /[^0-9\s]/g 214 | const numbersOnly = accessibilityData.replace(numbersAndSpacesRegex, '').trim().split(' ').filter(number => { 215 | return number !== '' 216 | }) 217 | // only care about seconds/minute, skip over view count 218 | lengthSeconds = parseInt(numbersOnly[numbersOnly.length - 2]) 219 | if (lengthSeconds === 1) { // assume it's a minute and not a second 220 | lengthSeconds *= 60 221 | timeText = '1:00' 222 | } else { 223 | timeText = '0:' + (lengthSeconds.toString().padStart(2, '0')) 224 | } 225 | return { timeText, lengthSeconds } 226 | } 227 | } 228 | module.exports = HtmlParser 229 | -------------------------------------------------------------------------------- /src/TrendingRequester.js: -------------------------------------------------------------------------------- 1 | const axios = require('axios') 2 | const trendingPageBase = 'https://www.youtube.com/feed/trending' 3 | const pageAdditions = { 4 | music: '4gINGgt5dG1hX2NoYXJ0cw%3D%3D', 5 | gaming: '4gIcGhpnYW1pbmdfY29ycHVzX21vc3RfcG9wdWxhcg%3D%3D', 6 | movies: '4gIKGgh0cmFpbGVycw%3D%3D' 7 | } 8 | 9 | class TrendingRequester { 10 | static async requestTrendingPage(geoLocation = null, page) { 11 | try { 12 | const params = {} 13 | if (geoLocation !== null) { 14 | params.persist_gl = 1 15 | params.gl = geoLocation 16 | } 17 | if (page !== 'default') { 18 | try { 19 | params.bp = pageAdditions[page] 20 | } catch (error) { 21 | console.error('Fallback to default trending page because no valid page name was provided:', page) 22 | } 23 | } 24 | return await axios.get(trendingPageBase, { params }) 25 | } catch (e) { 26 | return { 27 | error: true, 28 | message: e 29 | } 30 | } 31 | } 32 | } 33 | module.exports = TrendingRequester 34 | -------------------------------------------------------------------------------- /src/Youtube-Scraper.js: -------------------------------------------------------------------------------- 1 | const requester = require('./TrendingRequester') 2 | const htmlParser = require('./HtmlParser') 3 | class YoutubeScraper { 4 | // starting point 5 | static async scrapeTrendingPage({ page = 'default', geoLocation = null, parseCreatorOnRise = false } = {}) { 6 | const requestData = await requester.requestTrendingPage(geoLocation, page) 7 | return htmlParser.parseNewHtml(requestData.data, parseCreatorOnRise) 8 | } 9 | } 10 | module.exports = YoutubeScraper 11 | -------------------------------------------------------------------------------- /test/scraper.test.js: -------------------------------------------------------------------------------- 1 | const scraper = require('../index') 2 | describe('Scraper Test', () => { 3 | test('Scrape no arguments', () => { 4 | return scraper.scrapeTrendingPage().then((data) => { 5 | expect(data).not.toHaveLength(0) 6 | }) 7 | }) 8 | 9 | test('Scrape default page', () => { 10 | const parameters = { page: 'default' } 11 | return scraper.scrapeTrendingPage(parameters).then((data) => { 12 | expect(data).not.toHaveLength(0) 13 | }) 14 | }) 15 | 16 | test('Scrape music page', () => { 17 | const parameters = { page: 'music' } 18 | return scraper.scrapeTrendingPage(parameters).then((data) => { 19 | expect(data).not.toHaveLength(0) 20 | }) 21 | }) 22 | 23 | test('Scrape movies page', () => { 24 | const parameters = { page: 'movies' } 25 | return scraper.scrapeTrendingPage(parameters).then((data) => { 26 | expect(data).not.toHaveLength(0) 27 | }) 28 | }) 29 | 30 | test('Scrape gaming page', () => { 31 | const parameters = { page: 'gaming' } 32 | return scraper.scrapeTrendingPage(parameters).then((data) => { 33 | expect(data).not.toHaveLength(0) 34 | }) 35 | }) 36 | 37 | test('Scrape illegal page', () => { 38 | const parameters = { page: 'ThisIsNotAnOption' } 39 | return scraper.scrapeTrendingPage(parameters).then((data) => { 40 | expect(data).not.toHaveLength(0) 41 | }) 42 | }) 43 | 44 | test('Scrape parseCreatorOnRise', () => { 45 | const parameters = { parseCreatorOnRise: 'true' } 46 | return scraper.scrapeTrendingPage(parameters).then((data) => { 47 | expect(data).not.toHaveLength(0) 48 | }) 49 | }) 50 | 51 | test('Scrape Japan Geolocation', () => { 52 | const parameters = { geoLocation: 'JP' } 53 | return scraper.scrapeTrendingPage(parameters).then((data) => { 54 | expect(data).not.toHaveLength(0) 55 | }) 56 | }) 57 | 58 | test('Scrape Japan Geolocation With Creator On Rise On Music Page', () => { 59 | const parameters = { geoLocation: 'JP', parseCreatorOnRise: 'true', page: 'music' } 60 | return scraper.scrapeTrendingPage(parameters).then((data) => { 61 | expect(data).not.toHaveLength(0) 62 | }) 63 | }) 64 | }) 65 | --------------------------------------------------------------------------------