Filter NSFW NFTs

This page describes how to filter out possible NSFW NFT collections.

Introducing the NSFW filtering feature for NFTs! With this new functionality, you can easily filter out Not Safe For Work (NSFW) NFTs.

Filter out your NFTs that are marked as NSFW using the includeNsfw boolean query param that applies only to the following three endpoints:

  1. Get NFTs by walletId: reference
  2. Get NFTs by Chain: reference
  3. Get NFTs by Chain and Wallet Address: reference

You will receive a contract.isNsfw boolean in the response body for all of the above endpoints and the following endpoints:

  1. Get NFTs by Chain and Contract Address: reference
  2. Get NFTs by Chain, Contract Address, and tokenId: reference

๐Ÿ“˜

includeNsfw query boolean param explained:

  • The includeNsfw query param is set to false by default.
  • If the includeNsfw query param is set to false, the response body will only return the non-NSFW results.
  • If the includeNsfw query param is set to true, the response body will return all the results (NSFW + non-NSFW).

Example Request: reference

The following endpoint retrieves NFTs by chain and wallet address:

GET /api/wallets/MATIC/0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9/nonfungibles?includeNsfw=true
ParameterParam TypeDescriptionData TypeValueMandatory
includeNsfwQueryIndication to include possible NSFW NFTs in the response body or not.BooleantrueโŒ

Response Body

๐Ÿ“˜

Look for the result.contract.isNsfw parameter:

  • If the contract.isNsfw is true, it indicates that your NFT collection is possibly NSFW.
  • If the contract.isNsfw is false, it indicates that your NFT collection is possibly non-NSFW.
  • If the contract.isNsfw param is not returned in the response body, this means the data was not returned by the blockchain provider. You can try again later.
{
    "success": true,
    "result": [
        {
            "id": "0",
            "name": "$1000 USDC",
            "description": "Owning this badge indicates that the user has received $1000 USDC Airdrop.",
            "imageUrl": "https://cdn.simplehash.com/assets/594f84cd22e8882adac0eee49f44fa0916f67f9c25a408b80220ced34f39ea9d.jpg",
            "imagePreviewUrl": "https://lh3.googleusercontent.com/5ooylv-qDiIq03F6tbNY71Gr8dW5uKT4b6TEq6bq8XVlvltEWtbAva_jVuQ3PXR-2GitF4bWAUlyb0ydWBX5Bl71pOBr5x7qlg",
            "imageThumbnailUrl": "https://lh3.googleusercontent.com/5ooylv-qDiIq03F6tbNY71Gr8dW5uKT4b6TEq6bq8XVlvltEWtbAva_jVuQ3PXR-2GitF4bWAUlyb0ydWBX5Bl71pOBr5x7qlg=s250",
            "animationUrls": [],
            "fungible": true,
            "contract": {
                "name": "$1000 USDC",
                "address": "0x43d5ebed23900fd83c5d5327ba1e86afbe1d84a9",
                "symbol": "$1000 USDC",
                "media": [
                    {
                        "type": "image",
                        "value": "https://lh3.googleusercontent.com/tagPtZl7s_SdQ0hAR0PtSTGlUEJnGjV3TV2VCdYZEFPevsSTrDCtuDjIxDwHDBGZDr0kmhv2egD_8nouWGBRy3iuG7zMLmRSX_U"
                    }
                ],
                "type": "ERC_1155",
                "verified": false,
                "premium": false,
                "isNsfw": false,
                "categories": [],
                "imageUrl": "https://lh3.googleusercontent.com/tagPtZl7s_SdQ0hAR0PtSTGlUEJnGjV3TV2VCdYZEFPevsSTrDCtuDjIxDwHDBGZDr0kmhv2egD_8nouWGBRy3iuG7zMLmRSX_U"
            },
            "attributes": [],
            "balance": 1,
            "finalBalance": 1,
            "transferFees": false
        },
        {
            "id": "1",
            "name": "$1000 USDC Voucher๐ŸŽ",
            "description": "You have been selected for the USDC NFT Airdrop! Redeem your voucher for 1000 USDC at https://1000usdc.org",
            "url": "https://1000usdc.org",
            "imageUrl": "https://cdn.simplehash.com/assets/0e22471648572082975551060cc4e76e50caafa9ca8c04b68a4cc6607db90602.jpg",
            "imagePreviewUrl": "https://lh3.googleusercontent.com/smSb5f_RhuSKuPTXUD_7I21aaZgwReqtlB4KNyxv0WJBliGYrpTpc_t_X50Nv7PEuyJnX4bhduLwl7wkylzCK-K_jcQYBiV4y3Y",
            "imageThumbnailUrl": "https://lh3.googleusercontent.com/smSb5f_RhuSKuPTXUD_7I21aaZgwReqtlB4KNyxv0WJBliGYrpTpc_t_X50Nv7PEuyJnX4bhduLwl7wkylzCK-K_jcQYBiV4y3Y=s250",
            "animationUrls": [],
            "fungible": true,
            "contract": {
                "name": "$1000 USDC Voucher๐ŸŽ",
                "address": "0x51e7b4faf536c0f602b653d28cf4febd4e57765f",
                "symbol": "1000usdc.org",
                "media": [
                    {
                        "type": "image",
                        "value": "https://lh3.googleusercontent.com/9P79CsAmgQMv0ZlEb4zUN7YnEsHXES0KWX63LKlN7g28wKcoHkBIUGYEbCvqa4C2zQoauhpWAel894zW7aAECsqwul67hCqJFl1q"
                    }
                ],
                "type": "ERC_1155",
                "verified": false,
                "premium": false,
                "isNsfw": false,
                "categories": [],
                "imageUrl": "https://lh3.googleusercontent.com/9P79CsAmgQMv0ZlEb4zUN7YnEsHXES0KWX63LKlN7g28wKcoHkBIUGYEbCvqa4C2zQoauhpWAel894zW7aAECsqwul67hCqJFl1q"
            },
            "attributes": [
                {
                    "type": "property",
                    "name": "Website",
                    "value": "https://1000usdc.org"
                }
            ],
            "balance": 1,
            "finalBalance": 1,
            "transferFees": false
        }
    ]
}