WaAPI icon

WaAPI

Interact with WaAPI API
Join our community

Actions85

Overview

This node allows users to search for channels within a specified instance by applying various filters such as country codes, search text, and view type. It is useful for scenarios where you want to discover or list channels based on popularity, trending status, or recommendations, optionally filtered by geographic location or keywords.

Practical examples include:

  • Finding popular news channels in the US and UK.
  • Searching for channels related to specific topics like "news" or "sports".
  • Retrieving a curated list of trending channels to display in an application.

Properties

Name Meaning
Id Instance ID (required) - identifies the specific instance to search channels within.
Country Codes Optional array of ISO 3166-1 alpha-2 country codes to filter channels by geographic location.
Search Text Optional text string to search for in channel names or descriptions.
View View type for filtering results; options are: RECOMMENDED, TRENDING, POPULAR, NEW.
Limit Maximum number of results to return (default 50).
Skip Subscribed Newsletters Boolean flag indicating whether to exclude newsletters the user is already subscribed to.

Output

The node outputs JSON data containing the list of channels matching the search criteria. Each item in the output typically includes channel details such as name, description, country, and other metadata relevant to the channel.

If the node supports binary data output, it would represent associated media or files related to channels, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the external WaAPI service.
  • The node sends requests to https://waapi.app/api/v1.
  • No additional environment variables or configurations are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing instance ID will cause the request to fail.
    • Providing malformed JSON in the "Country Codes" property may result in parsing errors.
    • Exceeding the limit parameter might be restricted by the API, causing partial results or errors.
    • Network or authentication failures if the API key is invalid or missing.

  • Error messages:

    • Authentication errors indicate problems with the API key; ensure the correct credential is configured.
    • Validation errors for input parameters suggest checking the format and required fields.
    • Rate limiting errors from the API require waiting or adjusting usage patterns.

Links and References

Discussion