Get hidden NFTs by user

GET 
/v1/users/hidden-nfts

Get hidden NFTs by user

This endpoint retrieves hidden NFTs associated with a user's accounts, supporting pagination, sorting, and filtering. It accepts optional query parameters for sorting (sort_by), ordering (order_by), pagination (page, page_size), and searching (search_by). The endpoint returns a JSON object containing an array of hidden coins along with the total count of such NFTs.

Request

Query Parameters

sort_by string

Sort by

order_by string

Order by

page int32

Page

page_size int32

Page size

search_by string

Search by

Responses

200

Hidden NFTs found

application/json

Schema

Schema

hiddenNfts object[]required
Array [
account objectnullable
activeThisMonth booleannullable
address stringrequired
approversQuantity int32nullable
chainPath stringrequired
createdAt date-timerequired
exchangeApiKey stringnullable
exchangeApiSecret stringnullable
id uuidrequired
isActive booleanrequired
isImported booleanrequired
name stringrequired
transactionLimit stringrequired
type stringrequired
walletId uuidrequired
amount stringnullable
blockNumber stringnullable
blockNumberMinted stringnullable
chainId int32nullable
contractType stringnullable
lastMetadataSync stringnullable
lastTokenUriSync stringnullable
metadata stringnullable
minterAddress stringnullable
name stringnullable
normalizedMetadata objectrequired
animationUrl stringnullable
attributes object[]required
description stringnullable
externalLink stringnullable
image stringnullable
name stringnullable
ownerOf stringnullable
possibleSpam booleanrequired
symbol stringnullable
tokenAddress stringnullable
tokenHash stringnullable
tokenId stringnullable
tokenUri stringnullable
verifiedCollection booleanrequired
]
total int64required

Example (from schema)

{
  "hiddenNfts": [
    {
      "account": {
        "activeThisMonth": true,
        "address": "string",
        "approversQuantity": 0,
        "chainPath": "string",
        "createdAt": "2024-09-25T19:42:12.662Z",
        "exchangeApiKey": "string",
        "exchangeApiSecret": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isActive": true,
        "isImported": true,
        "name": "string",
        "transactionLimit": "string",
        "type": "string",
        "walletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "amount": "string",
      "blockNumber": "string",
      "blockNumberMinted": "string",
      "chainId": 0,
      "contractType": "string",
      "lastMetadataSync": "string",
      "lastTokenUriSync": "string",
      "metadata": "string",
      "minterAddress": "string",
      "name": "string",
      "normalizedMetadata": {
        "animationUrl": "string",
        "attributes": [
          {
            "display_type": 0,
            "max_value": 0,
            "order": 0,
            "trait_count": 0,
            "trait_type": "string"
          }
        ],
        "description": "string",
        "externalLink": "string",
        "image": "string",
        "name": "string"
      },
      "ownerOf": "string",
      "possibleSpam": true,
      "symbol": "string",
      "tokenAddress": "string",
      "tokenHash": "string",
      "tokenId": "string",
      "tokenUri": "string",
      "verifiedCollection": true
    }
  ],
  "total": 0
}

204

No content

text/plain

Schema

Schema

string

500

Internal server error

text/plain

Schema

Schema

string

Loading...