Shorten Your Url not Your Possibilities π
π₯ Features π Endpoints π οΈ API Docs π Getting Started π€ Contributing
spoo.me is a free, open-source service for shortening URLs. It offers URL statistics, a free API, and customization options. You can create custom slugs
, add password protection
, and manage link lifespans
.
Custom Slugs
- Create custom slugs for your URLs π―Emoji Slugs
- Use emojis as slugs for your URLs πPassword Protection
- Protect your URLs with a password πLink Max Clicks
- Set a maximum number of clicks for your URLs πURL Statistics
- View detailed statistics for your URLs πBOT Tracking
- Track bot clicks on your URLs π€API
- A free and open-sourced API for URL shortening and statistics π οΈExport Click Data
- Export click data as a CSV, JSON, XLSX, or XML file π€Open Source
- spoo.me is open-sourced and free to use πAbsolutely Free
- No hidden costs, no premium plans, no limitations πΈNo Registration
- No need to register an account to use spoo.me πSelf Hosting
- You can host spoo.me on your own server π
The basic structure for accessing a shortened URL is: https://spoo.me/<short_code>
Example - https://spoo.me/ga
For password-protected URLs, use the same basic structure. This redirects to a password entry page.
Example - https://spoo.me/exa
Password - Example@12
Tip
Bypass the password entry page by appending the password to the URL parameters - https://spoo.me/<short_code>?password=<password>
To view the statistics for a URL, use the following structure: https://spoo.me/stats/<short_code>
Example - https://spoo.me/stats/ga
Note
You won't be able to view statistics for a password-protected page unless you provide its password.
Spoo.me offers a free, open-source API for URL shortening and statistics. Check it out below:
spoo.me API |
---|
To self-host spoo.me on your server, follow the this detailed guide:
Self-Hosting Guide π |
---|
Expand this for a Quick Start
- Docker π³
git clone https://github.com/spoo-me/url-shortener.git
mv .env.example .env
MONGODB_URI=<your_MONGODB_URI>
CONTACT_WEBHOOK=<valid_webhook_URI>
URL_REPORT_WEBHOOK=<valid_webhook_URI>
[!NOTE] With this method, you can either use a cloud service like MongoDB Atlas to store the data remotely or you can use a local MongoDB instance. If you want to use a local MongoDB instance, your MongoDB URI would be
mongodb:https://localhost:27017/
.
docker-compose up
- MongoDB πΏ
- MongoDB is only required if you want to store the data locally. You can also use a cloud service like MongoDB Atlas to store the data remotely.
- Python π
- PIP π¦
- Virtualenv (Optional) π
git clone https://github.com/spoo-me/url-shortener.git
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
mv .env.example .env
MONGODB_URI=<your_MONGODB_URI>
CONTACT_WEBHOOK=<valid_webhook_URI>
URL_REPORT_WEBHOOK=<valid_webhook_URI>
[!NOTE] If you installed MongoDB locally, your MongoDB URI would be
mongodb:https://localhost:27017/
or if you are using MongoDB Atlas, you can find your MongoDB URI in the Connect tab of your cluster.
python main.py
Open your browser and go to https://localhost:8000
to access the spoo.me URL shortener.
Contributions are always welcome! π Here's how you can contribute:
- Bugs are logged using the github issue system. To report a bug, simply open a new issue.
- Follow the contribution guidelines to get started.
- Make a pull request for any feature or bug fix.
Important
For any type of support or queries, feel free to reach out to us at βοΈ [email protected]
Main Page
Result Page
Stats Page
API Page