Interface SearchStacksRequestParams

Request parameters for searchStacks operation in MetadataSearchApi.

Export

SearchStacksRequest

interface SearchStacksRequestParams {
    chainName: string;
    contractAddress: string[];
    accountAddress?: string;
    onlyIncludeOwnerListings?: boolean;
    onlyIfHasActiveListings?: boolean;
    traits?: string;
    keyword?: string;
    sortBy?: CheapestFirst;
    pageSize?: number;
    pageCursor?: string;
}

Properties

chainName contractAddress accountAddress? onlyIncludeOwnerListings? onlyIfHasActiveListings? traits? keyword? sortBy? pageSize? pageCursor?

Properties

ReadonlychainName

chainName: string

The name of chain

Memberof

SearchStacks

ReadonlycontractAddress

contractAddress: string[]

List of contract addresses to filter by

Memberof

SearchStacks

Optional ReadonlyaccountAddress

accountAddress?: string

Account address to filter by

Memberof

SearchStacks

Optional ReadonlyonlyIncludeOwnerListings

onlyIncludeOwnerListings?: boolean

Whether to the listings should include only the owner created listings

Memberof

SearchStacks

Optional ReadonlyonlyIfHasActiveListings

onlyIfHasActiveListings?: boolean

Filters results to include only stacks that have a current active listing. False and 'null' return all unfiltered stacks.

Memberof

SearchStacks

Optional Readonlytraits

traits?: string

JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({"rarity": {"values": ["common", "rare"], "condition": "eq"}}))

Memberof

SearchStacks

Optional Readonlykeyword

keyword?: string

Keyword to search NFT name and description. Alphanumeric characters only.

Memberof

SearchStacks

Optional ReadonlysortBy

sortBy?: CheapestFirst

Sort results in a specific order

Memberof

SearchStacks

Optional ReadonlypageSize

pageSize?: number

Number of results to return per page

Memberof

SearchStacks

Optional ReadonlypageCursor

pageCursor?: string

Encoded page cursor to retrieve previous or next page. Use the value returned in the response.

Memberof

SearchStacks

Settings

Member Visibility

On This Page

Properties