Apify

tap-apify (airbyte variant)

Web Scraping, Data Extraction and Automation

The tap-apify extractor pulls data from Apify that can then be sent to a destination using a loader.

⚠️ Experimental Preview Warning ⚠️

This connector uses tap-airbyte-wrapper to call the underlying Docker container for the source. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.
For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-apify extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-apify
  2. Configure the tap-apify settings using 
    meltano config
     : 
    3. meltano config tap-apify set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-apify test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-apify may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-apify settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-apify list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Airbyte Spec Image (airbyte_spec.image)

  • Environment variable: TAP_APIFY_AIRBYTE_SPEC_IMAGE
  • Default Value: airbyte/source-apify-dataset

Airbyte image to run


Configure this setting directly using the following Meltano command:

meltano config tap-apify set airbyte_spec image [value]

Airbyte Spec Tag (airbyte_spec.tag)

  • Environment variable: TAP_APIFY_AIRBYTE_SPEC_TAG
  • Default Value: latest

Airbyte image tag


Configure this setting directly using the following Meltano command:

meltano config tap-apify set airbyte_spec tag [value]

Docker Mounts (docker_mounts)

  • Environment variable: TAP_APIFY_DOCKER_MOUNTS

Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation


Configure this setting directly using the following Meltano command:

meltano config tap-apify set docker_mounts [value]

Airbyte Config Datasetid (airbyte_config.datasetId)

  • Environment variable: TAP_APIFY_AIRBYTE_CONFIG_DATASETID

ID of the dataset you would like to load to Airbyte.


Configure this setting directly using the following Meltano command:

meltano config tap-apify set airbyte_config datasetId [value]

Airbyte Config Clean (airbyte_config.clean)

  • Environment variable: TAP_APIFY_AIRBYTE_CONFIG_CLEAN

If set to true, only clean items will be downloaded from the dataset. See description of what clean means in Apify API docs. If not sure, set clean to false.


Configure this setting directly using the following Meltano command:

meltano config tap-apify set airbyte_config clean [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_APIFY_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-apify set stream_maps [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_APIFY_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-apify set stream_map_config [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_APIFY_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-apify set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_APIFY_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-apify set flattening_max_depth [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-apify extractor to work, read the Airbyte connector FAQ, look for an existing issue in the Airbyte repository, file a new issue, or join the Meltano Slack community and ask for help in the 
#plugins-general
channel.

Install

meltano add extractor tap-apify

Maintenance Status

  • Maintenance Status
  • Based on an Airbyte Connector

Repo

https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-apify-dataset
  • License

Maintainer

  • Airbyte

Keywords

  • airbyte_protocol