This repository contains the official API documentation for spoo.me - a lightning-fast URL shortening service built for scale.

Spoo.me provides a comprehensive API for:

• 🔗 URL shortening with custom aliases
• 📊 Advanced analytics with filtering and grouping
• 🔑 API key authentication for higher rate limits
• 🔐 Password protection and click limits
• 🤖 Bot blocking capabilities
• ⚙️ Full URL management (list, update, delete)
• 😉 Emoji-based shortened URLs (v0 legacy)
• 📤 Data export in multiple formats (v0 legacy)

Base URLs:

• API v1 (Recommended): https://spoo.me/api/v1
• API v0 (Legacy): https://spoo.me

• Complete API Reference - v1 and v0 (legacy) endpoints with code examples
• API Keys Guide - Authentication and scoped permissions
• Rate Limiting Guide - 3x higher limits with authentication
• URL Management - List, update, and delete endpoints
• Advanced Analytics - Flexible filtering, grouping, and aggregation
• Python Library - Official py_spoo_url SDK documentation
• GitHub Action - CI/CD integration for testing
• Self-Hosting Guide - Complete deployment documentation

Install the Mintlify CLI to preview documentation changes locally:

npm i -g mintlify

Run the following command at the root of the documentation directory:

mintlify dev

This will start a local development server where you can preview your changes in real-time.

spoo-docs/
├── docs.json              # Main configuration
├── introduction.mdx       # Homepage
├── quickstart.mdx         # Quick start guide
├── rate-limits.mdx        # Rate limiting documentation
├── api-reference/         # API endpoint documentation
│   ├── shorten-url.mdx
│   ├── emoji-url.mdx
│   ├── url-statistics.mdx
│   └── export-data.mdx
└── tools/                 # Tools and integrations
    ├── python-library.mdx
    └── spoobot.mdx

Changes are automatically deployed to production when pushed to the main branch through our Mintlify integration.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes and test locally with mintlify dev
4. Commit your changes (git commit -m 'Add amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

• Documentation Issues: Open an issue in this repository
• API Support: Contact [email protected]
• Discord Community: Join our Discord server

Mintlify dev isn't running

mintlify install  # Re-install dependencies

Page loads as 404

• Ensure you're running in the folder containing docs.json
• Check that the page exists in the navigation configuration

Build issues

• Verify all .mdx files have proper frontmatter
• Check for syntax errors in code blocks
• Ensure all internal links are valid

Built with ❤️ using Mintlify