https://github.com/neofetchnpc/cobalt-pkg
Source Of code3-dev
https://github.com/neofetchnpc/cobalt-pkg
Last synced: 12 days ago
JSON representation
Source Of code3-dev
- Host: GitHub
- URL: https://github.com/neofetchnpc/cobalt-pkg
- Owner: NeofetchNpc
- License: mit
- Created: 2025-01-21T11:43:15.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-01-21T12:11:07.000Z (4 months ago)
- Last Synced: 2025-02-23T21:26:15.313Z (3 months ago)
- Language: JavaScript
- Homepage: https://github.com/code3-dev/CobaltAPI.git
- Size: 30.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cobalt API Node.js
A Node.js library for downloading videos and audio from YouTube, TikTok, Twitter, and more. Powered by [Cobalt](https://github.com/imputnet/cobalt).
[](https://github.com/imputnet/cobalt)
**Powered by [Cobalt](https://github.com/imputnet/cobalt)**
This library relies on Cobalt’s free API.
- **Cobalt Code:** [GitHub Repository](https://github.com/imputnet/cobalt)
- **Cobalt Site:** [Cobalt Tools](https://cobalt.tools/)
- **Cobalt API Docs:** [API Documentation](https://github.com/imputnet/cobalt/blob/current/docs/api.md)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Methods](#methods)
- [Response Body Variables](#response-body-variables)
- [Picker Item Variables](#picker-item-variables)
- [Supported Services](#supported-services)
- [License](#license)
- [Contact](#contact)
## Installation
To install the `cobalt-api` library, you need to use npm. Run the following command:
```bash
npm install ness-cobalt
```
## Usage
After installing the library, you can start using it in your Node.js project. Here's a basic example:
```javascript
const CobaltAPI = require("ness-cobalt");
const cobalt = new CobaltAPI("https://www.youtube.com/watch?v=OAr6AIvH9VY");
cobalt
.sendRequest()
.then((response) => {
if (response.status) {
console.log("Download successful", response.data);
} else {
console.log("Download failed", response.text);
}
})
.catch((error) => console.error("Error:", error));
```
## Methods
### `constructor(url: string)`
Initializes the `CobaltAPI` class with a URL.
- **Parameters:**
- `url` (string): The URL to be used in requests.
### `setQuality(quality: string): void`
Sets the video quality for downloads.
- **Parameters:**
- `quality` (string): The desired video quality (e.g., `144`, `720`, `max`).
- **Throws:**
- `Error` if the provided quality is not valid.
### `setFilenamePattern(pattern: string): void`
Sets the filename pattern for downloaded files.
- **Parameters:**
- `pattern` (string): The desired filename pattern. Available patterns: **classic**, **basic**, **pretty**, **nerdy**.
- **Throws:**
- `Error` if the provided pattern is not valid.
### `setVCodec(codec: string): void`
Sets the video codec for downloads.
- **Parameters:**
- `codec` (string): The desired video codec (e.g., `h264`, `av1`, `vp9`).
- **Throws:**
- `Error` if the provided codec is not valid.
### `setAFormat(format: string): void`
Sets the audio format for downloads.
- **Parameters:**
- `format` (string): The desired audio format (e.g., `mp3`, `ogg`, `wav`).
- **Throws:**
- `Error` if the provided format is not valid.
### `setAcceptLanguage(language: string): void`
Sets the custom Accept-Language header value for requests.
- **Parameters:**
- `language` (string): The custom Accept-Language header value.
### `enableAudioOnly(): void`
Enables downloading only audio.
### `enableTTFullAudio(): void`
Enables downloading the original sound from a TikTok video.
### `enableAudioMuted(): void`
Enables muting the audio track in video downloads.
### `enableDubLang(): void`
Enables using the Accept-Language header for YouTube video audio tracks.
### `enableDisableMetadata(): void`
Enables disabling file metadata.
### `enableTwitterGif(): void`
Enables converting Twitter gifs to .gif format.
### `enableTiktokH265(): void`
Enables preferring 1080p h265 videos for TikTok.
### `sendRequest(): Promise`
Sends the configured request to the API and returns the response.
- **Returns:**
- A promise that resolves to an object containing the status and data of the response.
- **Throws:**
- `Error` if there is an error in sending the request.
### `getAvailableQualities(): Promise>`
Fetches the available video qualities for a YouTube URL.
- **Returns:**
- A promise that resolves to an array of available video qualities.
- **Throws:**
- `Error` if the URL is invalid or fetching qualities fails.
## Response Body Variables
| key | type | variables |
| :----------- | :------- | :---------------------------------------------------------- |
| `status` | `string` | `error / redirect / stream / success / rate-limit / picker` |
| `text` | `string` | various text, mostly used for errors |
| `url` | `string` | direct link to a file or a link to cobalt's live render |
| `pickerType` | `string` | `various / images` |
| `picker` | `array` | array of picker items |
| `audio` | `string` | direct link to a file or a link to cobalt's live render |
Source: [Cobalt API Documentation - Response Body Variables](https://github.com/imputnet/cobalt/blob/current/docs/api.md#response-body-variables)
## Picker Item Variables
item type: `object`
| key | type | variables | description |
| :------ | :------- | :------------------------------------------------------ | :------------------------------------- |
| `type` | `string` | `video / photo / gif` | used only if `pickerType` is `various` |
| `url` | `string` | direct link to a file or a link to cobalt's live render | |
| `thumb` | `string` | item thumbnail that's displayed in the picker | used for `video` and `gif` types |
Source: [Cobalt API Documentation - Picker Item Variables](https://github.com/imputnet/cobalt/blob/current/docs/api.md#picker-item-variables)
## Supported Services
This list is not final and keeps expanding over time.
| service | video + audio | only audio | only video | metadata | rich file names |
| :----------------------------- | :-----------: | :--------: | :--------: | :------: | :-------------: |
| bilibili.com & bilibili.tv | ✅ | ✅ | ✅ | ➖ | ➖ |
| dailymotion | ✅ | ✅ | ✅ | ✅ | ✅ |
| instagram posts & reels | ✅ | ✅ | ✅ | ➖ | ➖ |
| facebook videos | ✅ | ❌ | ❌ | ➖ | ➖ |
| loom | ✅ | ❌ | ✅ | ✅ | ➖ |
| ok video | ✅ | ❌ | ✅ | ✅ | ✅ |
| pinterest | ✅ | ✅ | ✅ | ➖ | ➖ |
| reddit | ✅ | ✅ | ✅ | ❌ | ❌ |
| rutube | ✅ | ✅ | ✅ | ✅ | ✅ |
| snapchat stories & spotlights | ✅ | ✅ | ✅ | ➖ | ➖ |
| soundcloud | ➖ | ✅ | ➖ | ✅ | ✅ |
| streamable | ✅ | ✅ | ✅ | ➖ | ➖ |
| tiktok | ✅ | ✅ | ✅ | ❌ | ❌ |
| tumblr | ✅ | ✅ | ✅ | ➖ | ➖ |
| twitch clips | ✅ | ✅ | ✅ | ✅ | ✅ |
| twitter/x | ✅ | ✅ | ✅ | ➖ | ➖ |
| vimeo | ✅ | ✅ | ✅ | ✅ | ✅ |
| vine archive | ✅ | ✅ | ✅ | ➖ | ➖ |
| vk videos & clips | ✅ | ❌ | ✅ | ✅ | ✅ |
| youtube videos, shorts & music | ✅ | ✅ | ✅ | ✅ | ✅ |
| emoji | meaning |
| :---: | :---------------------- |
| ✅ | supported |
| ➖ | impossible/unreasonable |
| ❌ | not supported |
Source: [Cobalt - Supported Services](https://github.com/imputnet/cobalt#supported-services)
### Additional Notes or Features
| service | notes or features |
| :--------- | :------------------------------------------------------------------------------------------------------------------- |
| instagram | Supports reels, photos, and videos. Lets you pick what to save from multi-media posts. |
| facebook | Supports public accessible videos content only. |
| pinterest | Supports photos, gifs, videos and stories. |
| reddit | Supports gifs and videos. |
| snapchat | Supports spotlights and stories. Lets you pick what to save from stories. |
| rutube | Supports yappy & private links. |
| soundcloud | Supports private links. |
| tiktok | Supports videos with or without watermark, images from slideshow without watermark, and full (original) audios. |
| twitter/x | Lets you pick what to save from multi-media posts. May not be 100% reliable due to current management. |
| vimeo | Audio downloads are only available for dash. |
| youtube | Supports videos, music, and shorts. 8K, 4K, HDR, VR, and high FPS videos. Rich metadata & dubs. h264/av1/vp9 codecs. |
Source: [Cobalt - Additional Notes or Features per Service](https://github.com/imputnet/cobalt#additional-notes-or-features-per-service)
If support for a service you want is missing, create an issue (or a pull request 👀) on [Cobalt's GitHub repository](https://github.com/imputnet/cobalt).
## License
This library is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contact
For any queries or issues, please contact:
- **Name:** Hossein Pira
- **Email:** [[email protected]](mailto:[email protected])
- **Instagram**: [@h3dev.pira](https://instagram.com/h3dev.pira)
- **Telegram:** [@h3dev](https://t.me/h3dev)
## References
- **Cobalt Code:** [GitHub Repository](https://github.com/imputnet/cobalt)
- **Cobalt Site:** [Cobalt Tools](https://cobalt.tools/)
- **Cobalt API Docs:** [API Documentation](https://github.com/imputnet/cobalt/blob/current/docs/api.md)