newpipe-documentation/docs/index.md

1.2 KiB

Welcome to the NewPipe Documentation.

This site is/should be a beginner friendly tutorial and documentation for people who want to use, or write services for the NewPipe Extractor. It is an addition to our auto generated jdoc documentation.

Please be aware that it is also in an early state, so help and feedback is always welcome :D

Introduction

The NewPipeExtractor is a Java framework for scraping video platform websites in a way that they can be accessed like a normal API. The extractor is the core of the popular YouTube and streaming App NewPipe for android, however it's system independent and also available for other platforms.

The beauty behind this framework is it takes care of the extracting process, error handling etc., so you can take care about what is important: Scraping the website. It focuses on making it possible for the creator of a scraper for a streaming service to create the best outcome with the least amount of written code.