# OpenSea NFT Marketplace

Connect OpenSea NFT Marketplace to Unistream to sync your data into the Data Lake.

`tap-opensea` is a connector for opensea.

Built with the Unistream [SDK](https://gitlab.com/meltano/sdk) for Singer Taps.

## Configuration

### Accepted Config Options

* [ ] `Developer TODO:` Provide a list of config options accepted by the connector.

A full list of supported settings and capabilities for this tap is available by running:

```bash
tap-opensea --about
```

### Source Authentication and Authorization

* [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.

## Usage

You can easily run `tap-opensea` by itself or in a pipeline using [Unistream](https://www.unistream.com).

### Executing the connector Directly

```bash
tap-opensea --version
tap-opensea --help
tap-opensea --config CONFIG --discover > ./catalog.json
```

## Developer Resources

* [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.

### Initialize your Development Environment

```bash
pipx install poetry
poetry install
```

### Create and Run Tests

Create tests within the `tap_opensea/tests` subfolder and then run:

```bash
poetry run pytest
```

You can also test the `tap-opensea` CLI interface directly using `poetry run`:

```bash
poetry run tap-opensea --help
```

### Testing with [Meltano](https://www.meltano.com)

***Note:** this connector will work in any Singer environment and does not require Unistream. Examples here are for convenience and to streamline end-to-end orchestration scenarios.*

Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any *"TODO"* items listed in the file.

Next, install Unistream (if you haven't already) and any needed plugins:

```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-opensea
meltano install
```

Now you can test and orchestrate using Unistream:

```bash
# Test invocation:
# OR run a test `elt` pipeline:
```

### SDK Dev Guide

See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to develop your own taps and targets.

***

## Connecting to Unistream

1. In Unistream, navigate to **Lake**
2. Click **Add Source**
3. Select **OpenSea NFT Marketplace**
4. Fill in the **General Fields**:
   * **Name**: Enter a descriptive name for your connection
   * **Code**: Enter a unique identifier
5. Configure the **Connection Details** using the settings described above
6. Click **Test Connection** to verify
7. Click **Add** to save your connection

## Need Help?

If you encounter any issues, please contact Unistream support.