Gainium icon

Gainium

Operates with official Gainium API

Overview

This node interacts with the Gainium API to retrieve and manage various types of trading bots, specifically including combo bots under the "Bots" resource. The "Get User Combo Bots" operation fetches a list of combo bots associated with the user, filtered by status and optionally paginated or returned in full.

Typical use cases include:

  • Monitoring all combo bots currently active or archived in a user's Gainium account.
  • Integrating bot data into workflows for reporting or further automated decision-making.
  • Filtering bots by their operational status (e.g., open, closed, error) to focus on relevant subsets.

For example, a trader might use this node to automatically fetch all open combo bots running in paper trading mode to analyze their performance or adjust strategies accordingly.

Properties

Name Meaning
Status Filter bots by their status. Options: Open, Closed, Archive, Error, Range
Page Number Page number for paginated results; used only if "Return All" is false
Paper Trading Boolean flag indicating whether to query bots in paper trading mode (true) or real trading (false)
Return All Boolean flag to return all results across pages (true) or just one page (false)
Please refer to official documentation of Gainium API for request formats. Notice property providing guidance to consult official API docs for request details

Output

The output JSON contains a data field which holds the retrieved combo bots information. Depending on the API response structure, this can be:

  • An object with a result array containing the bots and a totalResults count.
  • Or an object with items array and itemsCount count.

Example output structure:

{
  "data": {
    "result": [
      {
        "botId": "string",
        "name": "string",
        "status": "open",
        "otherBotDetails": "..."
      }
    ],
    "totalResults": 10
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Gainium API.
  • The node uses HMAC SHA-256 signing for request authentication.
  • Network access to the Gainium API base URL configured in credentials.
  • No additional external dependencies beyond standard n8n HTTP request helpers.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect status filter values may result in empty responses.
    • Pagination parameters misconfiguration can lead to incomplete data retrieval.
    • If the API returns an error status, the node throws an error with the reason message.
  • Error messages:

    • "Error: <reason>" — Indicates an API-level error; check the reason for specifics.
    • "HMAC generation failed: Web Crypto API not available" — Occurs if the environment does not support required cryptographic functions.
    • "Invalid JSON in filterModel" — Relevant for other operations using JSON input; ensure valid JSON syntax.
  • Resolutions:

    • Verify API credentials and permissions.
    • Use supported status options exactly as listed.
    • Enable "Return All" to avoid manual pagination unless specific pages are needed.
    • Ensure the runtime environment supports Web Crypto API (modern Node.js versions).

Links and References

Discussion