ClashCloud API: Quick Start

The ClashCloud API allows you to retrieve public platform data and manage your content from external applications. The API is served at https://api.clashcloud.dev and uses URL versioning (/v1/...).

Base URL

All requests are made to the following domain: https://api.clashcloud.dev/v1

First Request

Check the service availability with a simple GET request:

bash

curl -X GET https://api.clashcloud.dev/v1/status \
  -H "Accept: application/json"

Example response:

json

{
  "status": "ok",
  "service": "ClashCloud API",
  "version": "v1"
}

Response Format Successful responses returning collections are wrapped in data, meta, and links objects:

json

{
  "data": [],
  "meta": {
    "current_page": 1,
    "total": 0
  },
  "links": {
    "next": null,
    "prev": null
  }
}

Errors are returned in a unified format:

json

{
  "message": "Error description",
  "errors": {
    "field_name": ["Error message"]
  }
}

Public Endpoints

Method Path Description

GET	v1	system
GET	/v1/status	System operational status
GET	/v1/news	List of published news
GET	/v1/news/{slug}	Single news article
GET	/v1/projects	List of approved projects
GET	/v1/projects/{slug}	Single project
GET	/v1/users/{username}	Public user profile
GET	/v1/users/{username}/news	News by author
GET	/v1/users/{username}/projects	Projects by author
GET	/v1/tags	List of tags

Rate Limiting: Public endpoints are limited to 60 requests per minute per IP address. Check the X-RateLimit-* response headers to monitor your remaining limits.