Build on CloudFam API.
Explore our **v3 Advanced API** with direct/remote uploads, balance management, payouts, bulk file search, and custom monetization. Test all endpoints live right on this page!
Interactive API Sandbox Live Console
Test real API requests directly in your browser.
Saved securely in browser local storage for testing.
// Response payload will appear here after execution...
Authentication
Required for all requests
All requests require your unique API Key found in your dashboard under Settings → API.
X-API-Key: YOUR_SECRET_KEY
Authorization: Bearer YOUR_SECRET_KEY
API v3 Endpoints
Full control over user balance, withdrawals, bulk files, and remote imports.
Get User Balance & Earnings
Retrieve current account balance, pending payout, and earnings breakdown.
/api/v3/user/balance
{
"success": true,
"data": {
"account_balance": 154.50,
"pending_payout": 50.00,
"total_withdrawn": 1200.00,
"today_earnings": 12.40,
"lifetime_earnings": 1404.50,
"referral_earnings": 45.00,
"currency": "USD"
}
}
Request Withdrawal
Submit a new payout request directly from your wallet balance.
/api/v3/user/withdraw
{
"amount": 50.00,
"payment_method": "paypal"
}
{
"success": true,
"message": "Withdrawal request submitted successfully.",
"data": {
"payout_id": "CFP-8492",
"amount": 50.00,
"status": "pending"
}
}
List & Search Files
Advanced file fetching with keyword search, sorting, and pagination.
/api/v3/files?q=zip&limit=20&page=1
Query Parameters: q (search term), limit (default 50), page, sort_by (uploaded_at, file_size_bytes, download_count, original_filename), status (active, trash, all).
{
"success": true,
"data": [
{
"id": 1042,
"original_filename": "project_archive.zip",
"file_size_bytes": 15482000,
"download_count": 89,
"short_url_id": "a9f81x",
"download_url": "https://cloudfam.io/a9f81x",
"status": "active",
"uploaded_at": "2026-08-16 14:10:00"
}
],
"pagination": { "total": 1, "page": 1, "limit": 20, "total_pages": 1 }
}
Delete Files (Trash or Permanent)
Bulk delete files by ID array with soft trash or permanent purge options.
/api/v3/files/delete
{
"file_ids": [1042, 1043],
"mode": "trash" // or "permanent" to purge completely
}
{
"success": true,
"message": "Moved 2 file(s) to trash."
}
Remote URL File Import
Pass a direct HTTP/HTTPS download link to import files asynchronously.
/api/v3/upload/remote
{
"url": "https://example.com/files/dataset.zip",
"original_filename": "custom_name.zip"
}
{
"success": true,
"message": "Remote download task queued.",
"data": {
"job_id": "REMOTE-8F42A1109C",
"status": "processing"
}
}
Direct Signed R2 Upload Session
Obtain high-speed presigned URLs to stream binary data directly to Cloudflare R2.
/api/v3/upload/session
{
"success": true,
"data": {
"upload_url": "https://5f1152de9384726a60aaad71768e5346.r2.cloudflarestorage.com/cloudfam/temp-uploads/...",
"key": "temp-uploads/101/a8123731029e",
"expires_in": 1800
}
}
Set File Monetization / Selling Price
Enable paid file access and assign custom sale prices.
/api/v3/selling/set-price
{
"file_id": 1042,
"price": 2.50
}
{
"success": true,
"message": "File monetization set to $2.50",
"data": { "file_id": 1042, "price": 2.50, "is_selling": 1 }
}
Daily Analytics & Referral Stats
Fetch earnings breakdown, downloads stats, and referral program data.
/api/v3/analytics/daily?days=30
{
"success": true,
"data": [
{
"date": "2026-08-16",
"earnings": 14.50,
"link_visits": 1250,
"completed_downloads": 480
}
]
}
Need help integrating?
Reach out to our developer support team on Telegram.