URL Redirect Tracker API Documentation

This API allows you to programmatically track and analyze URL redirect chains with detailed information.

Rate Limiting

The API is limited to 100 requests per hour per IP address.

Endpoints

POST /api/v1/track

Track a URL and get the full redirect chain using a POST request.

Request Parameters (JSON Body)

Parameter Type Required Description
url string Yes The URL to track (e.g., "example.com")
method string No HTTP method (GET, HEAD, POST). Default: "GET"
userAgent string No Custom User-Agent header

Example Request

curl -X POST http://localhost:3333/api/v1/track \
  -H "Content-Type: application/json" \
  -d '{
    "url": "github.com",
    "method": "GET"
  }'
  

GET /api/v1/track

Track a URL and get the full redirect chain using a GET request with query parameters.

Request Parameters (Query String)

Parameter Type Required Description
url string Yes The URL to track (e.g., "example.com")
method string No HTTP method (GET, HEAD, POST). Default: "GET"
userAgent string No Custom User-Agent header

Example Request

curl "http://localhost:3333/api/v1/track?url=github.com&method=GET"
  

Response Format

{
  "success": true,
  "status": 200,
  "data": {
    "url": "http://github.com",
    "method": "GET",
    "redirectCount": 1,
    "finalUrl": "https://github.com/",
    "finalStatusCode": 200,
    "redirects": [
      // Array of redirect objects with detailed information
    ]
  }
}
  

Back to URL Redirect Tracker