@heavstaltech/api

@heavstaltech/api

A Lightweight, powerful, all-in-one scraping and utility library built by HEAVSTAL TECH. This module provides easy access to media downloaders (TikTok, YouTube, Instagram, Facebook), search engines, and AI tools.

It is designed to work seamlessly in both CommonJS (require) and ES Modules (import) environments.

---

🌐 Heavstal Tech Ecosystem

This package is part of the Heavstal Tech ecosystem.

Explore More APIs:
Visit our official API Hub to discover more tools, endpoints, and detailed documentation:
👉 https://heavstal-tech.vercel.app/apis

---

📦 Installation

Install via npm:

npm install @heavstaltech/api

---

🚀 Usage (ESM vs CJS)

This library is a hybrid module. You can use it in legacy Node.js projects or modern TypeScript/ESM projects without any configuration.

CommonJS (require)

const { downloader, search, tools } = require('@heavstaltech/api');

// or require specific functions
const { tiktok } = require('@heavstaltech/api');

ES Modules / TypeScript (import)

import { downloader, search, tools } from '@heavstaltech/api';

// or import specific functions
import { tiktok, remini } from '@heavstaltech/api';

---

📚 API Documentation

1. Social Media Downloaders

TikTok (Video & Slides)

Supports downloading videos without watermarks, searching for videos, and fetching slide images.

// 1. Search or Download via URL
const result = await downloader.tiktok("https://vt.tiktok.com/ZS...");
// OR search: await downloader.tiktok("funny cat videos");

console.log(result);
/* Output:
{
  author: { name: 'HEAVSTAL TECH', ... },
  status: true,
  title: 'Video Title',
  no_watermark: 'https://...',
  audio: 'https://...'
}
*/

// 2. TikTok Slides
const slide = await downloader.tiktokSlide("https://vt.tiktok.com/ZS...");
console.log(slide);

Instagram (Reels, Images, Videos)

Downloads content from Instagram public posts.

const ig = await downloader.igdl("https://www.instagram.com/p/Cp...");

ig.forEach(media => {
  console.log(`Type: ${media.type} | URL: ${media.url}`);
});

Facebook (Watch & Public Videos)

Downloads public Facebook videos in SD or HD.

const fb = await downloader.fbdl("https://fb.watch/...");
console.log(fb);

---

Twitter / X (Video & Audio)

Download videos from Twitter or X.com. Automatically handles link conversion and provides HD/SD options.

Alias: You can use downloader.twitter or downloader.xdl.

// Supports both twitter.com and x.com links
const video = await downloader.xdl("https://x.com/ElonMusk/status/...");

console.log(video);
/* Output:
{
  status: true,
  desc: "Tweet Caption...",
  thumbnail: "https://...",
  video_sd: "https://...", // Standard Definition
  video_hd: "https://..."  // High Definition
}
*/

---

2. YouTube (Search & Download)

Note: Powered by @distube/ytdl-core and yt-search.

Search

const results = await search.youtube("No Copyright Sounds");
console.log(results[0]); // Returns video details

Download Audio (MP3)

const audio = await downloader.ytmp3("https://youtu.be/...");
console.log(audio.url); // Direct download link

Download Video (MP4)

const video = await downloader.ytmp4("https://youtu.be/...");
console.log(video.url); // Direct download link

Play (Search & Auto-Download)

Searches for a query and immediately returns the download link for the first result.

// Get Audio
const song = await downloader.play("Adele Hello", "mp3");

// Get Video
const vid = await downloader.play("Adele Hello", "mp4");

---

3. Search & Lyrics

Guitar Chords & Lyrics

Fetches chords and lyrics from Gitagram.

const song = await search.chords("Ed Sheeran Perfect");
console.log(song.chord);

Wattpad

Search for stories on Wattpad.

const stories = await search.wattpad("Werewolf");
console.log(stories);

---

4. Utilities & AI Tools

Remini (AI Image Enhancer)

Enhances low-quality images using AI. Returns a Buffer.

const fs = require('fs');

// Methods: 'enhance', 'recolor', 'dehaze'
const buffer = await tools.remini("https://example.com/blurry.jpg", "enhance");

fs.writeFileSync("enhanced.jpg", buffer);

Screenshot Website

Takes a screenshot of any URL.

const buffer = await tools.ssweb("https://google.com", "desktop");
// options: 'desktop', 'tablet', 'phone'

Stylish Text

Converts normal text into fancy fonts.

const fonts = await tools.styleText("Heavstal Tech");
console.log(fonts);

Morse Code Converter

Convert text to International Morse Code and vice versa. Supports letters, numbers, and punctuation.

import { tools } from '@heavstaltech/api';

// 1. Encode (Text -> Morse)
const encoded = await tools.morse("HELLO WORLD", "encode");
console.log(encoded);
// Output: .... . .-.. .-.. --- / .-- --- .-. .-.. -..

// 2. Decode (Morse -> Text)
const decoded = await tools.morse("... --- ...", "decode");
console.log(decoded);
// Output: SOS

Text to Speech (Google TTS)

Convert text into audio using Google’s engine.

import { tools } from '@heavstaltech/api';
import fs from 'fs';

// 1. English (Default)
const buffer = await tools.tts("Hello World", "en");

// 2. Other Languages (e.g., Japanese 'ja', Spanish 'es')
const bufferJP = await tools.tts("Konnichiwa", "ja");

fs.writeFileSync("voice.mp3", buffer);

5. Image Makers (Ephoto360 - Temporarily Unavailable)

Generate high-quality text effects like Glitch, Neon, and Gold.

Supported Styles: glitchtext, writetext, advancedglow, typographytext, pixelglitch, neonglitch, flagtext, flag3dtext, deletingtext, blackpinkstyle, glowingtext, underwatertext, logomaker, cartoonstyle, papercutstyle, watercolortext, effectclouds, blackpinklogo, gradienttext, summerbeach, luxurygold, multicoloredneon, sandsummer, galaxywallpaper, 1917style, makingneon, royaltext, freecreate, galaxystyle, lighteffects

import { tools } from '@heavstaltech/api';

const imageUrl = await tools.ephoto("glitchtext", "Heavstal Tech");
console.log(imageUrl);
// Output: https://en.ephoto360.com/....jpg

Lyrics Search

Fetch song lyrics and metadata. Uses a robust multi-source engine (LRCLIB + Genius).

import { search } from '@heavstaltech/api';

const song = await search.lyrics("Kendrick Lamar DNA");

console.log(`Title: ${song.title}`);
console.log(`Artist: ${song.artist}`);
console.log(`Lyrics:\n${song.lyrics}`);

Zip to Text Extractor

Download a remote ZIP file, extract recursively, and compile to a single text buffer.

import { tools } from '@heavstaltech/api';
import fs from 'fs';

// Option 1: Text Only (Best for LLMs - Skips Images/PDFs)
const result = await tools.unzip("https://github.com/user/repo/archive/main.zip", {
  includeBinary: false
});

// Option 2: Include Everything (Base64 encoded binary files)
const fullBackup = await tools.unzip("https://github.com/user/repo/archive/main.zip", {
  includeBinary: true
});

fs.writeFileSync(result.filename, result.buffer);

APK Downloader (Android)

Search for Android apps and get direct high-speed download links along with version metadata.

import { search } from '@heavstaltech/api';

const app = await search.apk("WhatsApp");

console.log(`Name: ${app.name}`);
console.log(`Version: ${app.version}`);
console.log(`Size: ${app.size}`);
console.log(`Download Link: ${app.dl_url}`);

---

📝 License

This project is licensed under the MIT License.

---

Maintained by HEAVSTAL TECH

Building Tomorrow's Web, Today.