API - Gcut URL Shortener

API Key

Your API Key:

Keep your API key secure and never share it publicly

API Endpoints

POST https://api.gcut.in/v1/shorten

Shorten a long URL into a short link. Returns the shortened URL with analytics data.

Parameter	Type	Required	Description
`url`	string	Yes	The long URL to be shortened
`custom_code`	string	No	Custom short code (alphanumeric, 3-20 characters)
`expires_at`	string	No	Expiration date (ISO 8601 format, e.g., "2024-12-31T23:59:59Z")

Example Request:

{ "url": "https://example.com/very/long/url/path", "custom_code": "my-link", "expires_at": "2024-12-31T23:59:59Z" }

Example Response:

{ "success": true, "data": { "short_url": "https://gcut.in/my-link", "original_url": "https://example.com/very/long/url/path", "short_code": "my-link", "clicks": 0, "created_at": "2024-01-15T10:30:00Z", "expires_at": "2024-12-31T23:59:59Z" } }

GET https://api.gcut.in/v1/stats/{short_code}

Get analytics and statistics for a shortened URL including click counts, location data, and device information.

Parameter	Type	Required	Description
`short_code`	string	Yes	The short code in the URL path (e.g., "GW01")

Example Request:

GET https://api.gcut.in/v1/stats/GW01 Headers: Authorization: Bearer gcut_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Example Response:

{ "success": true, "data": { "short_code": "GW01", "short_url": "https://gcut.in/GW01", "original_url": "https://example.com/very/long/url/path", "total_clicks": 143, "created_at": "2024-01-15T10:30:00Z", "expires_at": null, "is_active": true } }

GET https://api.gcut.in/v1/urls

Get a list of all your shortened URLs with pagination support.

Parameter	Type	Required	Description
`page`	integer	No	Page number (default: 1)
`limit`	integer	No	Items per page (default: 10, max: 100)
`status`	string	No	Filter by status: "active", "inactive", "expired"

Example Request:

GET https://api.gcut.in/v1/urls?page=1&limit=10&status=active Headers: Authorization: Bearer gcut_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Authentication

All API requests require authentication using your API key. Include your API key in the request headers using the Bearer token format.

Authorization Header:

Authorization: Bearer gcut_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Rate Limits

API requests are rate-limited to ensure fair usage. Current limits are:

Plan	Requests per Minute	Requests per Day
Free	10	1,000
Premium	100	100,000
Enterprise	Unlimited	Unlimited

API Documentation