
# Atlos Feeder
```{admonition} Module type

<span style='color: #FFA500'>[feeder](/core_modules.md#feeder-modules)</a></span>
```

AtlosFeeder: A feeder module that integrates with the Atlos API to fetch source material URLs for archival.

### Features
- Connects to the Atlos API to retrieve a list of source material URLs.
- Filters source materials based on visibility, processing status, and metadata.
- Converts filtered source materials into `Metadata` objects with the relevant `atlos_id` and URL.
- Iterates through paginated results using a cursor for efficient API interaction.

### Notes
- Requires an Atlos API endpoint and a valid API token for authentication.
- Ensures only unprocessed, visible, and ready-to-archive URLs are returned.
- Handles pagination transparently when retrieving data from the Atlos API.


## Configuration Options

### YAML
```{code} yaml
atlos_feeder:
  api_token: ''
  atlos_url: https://platform.atlos.org

```

### Command Line:
| Option | Description | Default | Type|
| --- | --- | --- | --- |
| `atlos_feeder.api_token` | **Required**. An Atlos API token. For more information, see https://docs.atlos.org/technical/api/ |  | string |
| `atlos_feeder.atlos_url` | Optional. The URL of your Atlos instance (e.g., https://platform.atlos.org), without a trailing slash. | https://platform.atlos.org | string |

[API Reference](../../../autoapi/atlos_feeder/index)
