Developer REST API & Rate Limits
Integrate URL shortening, unshortening security analysis, live polls, reactive forms, and QR generation directly into your apps and AI agents.
Rate Limiting & Quota Policy
To guarantee high availability and fair usage, all REST and MCP endpoints are protected by millisecond-precision sliding window rate limiting.
To access REST API endpoints, membership and a valid API key (Bearer or X-API-Key) are strictly required. Unauthenticated requests are rejected with HTTP 401.
Authenticated API keys and member accounts receive a high-speed quota of 120 to 300 requests per 1-minute sliding window.
Standard HTTP Rate Limit Headers
| Header | Description | Sample Value |
|---|---|---|
| X-RateLimit-Limit | Total allowed requests in the current sliding window | 120 |
| X-RateLimit-Remaining | Remaining request allowance until window reset | 119 |
| X-RateLimit-Reset | Unix timestamp when the window resets (seconds) | 1760618400 |
| Retry-After | Seconds to wait before retrying after HTTP 429 | 42 |
{
"success": false,
"error": "API key or membership is required to access the REST API. Please sign in or pass an API key.",
"code": "API_KEY_REQUIRED"
}
{
"success": false,
"error": "Rate limit exceeded. Try again in 42 seconds.",
"retryAfter": 42,
"limit": 120
}
{
"jsonrpc": "2.0",
"id": "req-1",
"error": {
"code": -32000,
"message": "Rate limit exceeded. Try again in 42 seconds."
}
}
Authentication
Membership and a valid API key are required to access all REST API endpoints. You can pass your API key in HTTP requests using either of the following formats:
REST API v1 Endpoints
All endpoints accept and return JSON payloads.
API Discovery & Rate Limit Status
Returns API version, client IP / authentication state, and current sliding window rate limit quotas.
curl -X GET "https://imup.cc/api/v1" \
-H "Authorization: Bearer YOUR_API_KEY"
Create Short Link
Shortens a long target URL with optional custom slug, password, title, and expiration.
curl -X POST "https://imup.cc/api/v1/links" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target_url": "https://example.com/very-long-url", "title": "My Link"}'
Get Link Details & Stats
Retrieves link details, destination URL, active status, creation date, and total click counter.
curl -X GET "https://imup.cc/api/v1/links/LINK_ID" \
-H "Authorization: Bearer YOUR_API_KEY"
Update Short Link
Updates destination target URL, status (active/inactive), and title.
curl -X PATCH "https://imup.cc/api/v1/links/LINK_ID" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target_url": "https://example.com/updated-url"}'
Delete Short Link
Permanently removes a short link from the registry.
curl -X DELETE "https://imup.cc/api/v1/links/LINK_ID" \
-H "Authorization: Bearer YOUR_API_KEY"
Unshorten & Security Analysis
Resolves redirect chains for any shortened URL, validates safety, and strips UTM/tracking params.
curl -X POST "https://imup.cc/api/v1/links/unshorten" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://bit.ly/3xyz?utm_source=test"}'
Bulk Shorten Links
Creates up to 50 short links in a single atomic transaction. Rate limit cost equals number of URLs.
curl -X POST "https://imup.cc/api/v1/links/bulk" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"urls": ["https://site1.com", "https://site2.com"]}'
Create Live Poll
Creates a real-time polling widget with custom question and up to 10 choices.
curl -X POST "https://imup.cc/api/v1/polls" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Favorite stack?", "options": ["Node.js", "Next.js", "Django"]}'
Get Poll & Live Results
Retrieves poll questions, option vote counts, and calculated percentage distribution.
curl -X GET "https://imup.cc/api/v1/polls/POLL_UUID" \
-H "Authorization: Bearer YOUR_API_KEY"
Cast Poll Vote
Submits a vote for a specific option ID with anti-ballot stuffing validation.
curl -X POST "https://imup.cc/api/v1/polls/POLL_UUID/vote" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"option_ids": [1]}'
Create Reactive Form
Creates a custom form with flexible fields (text, email, select, rating, textarea).
curl -X POST "https://imup.cc/api/v1/forms" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Customer Feedback", "description": "Quick survey"}'
Get Form Schema & Stats
Fetches form fields, configuration, status, and response counts.
curl -X GET "https://imup.cc/api/v1/forms/FORM_UUID" \
-H "Authorization: Bearer YOUR_API_KEY"
Submit Form Response
Submits validated answers for form fields with optional idempotency key.
curl -X POST "https://imup.cc/api/v1/forms/FORM_UUID/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"answers": {"FIELD_ID_1": "Ahmet", "FIELD_ID_2": "user@example.com"}}'
Generate QR Code
Generates high-resolution QR codes in PNG (binary), SVG (vector), or JSON (base64 data URL).
curl -X GET "https://imup.cc/api/v1/qr?text=https://imup.cc&format=png&size=300" \
-H "Authorization: Bearer YOUR_API_KEY" --output qr.png
Model Context Protocol (MCP) Endpoint
JSON-RPC 2.0 endpoint for AI assistants (Claude Desktop, Cursor, Windsurf) featuring 14 native tools. Governed by identical sliding window rate limits.
curl -X POST "https://imup.cc/api/mcp" \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "id": "1", "method": "tools/list"}'
MCP Server for AI Agents
Manage short links, polls, and forms directly from Cursor, Claude Desktop, or Windsurf. Protected by the same high-speed sliding window rate limits.