# /scan

{% hint style="info" %}
/scan will provide you with a full scan of a given collection via the OpenSea API
{% endhint %}

`/scan` can be used in the [Community-Bot](https://discord.com/channels/910479328746287104/947522708546134046) channel:

<div data-full-width="false"><figure><img src="/files/7NCmSzNVxVDe7waFPCLs" alt=""><figcaption><p>Running /scan with the Butler community Bot</p></figcaption></figure></div>

### Required Parameters

* `collectionslug` can either be a collection slug or smart contract address to be scanned

### Optional Parameters

* `contractaddr` needs to be a valid smart contract address of the specified collection slug

{% hint style="info" %}
For collections hosted on a shared contract (such as art block collections) you can specify the contract address as optional parameter to get all the related collection data.
{% endhint %}

<figure><img src="/files/PcrOe4p3p1CxpIuKFSbq" alt=""><figcaption></figcaption></figure>

### Output

{% hint style="info" %}
The bot will open a new channel with you to provide the output data. It will only provide collection data if the collection was previously added to the Butler search engine with the [/add](/nft-butler/products-and-services/discord-bot/add.md) command.
{% endhint %}

The following output will be provided in the dedicated channel between you and the bot:

* Token Data for each asset of this collection
* Trait Data, including all token IDs per trait for this collection
* Collection stats
* Written output about KPIs

<div data-full-width="true"><figure><img src="/files/UH3BnY3q4b6mVYy6zdmT" alt=""><figcaption><p>/scan output in the dedicated channel between you and the bot</p></figcaption></figure></div>

The output data can be used to [create a manual task](/nft-butler/task-types/token-bidding.md) based on token ids. After 30minutes the channel with the output will be closed again.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nftbutler.io/nft-butler/products-and-services/discord-bot/scan.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.