Gainium icon

Gainium

Operates with official Gainium API
Join our community

Actions23

Overview

This node operation updates the settings of a "Combo Bot" on the Gainium platform via its official API. Combo Bots are trading bots that combine multiple strategies or configurations to automate cryptocurrency trading. This operation allows users to modify various parameters of an existing Combo Bot, such as trading pairs, order sizes, profit targets, stop-loss percentages, risk management options, cooldown intervals, and other advanced bot behavior settings.

Typical use cases include:

  • Adjusting a running Combo Bot’s configuration to optimize performance based on market conditions.
  • Changing risk parameters or reinvestment strategies without stopping the bot.
  • Enabling or disabling features like smart orders, dynamic price filters, or cooldown periods.
  • Switching between paper trading (simulated) and real trading environments.

Example: A user wants to update their Combo Bot to increase the number of active smart grids and adjust the take-profit percentage to 2.5%. They provide the new settings JSON and the bot ID, and this node sends the update request to Gainium.

Properties

Name Meaning
Bot Id The unique identifier of the Combo Bot to update.
Bot Settings A JSON object containing the new settings for the Combo Bot. Refer to the Gainium API documentation for the exact schema. Typical fields include:
- name: Bot name
- pair: Array of trading pairs
- ordersCount: Number of orders
- tpPerc: Take profit percentage
- slPerc: Stop loss percentage
- profitCurrency: Profit currency type (base or others)
- orderSize, baseOrderSize: Order size values
- Various boolean flags for features like useRiskReduction, useReinvest, skipBalanceCheck, useTp, useSl, useDca, useSmartOrders
- Cooldown settings with intervals and units
- Smart grid counts and volume/step scales
- And many more detailed bot configuration parameters.
Paper Trading Boolean flag indicating whether to apply the update in paper trading mode (true) or real trading mode (false).
Please refer to official documentation of Gainium API for request formats. Notice reminding users to consult Gainium API docs for correct request formats.
This operation requires write permission of API keys. Notice indicating that the API key used must have write permissions to perform this operation.

Output

The node outputs the JSON response from the Gainium API after attempting to update the Combo Bot settings. The structure typically includes:

  • data: An object representing the updated bot details or confirmation of the update.
  • If the API returns an error, the output will contain an error message describing the failure reason.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential with write permissions for the Gainium API.
  • The node uses HMAC SHA-256 signing for authentication headers.
  • Requires network access to the Gainium API endpoint specified in the credentials.
  • The user must supply valid JSON for the bot settings according to Gainium's API schema.

Troubleshooting

  • Invalid JSON in Bot Settings: If the provided JSON for bot settings is malformed, the API call will fail. Ensure the JSON is correctly formatted and matches the expected schema.
  • Insufficient Permissions: The API key must have write access; otherwise, the request will be rejected.
  • Bot Id Not Found: Providing an incorrect or non-existent bot ID will cause an error.
  • API Signature Errors: If the HMAC signature generation fails or the system clock is out of sync, authentication errors may occur.
  • Network Issues: Connectivity problems to the Gainium API endpoint will cause request failures.
  • Error Messages: The node throws errors with messages returned by the API under the reason field, e.g., "Error: <reason>". Review these messages to diagnose issues.

To resolve errors:

  • Validate all input parameters carefully.
  • Confirm API key permissions.
  • Check the system time synchronization.
  • Consult Gainium API documentation for required fields and formats.

Links and References

This summary covers the static analysis of the node's execute method for the "Update Combo Bot Settings" operation under the "Bots" resource, based on the provided source code and property definitions.

Discussion