# Spoo.me Docs

## Docs

- [API Keys](https://docs.spoo.me/api-keys.md): Learn how to create and manage API keys for programmatic access to Spoo.me
- [Get URL Statistics](https://docs.spoo.me/api-reference/analytics/get-url-statistics.md): This endpoint allows you to retrieve comprehensive statistics about a shortened URL, including click analytics, browser data, geographical information, and more.
- [Batch QR](https://docs.spoo.me/api-reference/batch/batch-qr.md): Generate up to 20 QR codes in one request. Returns a ZIP archive.
- [Export URL Data](https://docs.spoo.me/api-reference/data-export/export-url-data.md): This endpoint allows you to export comprehensive data of your shortened URL in multiple formats. The response contains raw data in the specified format.
- [Delete URL](https://docs.spoo.me/api-reference/link-management/delete-url.md): Delete a URL permanently.
- [List Your URLs](https://docs.spoo.me/api-reference/link-management/list-your-urls.md): List all URLs owned by the authenticated user.
- [Update URL](https://docs.spoo.me/api-reference/link-management/update-url.md): Update an existing URL's properties.
- [Update URL Status](https://docs.spoo.me/api-reference/link-management/update-url-status.md): Update only the status of a URL (ACTIVE / INACTIVE).
- [Classic QR](https://docs.spoo.me/api-reference/qr-code-generation/classic-qr.md): Generate a QR code with solid fill and background colors.
- [Classic QR + Logo](https://docs.spoo.me/api-reference/qr-code-generation/classic-qr-+-logo.md): Same as GET, plus an optional logo image file to embed in the center.
- [Gradient QR](https://docs.spoo.me/api-reference/qr-code-generation/gradient-qr.md): Generate a QR code with gradient coloring. PNG output only.
- [Gradient QR + Logo](https://docs.spoo.me/api-reference/qr-code-generation/gradient-qr-+-logo.md): Same as GET, plus an optional logo image file to embed in the center.
- [Shorten Long URLs](https://docs.spoo.me/api-reference/shorten-url.md): This endpoint allows you to shorten a URL. The request payload must contain the URL to be shortened, along with optional parameters for customization.
- [Export Statistics](https://docs.spoo.me/api-reference/statistics/export-statistics.md): Export URL click statistics as a downloadable file.
- [URL Statistics](https://docs.spoo.me/api-reference/statistics/url-statistics.md): Get click statistics for URLs.
- [Create Emoji URLs](https://docs.spoo.me/api-reference/url-shortening/create-emoji-urls.md): Spoo.me provides the ability to shorten URLs with custom emojis, creating fun and memorable shortened links.
- [Create Shortened URL](https://docs.spoo.me/api-reference/url-shortening/create-shortened-url.md): Create a new shortened URL.
- [Introduction](https://docs.spoo.me/introduction.md)
- [spoo-qr](https://docs.spoo.me/qr/introduction.md): Generate styled QR codes with the spoo-qr API
- [Quick Start](https://docs.spoo.me/quickstart.md): Get started with the Spoo.me API in minutes
- [API Rate Limits](https://docs.spoo.me/rate-limits.md): Understanding Spoo.me API rate limits and best practices
- [Cloud Deployment](https://docs.spoo.me/self-hosting/cloud-deployment.md)
- [Creating Discord Webhooks](https://docs.spoo.me/self-hosting/creating-discord-webhooks.md)
- [Docker Deployment](https://docs.spoo.me/self-hosting/docker-deployment.md): The easiest way to deploy Spoo.me locally with MongoDB and Redis bundled
- [Introduction](https://docs.spoo.me/self-hosting/introduction.md)
- [Local Development Setup](https://docs.spoo.me/self-hosting/local-development.md): Set up spoo.me for local development with Docker or manual installation
- [Setting Up Authentication](https://docs.spoo.me/self-hosting/setting-up-authentication.md): Configure JWT tokens and OAuth providers for user authentication
- [Setting Up MongoDB](https://docs.spoo.me/self-hosting/setting-up-mongo.md)
- [Setting Up Redis (Optional)](https://docs.spoo.me/self-hosting/setting-up-redis.md)
- [GitHub Action](https://docs.spoo.me/tools/github-action.md)
- [Spoo.me Python SDK](https://docs.spoo.me/tools/python-library.md)
- [SpooBot](https://docs.spoo.me/tools/spoobot.md)

## OpenAPI Specs

- [openapi-v0](https://docs.spoo.me/openapi-v0.json)
- [openapi-qr](https://docs.spoo.me/openapi-qr.json)
- [openapi-v1](https://docs.spoo.me/openapi-v1.json)