Search API

Search NFT collection traits

Returns aggregation of existing traits for specified collections with counter for each trait type/value. This is full-text-search, where you can specify filter for trait keys not precisely (for example, results back filter include Background trait)

SecurityApiKeyAuth
Request
query Parameters
filter
required
string

filter

Example: filter=Hat
collectionIds
required
Array of strings

Collections identifiers to which traits belong

Example: collectionIds=ETHEREUM:0x60e4d786628fea6478f785a6d7e704777c86a7c6
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/items/traits/search
Response samples
application/json
{
  • "continuation": "string",
  • "traits": [ ]
}

Search NFTs

Advanced search returns NFTs satisfying provided filter

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
size
required
integer <int32> [ 1 .. 1000 ]
Default: 50

Number of entities returned

continuation
string

Continuation token to paginate items search result

required
object (ItemsSearchFilter)

Filter for items search query

object (TraitSort)

Used when the search sort is set as TRAIT

sort
string (ItemsSearchSort)
Enum: "RELEVANCE" "LATEST" "RECENTLY_LISTED" "EARLIEST" "HIGHEST_SELL" "LOWEST_SELL" "HIGHEST_BID" "LOWEST_BID" "TRAIT"
Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/items/search
Request samples
application/json
{
  • "size": 10,
  • "filter": {
    },
  • "sort": "EARLIEST"
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "items": [ ]
}

Search NFT Ownerships

Advanced search returns NFT Ownerships satisfying provided filter

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
size
required
integer <int32> [ 1 .. 1000 ]
Default: 50

Number of entities returned

continuation
string

Continuation token to paginate ownerships search result

required
object (OwnershipSearchFilter)

Filter for ownerships search query

sort
string (OwnershipSearchSort)
Enum: "LATEST" "EARLIEST" "HIGHEST_SELL" "LOWEST_SELL"
Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/ownerships/search
Request samples
application/json
{
  • "size": 10,
  • "filter": {
    },
  • "sort": "EARLIEST"
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "ownerships": [ ]
}

Search Activities

Advanced search returns Activities satisfying provided filter

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
size
required
integer <int32> [ 1 .. 1000 ]
Default: 50

Number of entities returned

cursor
string

Cursor token to paginate Activity search result

required
object (ActivitySearchFilter)
sort
string (ActivitySearchSort)
Enum: "LATEST" "EARLIEST"
Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/activities/search
Request samples
application/json
{
  • "size": 50,
  • "cursor": "string",
  • "filter": {
    },
  • "sort": "LATEST"
}
Response samples
application/json
{
  • "continuation": "string",
  • "cursor": "string",
  • "activities": [ ]
}

Search NFT Collections

Advanced search returns NFT Collections satisfying provided filter

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
size
required
integer <int32> [ 1 .. 1000 ]
Default: 50

Number of entities returned

continuation
string

Continuation token to paginate collections search result

required
object (CollectionsSearchFilter)

Filter for collections search query

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/collections/search
Request samples
application/json
{
  • "size": 10,
  • "filter": {
    }
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "collections": [ ]
}
➔ Next to NFT Items