# PhantomBuster
[PhantomBuster](https://phantombuster.com/) is a cloud-based data automation and web scraping platform that allows users to extract data from websites, automate actions.

omniload supports PhantomBuster as a source.

## URI format

The URI format for PhantomBuster is as follows:

```text
PhantomBuster://?api_key=<api_key>
```

URI parameters:
- `api_key`: the API key used for authentication with the PhantomBuster API

## Setting up a PhantomBuster Integration

You can find your PhantomBuster API key by following the guide [here](https://hub.phantombuster.com/docs/api#how-to-find-my-api-key).

Let's say your `api_key` is key_123, here's a sample command that will copy the data from PhantomBuster into a DuckDB database:


```bash
omniload ingest \
--source-uri 'PhantomBuster://?api_key=key_123' \
--source-table 'completed_phantoms:<agent_id>' \
--dest-uri duckdb:///PhantomBuster.duckdb \
--dest-table 'dest.result'
```

<img alt="PhantomBuster_img" src="../media/phantombuster.png"/>

## Tables

Phantombuster source allows ingesting the following sources into separate tables:

| Table           | PK | Inc Key | Inc Strategy | Details                                                                                                                                       |
| --------------- | ----------- | --------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| [completed_phantoms:<agent_id>](https://hub.phantombuster.com/reference/get_containers-fetch-all) | container_id | ended_at     | merge               | Gets all containers associated to a specified agent. Where agent id is a unique identifier for a specific Phantom which can be found in URI of a specific phantom. |

Use this as `--source-table` parameter in the `omniload ingest` command.