Skip to content

Commit c84c95a

Browse files
Document collectibles spam filtering flags (#144)
1 parent 166ef89 commit c84c95a

2 files changed

Lines changed: 15 additions & 12 deletions

File tree

evm/collectibles.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ See the [Compute Units](/compute-units) page for detailed information.
2626

2727
## Spam Filtering
2828

29-
By default, spam filtering for collectibles is enabled. Use `filter_spam=false` to disable it. You can omit the parameter or set `filter_spam=true` to keep spam filtering enabled.
29+
By default, spam filtering for collectibles is enabled. Use `filter_spam=false` to include spam collectibles in the response. You can omit the parameter or set `filter_spam=true` to keep spam filtering enabled.
3030

31-
We provide spam scores to explain how a collectible is classified as spam or not.
32-
Spam scores are _off_ by default. Enable them with `show_spam_scores=true`.
31+
We provide spam scores to explain how a collectible is classified as spam or not. The `is_spam` field is always included in each entry. Spam scores are _off_ by default and require `show_spam_scores=true` to include `spam_score` and `explanations`.
32+
Setting `show_spam_scores=true` does not disable filtering; use `filter_spam=false` if you want spam entries (and their scores) returned.
3333
Scores are computed as a weighted average across signals.
3434
These include whether the collection has been flagged by external providers, trade volume since launch, and the number of unique buyers and sellers.
3535
See the table below for the full list.
@@ -41,10 +41,11 @@ See the table below for the full list.
4141
| `trade_volume` | This is the total number of trades since collection launch. Very low activity can indicate spam. Collections launched in the last 7 days are excluded from this signal. |
4242
| `unique_buyers` | This is the count of distinct buyers. Low buyer diversity can indicate inorganic activity. |
4343
| `unique_sellers` | This is the count of distinct sellers. Low seller diversity can indicate inorganic activity. |
44-
| `externally_flagged` | Whether the collection has been flagged as spam by third-party providers. `true` increases the spam likelihood. |
45-
| `ipfs_uri_present` | This indicates whether token metadata URIs use IPFS. Certain patterns can correlate with spam when combined with other signals. |
46-
| `suspicious_words` | Whether names, symbols, or URIs include suspicious terms commonly associated with scams. |
47-
| `url_shortener_in_uri` | This indicates whether metadata URIs use link shorteners. For example, Bitly links can obscure destinations. |
44+
| `externally_flagged` | Whether the collection has been flagged as spam by third-party providers (for example, Alchemy). `true` increases the spam likelihood. |
45+
| `uri_non_ipfs` | Whether metadata URIs are non-IPFS. Certain patterns can correlate with spam when combined with other signals. |
46+
| `suspicious_words` | Whether names or symbols include suspicious terms commonly associated with scams. |
47+
| `url_shortener` | Whether metadata URIs use link shorteners (for example, Bitly). |
48+
| `manual_classification` | Manual override for classification (`spam` or `not spam`). |
4849

4950
</Accordion>
5051

evm/openapi/collectibles.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,16 +138,18 @@
138138
"unique_buyers",
139139
"unique_sellers",
140140
"externally_flagged",
141-
"ipfs_uri_present",
141+
"uri_non_ipfs",
142142
"suspicious_words",
143-
"url_shortener_in_uri"
143+
"url_shortener",
144+
"manual_classification"
144145
]
145146
},
146147
"value": {
147148
"description": "Observed value for the feature (type varies by feature).",
148149
"oneOf": [
149150
{ "type": "integer", "format": "int32" },
150-
{ "type": "boolean" }
151+
{ "type": "boolean" },
152+
{ "type": "string" }
151153
]
152154
},
153155
"feature_score": {
@@ -286,7 +288,7 @@
286288
"name": "filter_spam",
287289
"in": "query",
288290
"required": false,
289-
"description": "When true, hide collectibles identified as spam. Set to false to return all collectibles, including potential spam. See the [Spam Filtering](##spam-filtering) section for more details.",
291+
"description": "When true, hide collectibles identified as spam. Set to false to return all collectibles, including potential spam. See the [Spam Filtering](#spam-filtering) section for more details.",
290292
"schema": {
291293
"type": "boolean",
292294
"default": true
@@ -296,7 +298,7 @@
296298
"name": "show_spam_scores",
297299
"in": "query",
298300
"required": false,
299-
"description": "When true, include spam scoring details including contributing signals to explain filtering decisions.",
301+
"description": "When true, include spam scoring details (`spam_score` and `explanations`) to explain filtering decisions.",
300302
"schema": {
301303
"type": "boolean",
302304
"default": false

0 commit comments

Comments
 (0)