YT-SCRAPER-API

Esta é uma API de coleta de dados de vídeos do YouTube feita em NodeJS

A API está atualmente disponível em https://yt-scraper-api.herokuapp.com/ sendo possível testar as rotas destacadas neste documento.

Recursos

• Salvar dados de um vídeo do youtube fornecendo apenas a URL
• Retornar os dados salvos com várias opções de filtros

Tecnologias

• node.js
• Express
• Puppeteer
• Mongoose
• Typescript

Instalação

Para testar em sua máquina utilize:

git clone https://github.com/Fabiopf02/yt_scraper_api.git

Crie o arquivo .env na raiz do projeto para configurar as variáveis ambiente do banco de dados, seguindo o arquivo .env.example

Instale as dependências:

> yarn install

E por fim:

> yarn dev

Ou:

> yarn build
> yarn start

E acesse http://localhost:3000

Rotas

Rota	Método	Parâmetros	Consulta (opcional)
/videos	GET	-	?limit=<number> & page=<number> & sortField=<string> & sortValue=<string>
/video:id	GET	/String	?limit=<number> & page=<number> & sortField=<string> & sortValue=<string>
/new	POST	-	-
/search	GET	-	?q=<termo buscado> & limit=<number> & page<number> & sortField=<string> & sortValue=<string>
/channel:channel	GET	/String	?limit=<number> & page=<number> & sortField=<string> & sortValue=<string>
/tag:tag	GET	/String	?limit=<number> & page=<number> & sortField=<string> & sortValue=<string>
/genre:genre	GET	/String	?limit=<number> & page=<number> & sortField=<string> & sortValue=<string>

A rota /new recebe uma url no corpo da requisição no formato JSON

{
    "url": "<link do vídeo>"
}

Paginação

Todas as rotas do tipo GET possuem como consulta opcional (para paginação) limit e page Por padrão os valores são: limit=10&page=1

/videos?limit=<number>&page=<number>

Formato do retorno

[
 {
   "keywords": string[],
   "_id": string,
   "title": string,
   "description": string,
   "channel": string,
   "channelUrl": string,
   "uploadedAt": Date,
   "avatarUrl": string,
   "timeDuration": number,
   "videoUrl": string,
   "videoId": string,
   "thumbnailUrl": string,
   "genre": string,
   "channelId": string,
   "isFamilyFriendly": boolean,
   "createdAt": Date,
   "updatedAt": Date,
  },
 ]

Licença

MIT