Documentation

Build with Shorten.cv

Everything you need to integrate Shorten.cv into your applications, from basic usage to advanced API features.

Getting Started

Learn the fundamentals of Shorten.cv

Quick Start Guide

Get up and running in minutes

Account Setup

Configure your account and preferences

Dashboard Overview

Navigate the main dashboard

API Reference

Complete API documentation and examples

Authentication

API keys and authentication methods

URL Shortening

Create and manage short links

Analytics API

Access detailed link analytics

Webhooks

Real-time event notifications

Advanced Features

Powerful tools and integrations

Custom Domains

Use your own domain for links

Bulk Operations

Process multiple links at once

UTM Tracking

Advanced campaign tracking

Link Expiration

Set automatic link expiration

Security & Privacy

Security best practices and compliance

Security Overview

How we protect your data

Password Protection

Secure sensitive links

GDPR Compliance

Data protection and privacy

Rate Limiting

API usage limits and quotas

SDKs & Tools

Official libraries and tools to accelerate your development

🟨

JavaScript SDK

Node.js & Browser

🐍

Python SDK

Python 3.6+

🐘

PHP SDK

PHP 7.2+

🔵

Go SDK

Go 1.16+

Quick Start Examples

Get started with Shorten.cv in minutes

JavaScript

const shorten = require('shorten-cv');

const client = new shorten.Client({
  apiKey: 'your-api-key'
});

// Create a short link
const result = await client.shorten({
  url: 'https://example.com',
  alias: 'my-link'
});

console.log(result.shortUrl);
// https://shorter.cv/my-link

Analytics

// Get link analytics
const analytics = await client.analytics('my-link');

console.log(`Clicks: ${analytics.totalClicks}`);
console.log(`Unique visitors: ${analytics.uniqueClicks}`);
console.log(`Top country: ${analytics.geographic[0]?.country}`);

// Real-time metrics
const realtime = await client.realtime();
console.log(`Active users: ${realtime.activeUsersLastHour}`);

Join the Developer Community

Connect with other developers, share your integrations, and get help from the community.