https://github.com/abdipr/myinstants-api
MyInstants Unofficial REST API
https://github.com/abdipr/myinstants-api
api json myinstants php rest-api simplehtmlphp soundboard
Last synced: 24 days ago
JSON representation
MyInstants Unofficial REST API
- Host: GitHub
- URL: https://github.com/abdipr/myinstants-api
- Owner: abdipr
- License: mit
- Created: 2024-11-02T00:49:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-14T09:02:09.000Z (5 months ago)
- Last Synced: 2025-02-14T14:43:29.411Z (3 months ago)
- Topics: api, json, myinstants, php, rest-api, simplehtmlphp, soundboard
- Language: PHP
- Homepage: https://myinstants-api.vercel.app
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MyInstants REST API
A RESTful API for scraping and retrieving sound data from the MyInstants website. This API provides endpoints for retrieving information about sounds, including titles, URLs, descriptions, tags, favorites, views, and uploader details.
## ✨ Support
If you like this project, please star on this repository, thank you ⭐
You can support me by:
## Table of Contents
- [Getting Started](#-getting-started)
- [Introduction](#introduction)
- [Requirements](#requirements)
- [Installation](#installation)
- [Reference](#%EF%B8%8F-reference)
- [Endpoints](#endpoints)
- [Request Parameters](#request-parameters)
- [Response Parameters](#response-parameters)
- [Error Handling](#-error-handling)
- [Examples](#-examples)
- [Example 1: Trending](#example-1-get-trending-sounds-by-region)
- [Example 2: Search](#example-2-search-sounds-by-query)
- [Example 3: Detail](#example-3-get-sound-details-by-id)
- [Example 4: Recent](#example-4-get-recently-uploaded-sounds)
- [Example 5: Best of All Time](#example-5-get-best-of-all-time-sounds)
- [Example 6: Uploaded](#example-6-get-users-uploaded-sounds)
- [Example 7: Favorites](#example-7-get-users-favorite-sounds)
- [Contributing](#-contributing)
- [License](#%EF%B8%8F-license)
- [Disclaimer](#%EF%B8%8F-disclaimer)
## 🚀 Getting Started
### Introduction
The MyInstants REST API is designed to provide a structured way to retrieve sound data from the MyInstants website. This API is suitable for applications that need to access sound information dynamically without direct interactions with the MyInstants site.
### Requirements
- PHP 7.4 or higher
- [simple_html_dom.php](https://simplehtmldom.sourceforge.io/) library for HTML parsing
- Internet access for scraping the MyInstants website
### Installation
1. Clone the repository to your server:
```bash
git clone https://github.com/abdipr/myinstants-api.git
cd myinstants-api
```
2. Download and include `simple_html_dom.php` in the project directory.
3. Set up your server to serve PHP files (e.g., Apache or Nginx).
4. Or, you can deploy directly to Vercel here
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fabdipr%2Fmyinstants-api%2F&redirect-url=https%3A%2F%2Fgithub.com%2Fabdipr%2Fmyinstants-api%2F)
## ❇️ Reference
### Endpoints
Base URL: https://myinstants-api.vercel.app
| Request | Response | Parameter |
| :--------------------------------- | :------------------------ | :-------: |
| `GET /trending` | Trending based region | `q` |
| `GET /search` | Search a sound | `q` |
| `GET /detail` | The sound details | `id` |
| `GET /recent` | Recently uploaded sounds | |
| `GET /best` | Best of all time sounds | |
| `GET /uploaded` | User's uploaded sounds | `username`|
| `GET /favorites` | User's favorite sounds | `username`|
### Request Parameters
| Parameter | Description |
| :-------: | :---------------------- |
| `q` | Search query or region |
| `username`| User's username |
| `id` | Sound's Unique ID |
### Response Parameters
| Parameter | Description |
| :------------ | :------------------------------------------------------------------------- |
| `id` | Unique ID of the sound. |
| `url` | Direct URL to the sound page. |
| `title` | Title of the sound. |
| `mp3` | Direct URL to the MP3 file. |
| `description` | Description of the sound. |
| `tags` | Array of tags associated with the sound. |
| `favorites` | Number of users who favorited the sound. |
| `views` | View count of the sound. |
| `uploader` | Details about the uploader, including the uploader’s name and profile URL. |
## 💥 Error Handling
All errors return JSON objects with a `status` code and `message` explaining the issue.
- **404 Error**:
- When the page is not found or the query parameter is missing.
```json
{
"status": "404",
"author": "abdiputranar",
"message": "Page not found"
}
```
## 🌐 Examples
### Example 1: Get Trending Sounds by Region
Retrieve trending sounds based on a specified region:
```http
GET https://myinstants-api.vercel.app/trending?q=id
```
### Example 2: Search Sounds by Query
Search for sounds using a specific keyword:
```http
GET https://myinstants-api.vercel.app/search?q=laugh
```
### Example 3: Get Sound Details by ID
Retrieve the details of a sound using its unique ID:
```http
GET https://myinstants-api.vercel.app/detail?id=akh-26815
```
### Example 4: Get Recently Uploaded Sounds
Retrieve a list of the most recently uploaded sounds:
```http
GET https://myinstants-api.vercel.app/recent
```
### Example 5: Get Best of All Time Sounds
Retrieve a list of the most popular sounds of all time:
```http
GET https://myinstants-api.vercel.app/best
```
### Example 6: Get User's Uploaded Sounds
Retrieve all sounds uploaded by a specific user:
```http
GET https://myinstants-api.vercel.app/uploaded?username=hellmouz
```
### Example 7: Get User's Favorite Sounds
Retrieve a list of sounds favorited by a specific user:
```http
GET https://myinstants-api.vercel.app/favorites?username=hellmouz
```
### Notes
- **`q` Parameter**: Used for searching or specifying the region for trending sounds.
- **`id` Parameter**: Unique identifier for accessing sound details.
- **`username` Parameter**: User's profile name for accessing their uploads or favorites.
## 🌱 Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a feature branch: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m 'Add feature'`.
4. Push to the branch: `git push origin feature-name`.
5. Submit a pull request.
## ⚖️ License
This project is licensed under the `MIT License`. See the [LICENSE](https://github.com/abdipr/myinstants-api/blob/main/LICENSE) file for more information.
## ⚠️ Disclaimer
The sounds contained in this API are obtained from the original [MyInstants](https://www.myinstants.com) website by web scraping. Developers using this API must follow the applicable regulations by mentioning this project or the official owner in their projects and are prohibited from abusing this API for personal benefits.
[⬆️ Back to Top](#myinstants-rest-api)