API Reference
Control your proxies via API
Retrieves the user’s Illusory Wallet balance.
cURL
curl --request GET \ --url https://cmd.illusory.io/v1/funds \ --header 'Authorization: Bearer <token>'
{ "ok": true, "message": "Retrieved funds successfully.", "data": { "funds": 40, "upcoming": { "renewing": { "count": 1, "amount": 5 }, "expiring": { "count": 1, "amount": 5 }, "total": { "renewal_required": 0, "total_required": 0, "total_commitment": 10 } } } }
The Authorization header is used to authenticate with the API using your Master API key. Value is of the format Bearer YOUR_KEY_HERE.
Authorization
Master
Bearer YOUR_KEY_HERE
Server response
Indicates whether the request was successful e.g., true
true
Success message
"Retrieved funds successfully."
An object containing the user's funds
Show child attributes
Amount of funds available
An object containing the user's upcoming charges.
An object containing the user's upcoming renewing charges within the next 24 hours.
Number of proxies renewing
Amount of funds due for renewing proxies
An object containing the user's upcoming expiring charges within the next 24 hours.
Number of proxies expiring
Amount of funds due for expiring proxies
An object containing the user's total upcoming charges
Amount of funds short to renew proxies
Amount of funds short to renew and extend expiring proxies
Total cost of all proxies in the account, based on current periods for each proxy
Was this page helpful?