btch-downloader - Documentation

A Node.js library for downloading media from platforms like Instagram, TikTok, Facebook, Twitter, YouTube, MediaFire, Capcut, Google Drive, and Pinterest.

Description:

A Node.js library for downloading media from platforms like Instagram, TikTok, Facebook, Twitter, YouTube, MediaFire, Capcut, Google Drive, and Pinterest.

Source:

jsdoc.js, line 1

Version:

4.0.18

Author:

License:

See:

GitHub Repository for contributions and issue reporting.

Methods

(async, inner) aio(url) → {Promise.<Object>}

Description:

Downloads media from a given URL across supported platforms.

Source:

jsdoc.js, line 10

Examples

ESM

import { aio } from 'btch-downloader';
aio('https://www.instagram.com/p/ByxKbUSnubS/?utm_source=ig_web_copy_link')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { aio } = require('btch-downloader');
aio('https://www.instagram.com/p/ByxKbUSnubS/?utm_source=ig_web_copy_link')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The URL of the media to download (e.g., Instagram, TikTok, etc.).

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) capcut(url) → {Promise.<Object>}

Description:

Downloads media from Capcut.

Source:

jsdoc.js, line 157

Examples

ESM

import { capcut } from 'btch-downloader';
capcut('https://www.capcut.com/template-detail/7299286607478181121?template_id=7299286607478181121&share_token=80302b19-8026-4101-81df-2fd9a9cecb9c&enter_from=template_detail®ion=ID&language=in&platform=copy_link&is_copy_link=1')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { capcut } = require('btch-downloader');
capcut('https://www.capcut.com/template-detail/7299286607478181121?template_id=7299286607478181121&share_token=80302b19-8026-4101-81df-2fd9a9cecb9c&enter_from=template_detail®ion=ID&language=in&platform=copy_link&is_copy_link=1')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The Capcut media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) fbdown(url) → {Promise.<Object>}

Description:

Downloads media from Facebook.

Source:

jsdoc.js, line 73

Examples

ESM

import { fbdown } from 'btch-downloader';
fbdown('https://www.facebook.com/watch/?v=1393572814172251')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { fbdown } = require('btch-downloader');
fbdown('https://www.facebook.com/watch/?v=1393572814172251')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The Facebook media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) gdrive(url) → {Promise.<Object>}

Description:

Downloads media from Google Drive.

Source:

jsdoc.js, line 178

Examples

ESM

import { gdrive } from 'btch-downloader';
gdrive('https://drive.google.com/file/d/1thDYWcS5p5FFhzTpTev7RUv0VFnNQyZ4/view?usp=drivesdk')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { gdrive } = require('btch-downloader');
gdrive('https://drive.google.com/file/d/1thDYWcS5p5FFhzTpTev7RUv0VFnNQyZ4/view?usp=drivesdk')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The Google Drive media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) igdl(url) → {Promise.<(Array.<Object>|Object)>}

Description:

Downloads media from Instagram.

Source:

jsdoc.js, line 31

Examples

ESM

import { igdl } from 'btch-downloader';
igdl('https://www.instagram.com/p/ByxKbUSnubS/?utm_source=ig_web_copy_link')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { igdl } = require('btch-downloader');
igdl('https://www.instagram.com/p/ByxKbUSnubS/?utm_source=ig_web_copy_link')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The Instagram media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

An array of JSON objects or an error object.

Type: Promise.<(Array.<Object>|Object)>

(async, inner) mediafire(url) → {Promise.<Object>}

Description:

Downloads media from MediaFire.

Source:

jsdoc.js, line 136

Examples

ESM

import { mediafire } from 'btch-downloader';
mediafire('https://www.mediafire.com/file/941xczxhn27qbby/GBWA_V12.25FF-By.SamMods-.apk/file')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { mediafire } = require('btch-downloader');
mediafire('https://www.mediafire.com/file/941xczxhn27qbby/GBWA_V12.25FF-By.SamMods-.apk/file')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The MediaFire media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) pinterest(input) → {Promise.<Object>}

Description:

Downloads or searches media from Pinterest using a URL or text query.

Source:

jsdoc.js, line 199

Examples

ESM

import { pinterest } from 'btch-downloader';
// Using a URL
pinterest('https://pin.it/4CVodSq')
  .then(data => console.log(data))
  .catch(err => console.error(err));

// Using a search query
pinterest('Zhao Lusi')
  .then(data => console.log(data))
  .catch(err => console.error(err));

CJS

const { pinterest } = require('btch-downloader');
// Using a URL
pinterest('https://pin.it/4CVodSq')
  .then(data => console.log(data))
  .catch(err => console.error(err));

// Using a search query
pinterest('Zhao Lusi')
  .then(data => console.log(data))
  .catch(err => console.error(err));

Parameters:

Name	Type	Description
`input`	string	The Pinterest media URL or a search query.

Throws:

If the input is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) ttdl(url) → {Promise.<Object>}

Description:

Downloads media from TikTok.

Source:

jsdoc.js, line 52

Examples

ESM

import { ttdl } from 'btch-downloader';
ttdl('https://www.tiktok.com/@omagadsus/video/7025456384175017243')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { ttdl } = require('btch-downloader');
ttdl('https://www.tiktok.com/@omagadsus/video/7025456384175017243')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The TikTok media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) twitter(url) → {Promise.<Object>}

Description:

Downloads media from Twitter.

Source:

jsdoc.js, line 94

Examples

ESM

import { twitter } from 'btch-downloader';
twitter('https://twitter.com/gofoodindonesia/status/1229369819511709697')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { twitter } = require('btch-downloader');
twitter('https://twitter.com/gofoodindonesia/status/1229369819511709697')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The Twitter media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>

(async, inner) youtube(url) → {Promise.<Object>}

Description:

Downloads media from YouTube.

Source:

jsdoc.js, line 115

Examples

ESM

import { youtube } from 'btch-downloader';
youtube('https://youtube.com/watch?v=C8mJ8943X80')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

CJS

const { youtube } = require('btch-downloader');
youtube('https://youtube.com/watch?v=C8mJ8943X80')
  .then(data => console.log(data))
  .catch(err => console.error(err));
// JSON

Parameters:

Name	Type	Description
`url`	string	The YouTube media URL.

Throws:

If the URL is invalid or the media is not accessible.
Type Error

Returns:

A JSON object containing the media data.

Type: Promise.<Object>