CloudFam
Developer Platform & Sandbox

Build on CloudFam API.

Explore our v3 Advanced API with direct uploads, remote imports, balance management, payouts, bulk file search, and custom monetization. Test all endpoints live right on this page!

Key-based Auth
Live On-Page Tester
Direct & Remote Upload
Balance & Payout APIs

Interactive API Sandbox Live Console

Test real API requests directly in your browser.

Target API: v3 Advanced

Saved securely in browser local storage for testing.

GET
JSON Output
// 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.

Recommended Header (v3) X-API-Key: YOUR_SECRET_KEY
Bearer Token Header Authorization: Bearer YOUR_SECRET_KEY
Advanced API v3

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.

GET /api/v3/user/balance
Response (200 OK)
{
    "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.

POST /api/v3/user/withdraw
Request Body (JSON)
{
    "amount": 50.00,
    "payment_method": "paypal"
}
Response (201 Created)
{
    "success": true,
    "message": "Withdrawal request submitted successfully.",
    "data": {
        "payout_id": "CFP-8492",
        "amount": 50.00,
        "status": "pending"
    }
}

File Info & Status Check (Alive Check)

Essential

Check whether single or bulk files are active and alive.

GET /api/file/info /api/v3/file/info

Pass a single file code (file_code=b578rni0e1ka) or multiple comma-separated codes (file_code=code1,code2,code3). Authentication can be passed via query parameter ?key=YOUR_KEY or request header X-API-Key.

Request (cURL)
# Direct:
curl "https://cloudfam.io/api/file/info?file_code=b578rni0e1ka&key=YOUR_API_KEY"

# Or via API v3 with Header:
curl -H "X-API-Key: YOUR_API_KEY" \
     "https://cloudfam.io/api/v3/file/info?file_code=b578rni0e1ka,x923fa"
Response (200 OK — JSON)
{
    "status": 200,
    "server_time": "2026-09-11 23:45:00",
    "result": [
        {
            "filecode": "b578rni0e1ka",
            "name": "1mb.bin",
            "status": 200,
            "size": 1048576,
            "uploaded": "2026-09-11 20:20:52",
            "downloads": 12,
            "is_alive": true,
            "status_text": "active",
            "download_url": "https://cloudfam.io/b578rni0e1ka"
        }
    ],
    "msg": "OK"
}

Status Codes in Results Array

  • status: 200 & is_alive: true — File is active, public, and available for download.
  • status: 404 & is_alive: false — File is deleted, removed for DMCA, or non-existent.

List & Search Files

Advanced file fetching with keyword search, sorting, and pagination.

GET /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).

Response (200 OK)
{
    "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.

POST /api/v3/files/delete
Request Body (JSON)
{
    "file_ids": [1042, 1043],
    "mode": "trash" // or "permanent" to purge completely
}
Response
{
    "success": true,
    "message": "Moved 2 file(s) to trash."
}

Instant File Clone & Move

Clone another file directly into your account without downloading, or organize files into folders.

POST /api/v3/file/clone /api/v3/files/move

Clone File (/file/clone)

Request
{ "file_code": "b578rni0e1ka" }
Response (201 Created)
{
    "success": true,
    "message": "File cloned successfully to your account.",
    "data": {
        "file_id": 2048,
        "filecode": "k82d91mz",
        "name": "project.zip",
        "download_url": "https://cloudfam.io/k82d91mz"
    }
}

Move Files to Folder (/files/move)

Request
{
    "file_ids": [1042, 1043],
    "folder_id": 5 // or null for root
}
Response
{
    "success": true,
    "message": "Moved 2 file(s) successfully.",
    "data": { "folder_id": 5, "moved_count": 2 }
}

Folder Management System

Full CRUD for folders: list nested structure, create, rename, and delete.

GET POST /api/v3/folders
GET /api/v3/folders
{
    "success": true,
    "data": {
        "folders": [
            {
                "id": 12,
                "name": "Tutorials",
                "parent_id": null,
                "total_files": 14,
                "total_bytes": 104857600
            }
        ],
        "root_files": 45,
        "root_bytes": 982400000
    }
}
POST /api/v3/folders (Create)
{
    "name": "New Project Files",
    "parent_id": null
}
{
    "success": true,
    "message": "Folder created successfully.",
    "data": { "folder_id": 15, "name": "New Project Files" }
}

Remote URL File Import

Pass a direct HTTP/HTTPS download link to import files asynchronously.

POST /api/v3/upload/remote
Request Body (JSON)
{
    "url": "https://example.com/files/dataset.zip",
    "original_filename": "custom_name.zip"
}
Response (202 Accepted)
{
    "success": true,
    "message": "Remote download task queued.",
    "data": {
        "job_id": "REMOTE-8F42A1109C",
        "status": "processing"
    }
}
Large File Support Up to 20 GB

Direct Upload (Single PUT ≤ 5 GB / Multipart up to 20 GB)

Upload files directly to CloudFam storage. Files under 5 GB use a single PUT. Files over 5 GB use our 3-step multipart upload (100 MB chunks).

POST /api/v3/upload/session

Files ≤ 5 GB — Single PUT

Returns one presigned URL. PUT the entire file to it, then call /upload/finalize.

POST /api/v3/upload/multipart/init

Files 5 GB – 20 GB — Multipart (3 steps)

Returns an array of presigned part URLs (100 MB each). PUT each chunk, collect ETags, then call /multipart/complete.

① Init — POST /api/v3/upload/multipart/init

Request Body (JSON)
{
    "original_filename": "movie_4k.mkv",
    "file_size_bytes": 15032385536,
    "mime_type": "video/x-matroska"
}
Response (200 OK)
{
    "success": true,
    "data": {
        "upload_id": "VXBsb2FkSWQ...",
        "key": "temp-uploads/101/a8f2...",
        "total_parts": 144,
        "part_size_bytes": 104857600,
        "parts": [
            {
                "part_number": 1,
                "upload_url": "https://..."
            },
            ...
        ],
        "expires_in": 14400
    }
}

② Upload Each Part (PUT)

Python Example
import requests, math

CHUNK = 100 * 1024 * 1024  # 100 MB
etags = []

with open("movie_4k.mkv", "rb") as f:
    for part in data["parts"]:
        chunk = f.read(CHUNK)
        r = requests.put(
            part["upload_url"],
            data=chunk,
            headers={"Content-Length": str(len(chunk))}
        )
        etags.append({
            "part_number": part["part_number"],
            "etag": r.headers["ETag"]
        })
cURL (single part)
curl -X PUT \
  "https://<presigned_part_url>" \
  --upload-file chunk_part1.bin \
  -H "Content-Length: 104857600" \
  -D - 2>&1 | grep ETag

Save the ETag response header from each part — you need all of them for Step 3.

③ Complete — POST /api/v3/upload/multipart/complete

Request Body (JSON)
{
    "key": "temp-uploads/101/a8f2...",
    "upload_id": "VXBsb2FkSWQ...",
    "original_filename": "movie_4k.mkv",
    "parts": [
        { "part_number": 1, "etag": "\"abc123\"" },
        { "part_number": 2, "etag": "\"def456\"" }
    ]
}
Response (201 Created)
{
    "success": true,
    "message": "File uploaded and finalized.",
    "data": {
        "file_id": 1093,
        "filename": "movie_4k.mkv",
        "file_size": 15032385536,
        "download_link": "https://cloudfam.io/b578rni0e1ka"
    }
}
POST /api/v3/upload/multipart/abort Cancel a stuck/failed upload
{ "key": "temp-uploads/101/a8f2...", "upload_id": "VXBsb2FkSWQ..." }

Set File Monetization / Selling Price

Enable paid file access and assign custom sale prices.

POST /api/v3/selling/set-price
Request Body (JSON)
{
    "file_id": 1042,
    "price": 2.50
}
Response
{
    "success": true,
    "message": "File monetization set to $2.50",
    "data": { "file_id": 1042, "price": 2.50, "is_selling": 1 }
}

Payout Rates & Country CPM

Get official PPD rates by tier & country code, plus your custom publisher CPM.

GET /api/v3/rates
Response
{
    "success": true,
    "data": {
        "tiers": [
            { "tier": 1, "rate_per_1000": 7.00, "countries": ["US", "GB", "CA", "AU"] },
            { "tier": 2, "rate_per_1000": 4.00, "countries": ["DE", "FR", "ES", "IT"] },
            { "tier": 3, "rate_per_1000": 2.50, "countries": ["IN", "BR", "ID", "PK"] }
        ],
        "user_rates": {
            "monetization_model": "ppd",
            "custom_cpm_rate": null,
            "traffic_cpm_rate": 1.0000
        }
    }
}

Video Streaming Info & Traffic Quality

Retrieve stream/embed players for video files and real-time fraud/quality audits.

GET /api/v3/video/info /api/v3/traffic/quality
GET /video/info?file_code=b578rni0e1ka
{
    "success": true,
    "data": {
        "filecode": "b578rni0e1ka",
        "filename": "demo_video.mp4",
        "views": 420,
        "stream_url": "https://cloudfam.io/stream.php?v=b578rni0e1ka",
        "embed_code": ""
    }
}
GET /traffic/quality
{
    "success": true,
    "data": {
        "quality_score": 95,
        "rating": "Excellent",
        "proxy_visits": 3,
        "is_safe": true,
        "recommendation": "Traffic health is within safe operating parameters."
    }
}

Daily Analytics & Referral Stats

Fetch earnings breakdown, downloads stats, and referral program data.

GET /api/v3/analytics/daily?days=30
Response
{
    "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.

Start monetizing today

Join 10,000+ creators earning with CloudFam. Setup takes 60 seconds.