WARP Clash API

该介绍目前仅提供英文版本。

A service that converts Cloudflare WARP accounts into Clash configurations

Overview

WARP Clash API is a service designed to generate and manage Cloudflare WARP configurations for Clash, ClashX, and Clash Verge clients. It allows users to leverage Cloudflare’s WARP network through popular Clash proxy clients, offering better network performance, easier configuration, and the ability to manage multiple WARP accounts.

Key Features

• 🔄 Clash Configuration Generation: Automatically create ready-to-use Clash configuration files
• 👥 Multiple Account Support: Create and manage multiple WARP accounts
• 🚀 API Interface: Simple RESTful API for integration with other tools
• 🐳 Docker Deployment: Easy deployment using Docker and Docker Compose
• 📊 Account Statistics: Track data usage and account status
• 🌍 Global Network Access: Connect to Cloudflare’s global WARP network
• 📱 Multi-Client Support: Works with Clash, ClashX, Clash Verge, and other compatible clients
• 🔧 Customizable Settings: Configure proxies, rules, and routing preferences

How It Works

WARP Clash API functions as a bridge between Cloudflare WARP and Clash clients:

1. It registers and manages WARP accounts through Cloudflare’s API
2. Converts WARP connection details into Clash-compatible configuration format
3. Provides these configurations via a simple API endpoint
4. Allows monitoring and management of accounts through the same interface

Quick Start

Docker Installation (Recommended)

docker run -d \
  --name=warp-clash-api \
  -p 8080:8080 \
  -v ./data:/app/data \
  --restart unless-stopped \
  ghcr.io/vvbbnn00/warp-clash-api:latest

Docker Compose

version: '3'
services:
  warp-clash-api:
    container_name: warp-clash-api
    image: ghcr.io/vvbbnn00/warp-clash-api:latest
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - ./data:/app/data

Usage Examples

Get Clash Configuration

curl -X GET "http://localhost:8080/api/v1/clash/config"

This returns a complete Clash configuration file that you can save and import into your Clash client.

Create a New WARP Account

curl -X POST "http://localhost:8080/api/v1/account/create"

View Account Details

curl -X GET "http://localhost:8080/api/v1/account/{account_id}"

Why Use WARP with Clash?

1. Better Traffic Management: Clash offers powerful rules for routing traffic
2. Enhanced Privacy: WARP provides encryption and identity protection
3. Improved Network Performance: Access to Cloudflare’s optimized global network
4. Flexibility: Use WARP alongside other proxies in a single Clash configuration
5. Circumvent Restrictions: Access services that might be restricted in certain regions

Configuration Options

The API offers various configuration parameters for your Clash setup:

• Custom proxy names and groups
• Traffic routing rules
• DNS settings customization
• Specific country node selection

System Requirements

• Minimal: 1 CPU core, 512MB RAM
• Docker for containerized deployment
• Network: Outbound internet access

License

This project is licensed under the MIT License.

Note: This tool is intended for legitimate network access and privacy purposes. Always comply with Cloudflare’s terms of service when using WARP.