Skip to main content

Get Balance

Retrieves the current account balance from your CapMonster Cloud account in USD.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Session - The session ID returned from the Create Session node.

Output​

  • Balance - Your current account balance in USD as a decimal number.

How It Works​

The Get Balance node queries your CapMonster Cloud account to retrieve the current balance. When executed, it:

  1. Retrieves the session using the provided session ID
  2. Makes an API call to CapMonster Cloud
  3. Returns your current balance in USD
  4. Stores the balance in the output variable

Requirements​

  • A valid CapMonster session (from Create Session node)
  • Active internet connection
  • Valid API key with proper permissions

Error Handling​

The node will fail in the following cases:

  • Missing or invalid session ID
  • Session not found
  • Network connectivity issues
  • API authentication errors
  • CapMonster Cloud service unavailable

Usage Notes​

  • The balance is returned as a decimal number (e.g., 5.25 means $5.25)
  • Balance checks do not consume any credits
  • Use this node to verify sufficient funds before solving captchas
  • The balance updates in real-time and reflects all recent transactions
  • You can check your balance as often as needed without additional cost

Best Practices​

  • Check your balance before starting large captcha solving operations
  • Set up conditional logic to stop the flow if balance is too low
  • Monitor balance during long-running automations
  • Consider adding balance alerts to prevent service interruptions
  • Use balance checks in error recovery flows

Example: Balance Check Before Solving​

Create Session
  → Get Balance
    → If balance > 1.00
      → Solve Captcha (proceed)
    → Else
      → Log Error (insufficient funds)
      → Stop Flow

Example: Periodic Balance Monitoring​

Loop through items
  → Every 10 iterations
    → Get Balance
      → If balance < 0.50
        → Send Alert Email
        → Pause Flow

Use Cases​

  1. Pre-Flight Check: Verify sufficient funds before starting automation
  2. Budget Monitoring: Track spending during long-running processes
  3. Auto-Pause: Stop automation when balance runs low
  4. Reporting: Log balance information for accounting purposes
  5. Alert System: Trigger notifications when balance drops below threshold

Balance Top-Up​

If your balance is low:

  1. Log in to your CapMonster Cloud dashboard
  2. Navigate to the billing section
  3. Add funds to your account
  4. Funds are typically available immediately

Cost Planning​

  • Check CapMonster Cloud pricing page for current rates
  • Different captcha types have different costs
  • Plan your budget based on expected captcha volume
  • Consider bulk pricing for high-volume usage