Actions23
- General Actions
- Bots Actions
- Deals Actions
- User Actions
Overview
This node interacts with the Gainium API to retrieve cryptocurrency screener data under the "General" resource with the "Get Crypto Screener" operation. It allows users to fetch filtered and sorted lists of cryptocurrencies based on various criteria such as market capitalization, exchange presence, price changes, and volume.
Common scenarios for this node include:
- Screening cryptocurrencies that meet specific financial or market criteria.
- Filtering coins listed on particular exchanges like Binance.
- Sorting results by price, market cap, or price change percentages over different time frames.
- Retrieving all matching results or limiting the number of returned items.
Practical example: A trader wants to find all cryptocurrencies with a market cap above $1 billion that are listed on Binance, sorted by current price in descending order. This node can perform that query and return the relevant list for further processing or alerting.
Properties
| Name | Meaning |
|---|---|
| Enable Filter | Boolean flag to enable advanced filtering options for the crypto screener. |
| Filter Model | JSON object defining filter conditions (field, operator, value) combined with a logical operator. |
| Return All | Boolean indicating whether to return all results or limit the output. |
| Limit | Number specifying the maximum number of items to return if not returning all (min 1, max 1000). |
| Additional Options | Collection of optional parameters: - Sort Field: Field to sort by (e.g., Current Price, Market Cap, Total Volume, Price Change 24h/7d/30d/1y, Market Cap Rank, Symbol, Name) - Sort Direction: Ascending or Descending |
Note: The property "Please refer to official documentation of Gainium API for request formats." is a notice and does not accept input.
Output
The node outputs a JSON object under the data field containing the results of the crypto screener query. The structure includes:
result: An array of cryptocurrency objects matching the filter and sorting criteria.totalResults: The total number of matched items.
Each cryptocurrency object typically contains fields such as market capitalization, symbol, name, current price, volume, and price change percentages over various periods, depending on the API response.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Gainium API.
- The node uses HMAC SHA-256 signing for request authentication.
- Requires network access to the Gainium API endpoint specified in the credentials.
- No additional environment variables are needed beyond the API credential configuration.
Troubleshooting
- Invalid JSON in filterModel: If the
filterModelJSON is malformed, the node throws an error indicating invalid JSON. Ensure the JSON syntax is correct before running the node. - API Errors: If the API returns a status of "NOTOK", the node throws an error with the reason provided by the API. Check your API key validity, request parameters, and network connectivity.
- Empty Results: If no cryptocurrencies match the filter criteria, the result array will be empty. Adjust filters or disable filtering to broaden the search.
- Limit Exceeded: When
returnAllis false, thelimitmust be between 1 and 1000. Setting values outside this range may cause errors or unexpected behavior.
Links and References
- Gainium API Documentation (official source for request formats and available fields)
- n8n HTTP Request Node Documentation (for understanding underlying HTTP requests)
- JSON Syntax Guide (helpful for constructing valid filterModel JSON)