Outscraper icon

Outscraper

Interact with Outscraper API

Actions49

Overview

This node integrates with the Outscraper API to perform searches and retrieve business information from Yelp. It allows users to query Yelp for business links or IDs, optionally request asynchronous processing, and specify a webhook URL for callback notifications when tasks complete.

Common scenarios include:

  • Automating the retrieval of Yelp business data for marketing or competitive analysis.
  • Enriching customer databases with Yelp business details.
  • Monitoring Yelp listings asynchronously and receiving updates via webhooks.

Practical example:

  • A user inputs a search term (e.g., "coffee shops in Seattle") to get Yelp business URLs or IDs.
  • The node can run the request asynchronously and notify the user’s system via a webhook once the data is ready.
  • Additional fields can be specified to customize the returned data, such as requesting specific fields or enabling UI task execution.

Properties

Name Meaning
Query Search links or business URLs/IDs from Yelp. This is the main search input string.
Async Request Whether to make an asynchronous request (true or false).
Webhook URL address to which Outscraper will send a POST request once the task is finished (callback URL).
Additional Fields Collection of optional parameters:
- Fields Specific fields to return, provided as a comma-separated string.
- Enrichment Additional data enrichments to include, comma-separated (only shown for search operation).
- UI Whether to execute the request as a UI task (true or false).

Output

The node outputs JSON data containing the results of the Yelp business search or lookup. The structure typically includes business URLs, IDs, and any additional requested fields or enriched data.

If the request is asynchronous, the output may contain task status or identifiers to track progress.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for Outscraper API access.
  • Needs proper configuration of the base URL and API key in the node credentials.
  • For asynchronous requests, a publicly accessible webhook URL must be provided to receive callbacks.

Troubleshooting

  • Common issues:

    • Missing or invalid API key will cause authentication failures.
    • Incorrect or unreachable webhook URL will prevent receiving asynchronous task completion notifications.
    • Invalid query strings or unsupported field names may result in empty or error responses.
  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up.
    • Network errors: Check internet connectivity and endpoint accessibility.
    • Validation errors: Ensure required properties like "Query" are provided and properly formatted.

Links and References

Discussion