Skip to content
This repository has been archived by the owner on Mar 17, 2024. It is now read-only.

wgumenyuk/spyter

Repository files navigation

Spyter

Spyter

npm version npm downloads build coverage

Overview

About

Spyter is a modern, audio-focused YouTube crawler for Node.js. It allows you to easily search YouTube and retrieve information about playlists and videos.

  • Modern and consistent API
  • TypeScript support
  • Performant
  • No dependencies

Installation

⚠️ Node.js v18.0.0 or newer is required.

$ npm install spyter

Quick Start

import spyter from "spyter";

const video = await spyter.getVideo(
    "https://www.youtube.com/watch?v=ryT-ltTDCko"
);

/*
    {
        id: "ryT-ltTDCko",
        url: "https://www.youtube.com/watch?v=ryT-ltTDCko",
        title: "Prince - Purple Rain (Live At Paisley Park, 1999)",
        channelUrl: "https://www.youtube.com/channel/UCk3ZjUeo6rwtXVdvelevVag",
        channelName: "princevevo",
        thumbnails: [ ... ],
        duration: 696,
        isLive: false,
        formats: [ ... ]
    }
*/

Usage with CommonJS

const spyter = require("spyter");

Read more about Spyter's API on the official wiki.

Links

License

license