ClientMethods

Methods

Source:

Methods

static AcceptMarketplaceOffer({offerId})

Requires login

Accept the specified offer

Parameters:
Name Type Description
offerId string

The ID of the offer

Source:

static AvailableMarketplaces({
organizeByIdoptional,
forceReloadoptional
})
→ Promise.<Object>

Retrieve info about all available marketplaces

Returns: Info about available marketplaces
Parameters:
Name Type Attributes Default Description
organizeById boolean <optional>

By default, the returned marketplace info is organized by tenant and marketplace slug. If this option is enabled, the marketplaces will be organized by marketplace ID instead.

forceReload boolean <optional>
false

If specified, a new request will be made to check the currently available marketplaces instead of returning cached info

Source:

static CastVote({
tenantId,
votingEventId,
sku
})
→ Promise.<Object>

Requires login

Cast a vote for the specified item in the specified voting event

Returns: Info about the voting event, including the current user's votes and the current total voting tally
Parameters:
Name Type Description
tenantId string

The tenant ID of the marketplace in which the voting event is specified

votingEventId string

The ID of the voting event

sku string

The SKU of the item to vote for

Source:

static ClaimGift({code}) → Promise.<Object>

Claim the specified gift code

Use the GiftClaimStatus method to check minting status after claiming

Returns: Information about the claim, including the tenant associated with the item, the gift ID and the status op key
Parameters:
Name Type Description
code string

The OTP gift code to claim

Source:

static ClaimItem({
marketplaceParams,
sku,
emailoptional
})

Claim the specified item from the specified marketplace

Use the ClaimStatus method to check minting status after claiming

Parameters:
Name Type Attributes Description
marketplaceParams Object

Parameters of the marketplace

sku string

The SKU of the item to claim

email string <optional>

Email address of the user. If specified, this will bind the user to the tenant of the specified marketplace

Source:

static ClaimStatus({
marketplaceParams,
sku
})
→ Promise.<Object>

Return status of the specified item claim

Returns: The minting status of the claim
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

sku string

The SKU of the item claimed

Source:

static CollectionRedemptionStatus({
marketplaceParams,
confirmationId
})
→ Promise.<Object>

Return status of the specified collection redemption

Returns: The status of the collection redemption
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

confirmationId string

The confirmation ID of the redemption

Source:

static CreateListing({
contractAddress,
tokenId,
price,
listingIdoptional
})
→ Promise.<string>

Requires login

Create or update a listing for the specified item

Returns: The listing ID of the created listing
Parameters:
Name Type Attributes Description
contractAddress string

The NFT contract address of the item

tokenId string

The token ID of the item

price number

The price of the listing, in USD

listingId string <optional>

(When editing a listing) The ID of the existing listing

Source:

static CreateMarketplaceOffer({
contractAddress,
tokenId,
offerIdoptional,
price,
expiresAtoptional
})
→ Promise.<Object>

Requires login

Create or update an offer on the specified NFT

Returns: Info about the created/updated offer
Parameters:
Name Type Attributes Description
contractAddress string

The contract address of the NFT

tokenId string

The token ID of the NFT

offerId string <optional>

IF modifying an existing offer, the ID of the offer

price number

The amount to offer

expiresAt number <optional>

The time (in epoch ms) the offer will expire

Source:

static EntitlementClaimStatus({
marketplaceParams,
purchaseId
})
→ Promise.<Object>

Return status of the specified entitlement claim

Returns: The mint status of the entitlement claim
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

purchaseId string

The purchase ID of the entitlement, for confirmation of status

Source:

static ExchangeRate({currency})

Retrieve the current exchange rate for the specified currency to USD

Parameters:
Name Type Description
currency string

The currency for which to retrieve the USD exchange rate

Source:

static GiftClaimStatus({
marketplaceParams,
confirmationIdoptional,
giftIdoptional
})
→ Promise.<Object>

Return status of the specified gift claim

Returns: The transfer status of the gift claim
Parameters:
Name Type Attributes Description
marketplaceParams Object

Parameters of the marketplace

confirmationId string <optional>

The confirmation ID of the gift purchase

giftId string <optional>

The ID of the claimed gift

Source:

static Leaderboard({
marketplaceParamsoptional,
userAddressoptional,
startoptional,
limitoptional
})
→ Promise.<(Array|Object)>

Get the leaderboard rankings for the specified marketplace. If user address is specified, will return the ranking for the specified user (if present)

Returns: Returns a list of leaderboard rankings or, if userAddress is specified, ranking for that user.
Parameters:
Name Type Attributes Default Description
marketplaceParams Object <optional>

Filter results by marketplace

userAddress string <optional>

Retrieve the ranking for a specific user

start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

Source:

static Listing({listingIdoptional}) → Promise.<Object>

Retrieve a specific listing

NOTE: When a listing is sold or deleted, it will no longer be queryable with this API. Use ListingStatus instead.

Returns: The listing
Parameters:
Name Type Attributes Description
listingId string <optional>

The ID of the listing

Source:

static ListingAttributes({
marketplaceParamsoptional,
displayNameoptional
})
→ Promise.<Array.<String>>

Retrieve names of all valid attributes for listed items. Full attribute names and values are required for filtering listing results by attributes.

Specify marketplace information to filter the results to only items offered in that marketplace.

Returns: A list of valid attributes
Parameters:
Name Type Attributes Description
marketplaceParams Object <optional>

Parameters of a marketplace to filter results by

displayName string <optional>

Display name of the item from which to request attributes

Source:

static ListingEditionNames({displayName}) → Promise.<Array.<String>>

Retrieve all valid edition names of the specified item. Full item edition names are required for filtering listing results by edition.

Returns: A list of item editions
Parameters:
Name Type Description
displayName string

Display name of the item from which to request edition names

Source:

static ListingNames({marketplaceParams}) → Promise.<Array.<String>>

Retrieve all valid names for filtering listings. Full item names are required for filtering listing results by name.

Specify marketplace information to filter the results to only items offered in that marketplace.

Returns: A list of item names
Parameters:
Name Type Description
marketplaceParams Object

Parameters of a marketplace to filter results by

Source:

static ListingPurchaseStatus({
listingId,
confirmationId
})
→ Promise.<Object>

Return status of the specified listing purchase

Returns: The status of the purchase
Parameters:
Name Type Description
listingId string

The ID of the listing

confirmationId string

The confirmation ID of the purchase

Source:

static ListingStats({
startoptional,
limitoptional,
sortByoptional,
sortDescoptional,
filteroptional,
editionFilters,
attributeFilters,
priceRangeoptional,
sellerAddressoptional,
contractAddressoptional,
tokenIdoptional,
currencyoptional,
marketplaceParamsoptional,
collectionIndexesoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional
})
→ Promise.<Object>

Retrieve stats for listings matching the specified parameters.

Returns: Statistics about listings. All prices in USD.
Parameters:
Name Type Attributes Default Description
start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

sortBy string <optional>
"created"

Sort order. Options: created, info/token_id, info/ordinal, price, nft/display_name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

filter string <optional>

Filter results by item name.

NOTE: This string must be an exact match on the item name. You can retrieve all available item names from the ListingNames method.

editionFilters Array.<string>

Filter results by item edition.

NOTE: This string must be an exact match on the edition name. You can retrieve all available item edition names from the ListingEditionNames method.

attributeFilters Array.<Object>

Filter results by item attributes. Each entry should include name and value (e.g. [{name: "attribute-name", value: "attribute-value"}])

NOTE: These filters must be an exact match on the attribute name and value. You can retrieve all available item attributes from the ListingAttributes method.

priceRange Object <optional>

Filter min and/or max price (e.g. {min: 1} {max: 2} `{min: 1.50, max: 10.50})

sellerAddress string <optional>

Filter by a specific seller

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

currency string <optional>

Filter results by purchase currency. Available options: usdc

marketplaceParams Object <optional>

Filter results by marketplace

collectionIndexes Array.<integer> <optional>

If filtering by marketplace, filter by collection(s). The index refers to the index in the array marketplace.collections

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

Source:

static ListingStatus({listingIdoptional}) → Promise.<Object>

Retrieve the status of the specified listing

Returns: The status of the listing
Parameters:
Name Type Attributes Description
listingId string <optional>

The ID of the listing

Source:

static Listings({
startoptional,
limitoptional,
sortByoptional,
sortDescoptional,
filteroptional,
editionFiltersoptional,
attributeFilters,
priceRangeoptional,
sellerAddressoptional,
contractAddressoptional,
tokenIdoptional,
currencyoptional,
marketplaceParamsoptional,
collectionIndexesoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional,
includeCheckoutLockedoptional
})
→ Promise.<Object>

Retrieve listings matching the specified parameters.

Returns: Results of the query and pagination info
Parameters:
Name Type Attributes Default Description
start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

sortBy string <optional>
"created"

Sort order. Options: created, info/token_id, info/ordinal, price, nft/display_name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

filter string <optional>

Filter results by item name.

NOTE: This string must be an exact match on the item name. You can retrieve all available item names from the ListingNames method.

editionFilters Array.<string> <optional>

Filter results by item edition.

NOTE: This string must be an exact match on the edition name. You can retrieve all available item edition names from the ListingEditionNames method.

attributeFilters Array.<Object>

Filter results by item attributes. Each entry should include name and value (e.g. [{name: "attribute-name", value: "attribute-value"}])

NOTE: These filters must be an exact match on the attribute name and value. You can retrieve all available item attributes from the ListingAttributes method.

priceRange Object <optional>

Filter min and/or max price (e.g. {min: 1} {max: 2} `{min: 1.50, max: 10.50})

sellerAddress string <optional>

Filter by a specific seller

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

currency string <optional>

Filter results by purchase currency. Available options: usdc

marketplaceParams Object <optional>

Filter results by marketplace

collectionIndexes Array.<integer> <optional>

If filtering by marketplace, filter by collection(s). The index refers to the index in the array marketplace.collections

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

includeCheckoutLocked boolean <optional>

If specified, listings which are currently in the checkout process (and not so currently purchasable) will be included in the results. By default they are excluded.

Source:

static Marketplace({marketplaceParams}) → Promise.<Object>

Retrieve full information about the specified marketplace

Note - Upon changing login state, the marketplace should be retrieved again as permission info in marketplace items may be different depending on the current user's permissions.

Returns: The full information for the marketplace
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

Source:

static MarketplaceCSS({marketplaceParams}) → Promise.<string>

Retrieve custom CSS for the specified marketplace

Returns: The CSS of the marketplace
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

Source:

static MarketplaceInfo({marketplaceParams}) → Promise.<Object>

Retrieve basic information about a specific available marketplace with the specified tenant/marketplace slug, ID, or hash.

Includes the slugs, ID and hash of the marketplace, as well as branding information.

To retrieve full metadata for the marketplace, use the Marketplace method.

Returns: Info about the marketplace
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

Source:

static MarketplaceOffers({
contractAddressoptional,
tokenIdoptional,
buyerAddressoptional,
sellerAddressoptional,
statusesoptional,
start,
limitoptional
})
→ Promise.<Array.<Object>>

Retrieve offers for the specified parameters

Returns: Offers matching the specified filters
Parameters:
Name Type Attributes Default Description
contractAddress string <optional>

The address of an NFT contract

tokenId string <optional>

The token ID of an NFT

buyerAddress string <optional>

The address of the offerrer

sellerAddress string <optional>

The address of the offerree

statuses Array.<String> <optional>

Status to filter results by. Allowed values: "ACTIVE", "ACCEPTED", "CANCELLED", "DECLINED", "INVALID"

start number 0

The index to start from

limit number <optional>
10

The maximum number of results to return

Source:

static MarketplaceStock({marketplaceParams}) → Promise.<Object>

Retrieve available stock for the specified marketplace, organized by SKU.

If a user is logged in, stock information will also include how many of that item the user has purchased.

Returns: Stock info for items in the marketplace
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

Source:

static NFT({
contractAddress,
tokenId
})

Load full info for the specified NFT

Parameters:
Name Type Description
contractAddress string

The contract address of the NFT

tokenId string

The token ID of the NFT

Source:

static NFTContractStats({contractAddress}) → Promise.<Object>

Return info about the specified NFT contract, including the cap, current total supply, and total minted and burned.

Returns: Information about the specified contract
Parameters:
Name Type Description
contractAddress string

The contract address of the NFT

Source:

static PackOpenStatus({
contractAddress,
tokenId
})
→ Promise.<Object>

Return status of the specified pack opening

Returns: The status of the pack opening
Parameters:
Name Type Description
contractAddress string

The NFT contract address of the opened pack

tokenId string

The token ID of the opened pack

Source:

static PurchaseItem({
marketplaceParams,
sku,
confirmationIdoptional,
successUrl,
cancelUrl
})

Redirect to the wallet app to purchase the specified item from the specified marketplace

Use the PurchaseStatus method to check minting status after purchasing

Parameters:
Name Type Attributes Description
marketplaceParams Object

Parameters of the marketplace

sku string

The SKU of the item to claim

confirmationId string <optional>

Confirmation ID with which to reference this purchase. If not specified, a confirmation ID will be automatically generated. On success, the user will be returned to successUrl with the confirmationId as a URL parameter.

successUrl string

The URL to redirect back to upon successful purchase

cancelUrl string

The URL to redirect back to upon cancellation of purchase

Source:

static PurchaseListing({
marketplaceParamsoptional,
listingId,
confirmationIdoptional,
successUrl,
cancelUrl
})

Redirect to the wallet app to purchase the specified listing

Use the ListingPurchaseStatus method to check minting status after purchasing

Parameters:
Name Type Attributes Description
marketplaceParams Object <optional>

Parameters of the marketplace

listingId string

The SKU of the item to claim

confirmationId string <optional>

Confirmation ID with which to reference this purchase. If not specified, a confirmation ID will be automatically generated. On success, the user will be returned to successUrl with the confirmationId as a URL parameter.

successUrl string

The URL to redirect back to upon successful purchase

cancelUrl string

The URL to redirect back to upon cancellation of purchase

Source:

static PurchaseStatus({
marketplaceParams,
confirmationId
})
→ Promise.<Object>

Return status of the specified marketplace purchase

Returns: The minting status of the purchaseed item(s)
Parameters:
Name Type Description
marketplaceParams Object

Parameters of the marketplace

confirmationId string

The confirmation ID of the purchase

Source:

static RedeemableOfferStatus({
tenantIdoptional,
marketplaceParamsoptional,
contractAddress,
tokenId,
offerId
})
→ Promise.<Object>

Return status of the specified redeemable offer

Returns: The status of the offer redemption
Parameters:
Name Type Attributes Description
tenantId string <optional>

ID of the tenant for this NFT (not required if marketplaceParams is specified)

marketplaceParams Object <optional>

Parameters of the marketplace for this NFT (not required if tenantId is specified)

contractAddress string

The address of the NFT contract

tokenId string

The token ID of the NFT

offerId string

The ID of the offer

Source:

static RejectMarketplaceOffer({offerId})

Requires login

Reject the specified offer

Parameters:
Name Type Description
offerId string

The ID of the offer

Source:

static RemoveListing({listingId})

Requires login

Remove the specified listing

Parameters:
Name Type Description
listingId string

The ID of the listing to remove

Source:

static RemoveMarketplaceOffer({offerId})

Requires login

Cancel the specified offer

Parameters:
Name Type Description
offerId string

The ID of the offer

Source:

static RevokeVote({
tenantId,
votingEventId,
sku
})
→ Promise.<Object>

Requires login

Revoke a previously cast vote for the specified item in the specified voting event

Returns: Info about the voting event, including the current user's votes and the current total voting tally
Parameters:
Name Type Description
tenantId string

The tenant ID of the marketplace in which the voting event is specified

votingEventId string

The ID of the voting event

sku string

The SKU of the item to vote for

Source:

static Sales({
startoptional,
limitoptional,
sortByoptional,
sortDescoptional,
filteroptional,
editionFilters,
attributeFilters,
sellerAddressoptional,
contractAddressoptional,
tokenIdoptional,
currencyoptional,
marketplaceParamsoptional,
collectionIndexesoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional
})
→ Promise.<Object>

Retrieve sales matching the specified parameters.

Returns: Results of the query and pagination info
Parameters:
Name Type Attributes Default Description
start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

sortBy string <optional>
"created"

Sort order. Options: created, price, name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

filter string <optional>

Filter results by item name.

NOTE: This string must be an exact match on the item name. You can retrieve all available item names from the ListingNames method.

editionFilters Array.<string>

Filter results by item edition.

NOTE: This string must be an exact match on the edition name. You can retrieve all available item edition names from the ListingEditionNames method.

attributeFilters Array.<Object>

Filter results by item attributes. Each entry should include name and value (e.g. [{name: "attribute-name", value: "attribute-value"}])

NOTE: These filters must be an exact match on the attribute name and value. You can retrieve all available item attributes from the ListingAttributes method.

sellerAddress string <optional>

Filter by a specific seller

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

currency string <optional>

Filter results by purchase currency. Available options: usdc

marketplaceParams Object <optional>

Filter results by marketplace

collectionIndexes Array.<integer> <optional>

If filtering by marketplace, filter by collection(s). The index refers to the index in the array marketplace.collections

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

Source:

static SalesNames({marketplaceParams}) → Promise.<Array.<String>>

Retrieve all valid names for filtering listing sales names. Full item names are required for filtering sales results by name.

Specify marketplace information to filter the results to only items offered in that marketplace.

Returns: A list of item names
Parameters:
Name Type Description
marketplaceParams Object

Parameters of a marketplace to filter results by

Source:

static SalesStats({
startoptional,
limitoptional,
sortByoptional,
sortDescoptional,
filteroptional,
editionFilters,
attributeFilters,
sellerAddressoptional,
contractAddressoptional,
tokenIdoptional,
currencyoptional,
marketplaceParamsoptional,
collectionIndexesoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional
})
→ Promise.<Object>

Retrieve stats for listings matching the specified parameters.

Returns: Statistics about sales. All prices in USD.
Parameters:
Name Type Attributes Default Description
start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

sortBy string <optional>
"created"
sortDesc boolean <optional>
false

Sort results descending instead of ascending

filter string <optional>

Filter results by item name.

NOTE: This string must be an exact match on the item name. You can retrieve all available item names from the ListingNames method.

editionFilters Array.<string>

Filter results by item edition.

NOTE: This string must be an exact match on the edition name. You can retrieve all available item edition names from the ListingEditionNames method.

attributeFilters Array.<Object>

Filter results by item attributes. Each entry should include name and value (e.g. [{name: "attribute-name", value: "attribute-value"}])

NOTE: These filters must be an exact match on the attribute name and value. You can retrieve all available item attributes from the ListingAttributes method.

sellerAddress string <optional>

Filter by a specific seller

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

currency string <optional>

Filter results by purchase currency. Available options: usdc

marketplaceParams Object <optional>

Filter results by marketplace

collectionIndexes Array.<integer> <optional>

If filtering by marketplace, filter by collection(s). The index refers to the index in the array marketplace.collections

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

Source:

static TenantCSS({tenantSlug}) → Promise.<string>

Retrieve custom CSS for the specified tenant

Returns: The CSS of the tenant
Parameters:
Name Type Description
tenantSlug Object
Source:

static TenantConfiguration({
tenantIdoptional,
contractAddressoptional
})
→ Promise.<Object>

Retrieve configuration information about the specified tenant, or the tenant associated with the specified contract.

This information includes the royalty rate the tenant receives for secondary sales.

Returns: The tenant configuration
Parameters:
Name Type Attributes Description
tenantId string <optional>

The ID of the tenant for which to retrieve configuration

contractAddress string <optional>

The ID of an nft contract for which to retrieve configuration

Source:

static TransferNFT({
contractAddress,
tokenId,
targetAddress
})

Requires login

Transfer the specified NFT owned by the current user to the specified address

Parameters:
Name Type Description
contractAddress string

The contract address of the NFT

tokenId string

The token ID of the NFT

targetAddress string

The address to which to transfer the NFT

Source:

static Transfers({
startoptional,
limitoptional,
sortByoptional,
sortDescoptional,
filteroptional,
editionFilters,
attributeFilters,
sellerAddressoptional,
contractAddressoptional,
tokenIdoptional,
currencyoptional,
marketplaceParamsoptional,
collectionIndexesoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional
})
→ Promise.<Object>

Retrieve sales and transfers matching the specified parameters.

Returns: Results of the query and pagination info
Parameters:
Name Type Attributes Default Description
start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

sortBy string <optional>
"created"

Sort order. Options: created, price, name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

filter string <optional>

Filter results by item name.

NOTE: This string must be an exact match on the item name. You can retrieve all available item names from the ListingNames method.

editionFilters Array.<string>

Filter results by item edition.

NOTE: This string must be an exact match on the edition name. You can retrieve all available item edition names from the ListingEditionNames method.

attributeFilters Array.<Object>

Filter results by item attributes. Each entry should include name and value (e.g. [{name: "attribute-name", value: "attribute-value"}])

NOTE: These filters must be an exact match on the attribute name and value. You can retrieve all available item attributes from the ListingAttributes method.

sellerAddress string <optional>

Filter by a specific seller

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

currency string <optional>

Filter results by purchase currency. Available options: usdc

marketplaceParams Object <optional>

Filter results by marketplace

collectionIndexes Array.<integer> <optional>

If filtering by marketplace, filter by collection(s). The index refers to the index in the array marketplace.collections

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

Source:

static UserAddress() → string

Requires login

Retrieve the address of the current user.

Returns: The address of the current user
Source:

static UserInfo() → Object

Requires login

Retrieve information about the user, including the address, wallet type, and (for custodial users) email address.

Returns: User info
Source:

static UserItemAttributes({
userAddressoptional,
displayNameoptional,
marketplaceParamsoptional
})
→ Promise.<Array.<String>>

Retrieve all valid attribute names and values. Full attribute names and values are required for filtering results by attribute.

Specify marketplace information to filter the results to only items offered in that marketplace.

Returns: A list of item names
Parameters:
Name Type Attributes Description
userAddress string <optional>

Address of a user

displayName string <optional>

Name of an item

marketplaceParams Object <optional>

Parameters of a marketplace to filter results by

Source:

static UserItemEditionNames({displayName}) → Promise.<Array.<String>>

Retrieve all valid edition names for filtering the specified item. Full edition names are required for filtering results by edition.

Specify marketplace information to filter the results to only items offered in that marketplace.

Returns: A list of item editions
Parameters:
Name Type Description
displayName string

Name of an item

Source:

static UserItemNames({
userAddressoptional,
marketplaceParamsoptional
})
→ Promise.<Array.<String>>

Retrieve all valid names for filtering user items. Full item names are required for filtering results by name.

Specify marketplace information to filter the results to only items offered in that marketplace.

Returns: A list of item names
Parameters:
Name Type Attributes Description
userAddress string <optional>

Address of a user

marketplaceParams Object <optional>

Parameters of a marketplace to filter results by

Source:

static UserItems({
includeFullMetadataoptional,
userAddressoptional,
startoptional,
limitoptional,
sortByoptional,
sortDescoptional,
filteroptional,
contractAddressoptional,
tokenIdoptional,
marketplaceParamsoptional,
collectionIndexesoptional
})
→ Promise.<Object>

Requires login

Retrieve items owned by the specified or current user matching the specified parameters.

Returns: Results of the query and pagination info
Parameters:
Name Type Attributes Default Description
includeFullMetadata boolean <optional>
false

If true, will include full metadata for each item. Ignored if not logged in.

userAddress string <optional>

Address of a user. If not specified, will return results for current user

start integer <optional>
0

PAGINATION: Index from which the results should start

limit integer <optional>
50

PAGINATION: Maximum number of results to return

sortBy string <optional>
"default"

Sort order. Options: default, meta/display_name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

filter string <optional>

Filter results by item name.

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

marketplaceParams Object <optional>

Filter results by marketplace

collectionIndexes Array.<integer> <optional>

If filtering by marketplace, filter by collection(s). The index refers to the index in the array marketplace.collections

Source:

static UserListings({
userAddressoptional,
sortByoptional,
sortDescoptional,
marketplaceParamsoptional,
contractAddressoptional,
tokenIdoptional
})
→ Promise.<Array.<Object>>

Return all listings for the current user. Not paginated.

Returns: List of current user's listings
Parameters:
Name Type Attributes Default Description
userAddress string <optional>

Address of a user. If not specified, will return results for current user

sortBy string <optional>
"created"

Sort order. Options: created, info/token_id, info/ordinal, price, nft/display_name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

marketplaceParams Object <optional>

Filter results by marketplace

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

Source:

static UserSales({
userAddressoptional,
sortByoptional,
sortDescoptional,
marketplaceParamsoptional,
contractAddressoptional,
tokenIdoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional
})
→ Promise.<Array.<Object>>

Return all sales for the current user. Not paginated.

Returns: List of current user's sales
Parameters:
Name Type Attributes Default Description
userAddress string <optional>

Address of a user. If not specified, will return results for current user

sortBy string <optional>
"created"

Sort order. Options: created, price, name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

marketplaceParams Object <optional>

Filter results by marketplace

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

Source:

static UserTransfers({
userAddressoptional,
sortByoptional,
sortDescoptional,
marketplaceParamsoptional,
contractAddressoptional,
tokenIdoptional,
startTimeoptional,
endTimeoptional,
lastNDaysoptional
})
→ Promise.<Array.<Object>>

Return all transfers and sales for the current user. Not paginated.

Returns: List of current user's sales
Parameters:
Name Type Attributes Default Description
userAddress string <optional>

Address of a user. If not specified, will return results for current user

sortBy string <optional>
"created"

Sort order. Options: created, price, name

sortDesc boolean <optional>
false

Sort results descending instead of ascending

marketplaceParams Object <optional>

Filter results by marketplace

contractAddress string <optional>

Filter results by the address of the NFT contract

tokenId string <optional>

Filter by token ID (if filtering by contract address)

startTime integer <optional>

Filter by results listed after the specified time (in milliseconds since epoch)

endTime integer <optional>

Filter by results listed before the specified time (in milliseconds since epoch)

lastNDays integer <optional>

Filter by results listed in the past N days

Source:

static UserWalletBalance() → Promise.<Object>

Requires login

Retrieve the fund balances for the current user

Returns: Returns balances for the user. All values are in USD.
  • - totalWalletBalance - Total balance of the users sales and wallet balance purchases
  • - availableWalletBalance - Balance available for purchasing items
  • - pendingWalletBalance - Balance unavailable for purchasing items
  • - withdrawableWalletBalance - Amount that is available for withdrawal
  • - usedBalance - (Only included if user has set up Solana link with the Phantom wallet) Available USDC balance of the user's Solana wallet
Source:

static VoteStatus({
tenantId,
votingEventId
})
→ Promise.<Object>

Retrieve the current status of the specified voting event

Returns: Info about the voting event, including the current user's votes and the current total voting tally
Parameters:
Name Type Description
tenantId string

The tenant ID of the marketplace in which the voting event is specified

votingEventId string

The ID of the voting event

Source: