Code Monkey home page Code Monkey logo

snowfl-api's Introduction

snowfl-api

Unofficial Snowfl API NPM package

Installation

$ npm install snowfl-api

Usage

Node.js


Boilerplate code

const { Snowfl, Sort } = require('snowfl-api') // common js
import { Snowfl, Sort } from 'snowfl-api' //ECMAjs

const snowfl = new Snowfl();

Searching Snowfl Site

let res = await snowfl.parse(<Query here>, { <config here> })
// search query must of length >= 2, config object is optional

Configuration- Optional

{
  sort: <Sorting Method>, // optional
  includeNsfw: <bool> // optional
  forceFetchMagnet: <bool> // optional
}

Avaliable Sorting Methods

MAX_SEED // Decreaing number of seed counts
MAX_LEECH // Decreasing number of leech counts
SIZE_ASC // Increasing number of size per file
SIZE_DSC // Decreasing number of size per file
RECENT // Recent shows first
NONE // No sorting (snowfl default) - Default

Include NSFW bool

true // to include NSFW content
false // only decent content - Default

Force fetch magnet url bool

true // Enable to force-fetch magnet URLs for all items, even when they are not available by default.
false // Magnet URLs are fetched only for items where they are available - Default

Return Value

{
  status: <code>,
  message: <message>,
  data: [<array of objects>]
}

Example Search

let res = await snowfl.parse('JoJo', {sort: Sort.MAX_SEED, includeNsfw: false})

Example Responses

Found Something

{
  status: 200,
  message: 'OK',
  data: [
      {
        magnet: 'magnet:?xt=urn:btih:F3B5014A2E048E9286163B3A6A9D95942F3D8F3B&tr=udp%3A%2F%2Ftracker',
        age: '12 months',
        name: 'John Coltrane - Ole Coltrane [V0](Big Papi) Jazz Music',
        size: '86.92 MB',
        seeder: 2,
        leecher: 1,
        type: 'Music',
        site: '****',
        url: 'https://www.*****.info/John-Coltrane--Ole-Coltrane-[V0](Big-Papi)-Jazz-Music-torrent-4500787.html',
        trusted: false,
        nsfw: false
      },
      {
        magnet: 'magnet:?xt=urn:btih:6f1fe981ab6624ef5c235278128c00d1c7ff534e&dn',
        age: '6 years',
        name: 'John Newman Ft. Calvin Harris Ole MP3 Download, 2016',
        size: '9.41 MB',
        seeder: 1,
        leecher: 0,
        type: 'Music',
        site: '****',
        url: 'https://www.****.com/file/2742569/john-newman-ft.-calvin-harris-ole-mp3-download-2016/',
        trusted: false,
        nsfw: false
      }
    ]
}

Nothing found

{ status: 200, message: 'OK', data: [] }

snowfl-api's People

Contributors

c0dysharma avatar ashish117 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.