Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prakhardoneria/soundcloud-search-api
This Flask server provides a simple endpoint to search for tracks on SoundCloud using the SoundCloud Search API. It allows users to make GET requests with search queries to retrieve relevant tracks from SoundCloud's vast collection.
https://github.com/prakhardoneria/soundcloud-search-api
flask flask-api music python3 soundcloud soundcloud-api
Last synced: 29 days ago
JSON representation
This Flask server provides a simple endpoint to search for tracks on SoundCloud using the SoundCloud Search API. It allows users to make GET requests with search queries to retrieve relevant tracks from SoundCloud's vast collection.
- Host: GitHub
- URL: https://github.com/prakhardoneria/soundcloud-search-api
- Owner: PrakharDoneria
- Created: 2024-05-27T12:50:11.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T04:46:51.000Z (8 months ago)
- Last Synced: 2024-12-11T22:31:06.689Z (about 1 month ago)
- Topics: flask, flask-api, music, python3, soundcloud, soundcloud-api
- Language: Python
- Homepage: https://music-search-api.vercel.app
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SoundCloud Search API - Flask Server
This Flask server provides endpoints to search for tracks on SoundCloud using the SoundCloud Search API.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- Python 3.x
- pip
### Installation
1. Clone the repository:
```bash
git clone https://github.com/prakhardoneria/SoundCloud-Search.git
```
2. Navigate into the project directory:
```bash
cd SoundCloud-Search
```
3. Install dependencies:
```bash
pip install -r requirements.txt
```
### Usage
1. Set the SoundCloud client ID as an environment variable:
```bash
export SOUNDCLOUD_CLIENT_ID=your_soundcloud_client_id
```
2. Run the Flask app:
```bash
python main.py
```
3. Make GET requests to the endpoints with the `q` parameter to search for tracks on SoundCloud.
#### `/search` Endpoint
Make a GET request to the `/search` endpoint to search for tracks:
Example:
```bash
curl http://localhost:5000/search?q=khamo
```
Sample Response:
```json
{
"collection": [
{
"output": "khamoshiyan arjit singh",
"query": "khamoshiyan arjit singh"
},
...
],
...
}
```
#### `/searchOne` Endpoint
Make a GET request to the `/searchOne` endpoint to get the first suggestion:
Example:
```bash
curl http://localhost:5000/searchOne?q=khamo
```
Sample Response:
```json
{
"suggestion": "khamoshiyan arjit singh"
}
```
If no suggestions are found:
```json
{
"suggestion": null
}
```
### Environment Variables
- `SOUNDCLOUD_CLIENT_ID`: Your SoundCloud API client ID.
### Endpoints
1. **/search**: Returns a list of search suggestions for the given query.
- **URL**: `/search`
- **Method**: `GET`
- **Query Parameter**: `q` (The search query)
2. **/searchOne**: Returns the first search suggestion for the given query.
- **URL**: `/searchOne`
- **Method**: `GET`
- **Query Parameter**: `q` (The search query)
### Sample Usage
#### `/search` Endpoint
```bash
curl http://localhost:5000/search?q=khamo
```
#### `/searchOne` Endpoint
```bash
curl http://localhost:5000/searchOne?q=khamo
```