Skip to content

ryan-shirley/ha-3commas

Repository files navigation

3Commas for Home Assistant

GitHub Release GitHub Activity License

hacs Project Maintenance

This Home Assistant integration allows you to view your 3Commas bot statistics directly in your Home Assistant dashboard. Monitor your trading profits, active deals, and locked funds all in one place.

Features

  • View overall USD profit from your 3Commas bots
  • Track today's USD profit
  • Monitor active deals USD profit
  • See funds locked in active deals
  • Support for both HMAC and RSA authentication methods
  • Option to select between Paper and Real trading modes

Screenshots

Example Dashboard

Installation

HACS (Recommended)

  1. Ensure that HACS is installed.
  2. Search for "3Commas" in the HACS Integrations tab.
  3. Click Install.
  4. Restart Home Assistant.
  5. Go to SettingsDevices & Services and click + Add Integration.
  6. Search for "3Commas" and follow the setup instructions.

Manual Installation

  1. Copy the custom_components/three_commas directory from this repository to your Home Assistant custom_components directory.
  2. Restart Home Assistant.
  3. Go to SettingsDevices & Services and click + Add Integration.
  4. Search for "3Commas" and follow the setup instructions.

Configuration

The integration can be configured via the Home Assistant UI:

  1. Go to SettingsDevices & Services and click + Add Integration.
  2. Search for "3Commas" and select it.
  3. Choose your authentication method:
    • HMAC Authentication: Requires API key and API secret
    • RSA Authentication: Requires API key and private key (PEM format)
  4. Select your trading mode:
    • Paper Trading: For using 3Commas in paper trading mode
    • Real Trading: For live trading with real funds

API Keys and Authentication

To use this integration, you'll need to create API keys from your 3Commas account:

  1. Log in to your 3Commas account
  2. Go to API in your profile settings
  3. Create a new API key with "Read" permission
  4. For HMAC authentication:
    • Save both the API key and Secret
  5. For RSA authentication:
    • Generate an RSA key pair
    • Upload your public key to 3Commas
    • Keep your private key secure for use with this integration

Troubleshooting

If you encounter issues with the integration:

  1. Verify your API credentials are correct and have proper permissions
  2. Check that your network allows connections to the 3Commas API
  3. For RSA authentication issues, ensure your private key is in the correct PEM format
  4. Enable debug logging for more information:
    logger:
      default: info
      logs:
        custom_components.three_commas: debug

Contributing

If you'd like to contribute to this project, please read the Contributing Guidelines.


About

3Commas Integration to pull DCA bot stats

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors