API Reference

Complete technical reference for the CloudCoin protocol, APIs, and SDKs.

Client Core API

The CloudCoin API provides developers with programmatic access to the CloudCoin network and related services. This reference documents the available API endpoints, request parameters, and response formats.

/api/coins/break
GET
Break a larger denomination coin into smaller denominations.
/api/coins/import
GET
Import CloudCoin files from the Import folder into the wallet.
/api/coins/join
GET
Join multiple smaller denomination coins into a larger denomination.
/api/health/authenticate
GET
Authenticate coins by verifying them against all 25 RAIDA servers.
/api/health/encryption-repair
GET
Fix lost encryption keys by re-authenticating coins with RAIDA servers.
/api/program/disclaimer
GET
Retrieve the CloudCoin software disclaimer and legal terms.
/api/program/echo
GET
Test RAIDA network connectivity by sending echo requests to all 25 RAIDA servers in parallel.
/api/raida/countcoins
GET
Count the total number of coins stored in RAIDA lockers.
/api/raida/lockers/peek
GET
Peek into a RAIDA locker to see the list of coins without downloading them.
/api/raida/version
GET
Query version information from all 25 RAIDA servers.
/api/recovery/status
GET
Check startup recovery status to determine if the program is ready for use.
/api/system/config/mobile
GET
Check if the application is running on a mobile device.
/api/system/config/usb
GET
Check if the application is running from a USB drive for enhanced security.
/api/system/dropdown
GET
Retrieve dropdown configuration data from specified files.
/api/system/encrypt_existing_files
POST
Walk Bank/Fracked and rewrite plaintext .bin files as encrypted under the current key. Async via task_manager.
/api/system/encryption-status
GET
Report whether a key is loaded and whether encrypted .bin files exist. Use this before login to decide whether to prompt.
/api/system/login
POST
Set the global file-encryption password. New .bin files are encrypted; encrypted files become readable.
/api/system/logout
GET
Clear the in-memory file-encryption key. Persistent verifier file is left in place.
/api/task
GET
Check the status of an asynchronous task by task ID.
/api/tools/support-zip
GET
Create a ZIP archive of log files and configuration for support and debugging.
/api/transactions/export
GET
Export coins from the wallet to a file with specified denomination and format.
/api/transactions/export
GET
Export coins to a file with automatic change-making for exact amounts. [ASYNC]
/api/transactions/import
GET
Import specific CloudCoin files from absolute paths with a transaction memo. [ASYNC]
/api/transactions/locker/download
GET
Download coins from a RAIDA locker using a secure locker key.
/api/transactions/locker/upload
GET
Upload coins from wallet to a RAIDA locker with secure locker key.
/api/wallets/backup
GET
Create a backup copy of coins to a specified destination folder.
/api/wallets/balance
GET
Get the balance and coin counts for the active wallet, broken down by folder.
/api/wallets/coin-details
GET
Get detailed information about a specific coin by serial number.
/api/wallets/consolidate
GET
Consolidate coins by combining smaller denominations into larger ones.
/api/wallets/create
GET
Create a new wallet at the active location with all necessary folder structure.
/api/wallets/delete
GET
Delete a wallet and remove it from the wallet list.
/api/wallets/list
GET
List all configured wallets and their locations on the system.
/api/wallets/locations
GET
Add a new wallet location to the list of configured wallets.
/api/wallets/receipts
GET
List transaction receipts or view a specific receipt by filename.
/api/wallets/register
GET
Display the wallet register showing all coins and their statuses.
/api/wallets/rename
GET
Rename an existing wallet to a new name.
/api/wallets/show-coins
GET
List serial numbers and detailed coin data from a specific wallet folder.
/api/wallets/transactions
GET
View transaction history for the active wallet with optional filtering.