From cdffe4784a1264ad2641ee6d61818952e45c2e5d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Mon, 15 Jul 2024 15:01:38 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20ProjectO?= =?UTF-8?q?penSea/opensea-js@b8eb2178af4d0799a362e7992cc63ad4227b340e=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/OpenSeaSDK.html | 46 +++++++++---------- enums/Chain.html | 52 ++++++++++----------- enums/CollectionOrderByOption.html | 4 +- enums/EventType.html | 22 ++++----- enums/OrderSide.html | 4 +- enums/OrderType.html | 4 +- enums/SafelistStatus.html | 4 +- enums/TokenStandard.html | 4 +- enums/TraitDisplayType.html | 6 +-- interfaces/Asset.html | 12 ++--- interfaces/AssetWithTokenId.html | 12 ++--- interfaces/AssetWithTokenStandard.html | 12 ++--- interfaces/EventData.html | 14 +++--- interfaces/Fee.html | 4 +- interfaces/GetCollectionsArgs.html | 4 +- interfaces/OpenSeaAPIConfig.html | 4 +- interfaces/OpenSeaAccount.html | 4 +- interfaces/OpenSeaCollection.html | 56 +++++++++++------------ interfaces/OpenSeaCollectionStats.html | 4 +- interfaces/OpenSeaPaymentToken.html | 4 +- interfaces/OpenSeaPaymentTokensQuery.html | 4 +- interfaces/RarityStrategy.html | 4 +- interfaces/SocialMediaAccount.html | 4 +- types/BuildOfferResponse.html | 2 +- types/CancelOrderResponse.html | 2 +- types/CollectionOffer.html | 2 +- types/FulfillmentDataResponse.html | 2 +- types/GetBestListingResponse.html | 2 +- types/GetBestOfferResponse.html | 2 +- types/GetCollectionResponse.html | 2 +- types/GetCollectionsResponse.html | 2 +- types/GetListingsResponse.html | 2 +- types/GetNFTResponse.html | 2 +- types/GetOffersResponse.html | 2 +- types/GetOrdersResponse.html | 2 +- types/ListCollectionOffersResponse.html | 2 +- types/ListNFTsResponse.html | 2 +- types/Listing.html | 2 +- types/NFT.html | 2 +- types/Offer.html | 2 +- types/Order.html | 2 +- types/OrderAPIOptions.html | 2 +- types/OrderProtocol.html | 2 +- types/OrderV2.html | 2 +- types/OrdersPostQueryResponse.html | 2 +- types/OrdersQueryOptions.html | 2 +- types/OrdersQueryResponse.html | 2 +- types/Price.html | 2 +- types/ProtocolData.html | 2 +- types/QueryCursors.html | 2 +- types/QueryCursorsV2.html | 2 +- types/SerializedOrderV2.html | 2 +- types/Trait.html | 2 +- 53 files changed, 174 insertions(+), 174 deletions(-) diff --git a/classes/OpenSeaSDK.html b/classes/OpenSeaSDK.html index 38622dc13..71d0d75e3 100644 --- a/classes/OpenSeaSDK.html +++ b/classes/OpenSeaSDK.html @@ -1,5 +1,5 @@ OpenSeaSDK | opensea-js - v7.1.12

Class OpenSeaSDK

The OpenSea SDK main class.

-

Constructors

constructor +

Constructors

constructor

Properties

api chain logger @@ -27,32 +27,32 @@ new ethers.Wallet(privKey, provider)

  • apiConfig: OpenSeaAPIConfig = {}

    configuration options, including chain

  • Optional logger: ((arg) => void)

    optional function for logging debug strings. defaults to no logging

    -
      • (arg): void

      • Parameters

        • arg: string

        Returns void

    • Returns OpenSeaSDK

    Properties

    Readonly api

    api: OpenSeaAPI

    API instance

    -

    Readonly chain

    chain: Chain

    The configured chain

    -

    logger

    logger: ((arg) => void)

    Logger function to use when debugging

    -

    Type declaration

      • (arg): void

      • Parameters

        • arg: string

        Returns void

    provider

    provider: JsonRpcProvider

    Provider to use for transactions.

    -

    seaport_v1_5

    seaport_v1_5: Seaport

    Seaport v1.5 client

    +
      • (arg): void

      • Parameters

        • arg: string

        Returns void

    Returns OpenSeaSDK

    Properties

    Readonly api

    api: OpenSeaAPI

    API instance

    +

    Readonly chain

    chain: Chain

    The configured chain

    +

    logger

    logger: ((arg) => void)

    Logger function to use when debugging

    +

    Type declaration

      • (arg): void

      • Parameters

        • arg: string

        Returns void

    provider

    provider: JsonRpcProvider

    Provider to use for transactions.

    +

    seaport_v1_5

    seaport_v1_5: Seaport

    Seaport v1.5 client

    See

    https://github.com/ProjectOpenSea/seaport-js

    -

    seaport_v1_6

    seaport_v1_6: Seaport

    Seaport v1.6 client

    +

    seaport_v1_6

    seaport_v1_6: Seaport

    Seaport v1.6 client

    See

    https://github.com/ProjectOpenSea/seaport-js

    -

    Methods

    addListener

    • addListener(event, listener, once?): void

    • Add a listener for events emitted by the SDK.

      +

    Methods

    addListener

    • addListener(event, listener, once?): void

    • Add a listener for events emitted by the SDK.

      Parameters

      • event: EventType

        The EventType to listen to.

      • listener: ((data) => void)

        A callback that will accept an object with EventData\

          • (data): void

          • Parameters

            Returns void

      • once: boolean = false

        Whether the listener should only be called once, or continue listening until removed.

        -

      Returns void

    approveOrder

    • approveOrder(order, domain?): Promise<string>

    • Instead of signing an off-chain order, this methods allows you to approve an order +

    Returns void

    approveOrder

    • approveOrder(order, domain?): Promise<string>

    • Instead of signing an off-chain order, this methods allows you to approve an order with on on-chain transaction.

      Parameters

      • order: OrderV2

        Order to approve

      • Optional domain: string

        An optional domain to be hashed and included at the end of fulfillment calldata. This can be used for on-chain order attribution to assist with analytics.

      Returns Promise<string>

      Transaction hash of the approval transaction

      Throws

      Error if the accountAddress is not available through wallet or provider.

      Throws

      Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.

      -

    cancelOrder

    • cancelOrder(options): Promise<void>

    • Cancel an order onchain, preventing it from ever being fulfilled.

      +

    cancelOrder

    • cancelOrder(options): Promise<void>

    • Cancel an order onchain, preventing it from ever being fulfilled.

      Parameters

      • options: {
            accountAddress: string;
            domain?: string;
            order: OrderV2;
        }
        • accountAddress: string

          The account address that will be cancelling the order.

        • Optional domain?: string

          An optional domain to be hashed and included at the end of fulfillment calldata. This can be used for on-chain order attribution to assist with analytics.

        • order: OrderV2

          The order to cancel

      Returns Promise<void>

      Throws

      Error if the accountAddress is not available through wallet or provider.

      Throws

      Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.

      -

    createCollectionOffer

    createCollectionOffer

    • createCollectionOffer(options): Promise<null | CollectionOffer>

    • Create and submit a collection offer.

      Parameters

      • options: {
            accountAddress: string;
            amount: BigNumberish;
            collectionSlug: string;
            domain?: string;
            excludeOptionalCreatorFees?: boolean;
            expirationTime?: string | number;
            offerProtectionEnabled?: boolean;
            paymentTokenAddress: string;
            quantity: number;
            salt?: BigNumberish;
            traitType?: string;
            traitValue?: string;
        }
        • accountAddress: string

          Address of the wallet making the offer.

        • amount: BigNumberish

          Value of the offer in units, not base units e.g. not wei, of the payment token (or WETH if no payment token address specified).

        • collectionSlug: string

          Identifier for the collection.

          @@ -66,7 +66,7 @@

          Throws

          Error if the order's protocol address is not supported by

        • Optional traitType?: string

          If defined, the trait name to create the collection offer for.

        • Optional traitValue?: string

          If defined, the trait value to create the collection offer for.

      Returns Promise<null | CollectionOffer>

      The CollectionOffer that was created.

      -

    createListing

    • createListing(options): Promise<OrderV2>

    • Create and submit a listing for an asset.

      +

    createListing

    • createListing(options): Promise<OrderV2>

    • Create and submit a listing for an asset.

      Parameters

      • options: {
            accountAddress: string;
            asset: AssetWithTokenId;
            buyerAddress?: string;
            domain?: string;
            endAmount?: BigNumberish;
            englishAuction?: boolean;
            excludeOptionalCreatorFees?: boolean;
            expirationTime?: number;
            listingTime?: number;
            paymentTokenAddress?: string;
            quantity?: BigNumberish;
            salt?: BigNumberish;
            startAmount: BigNumberish;
            zone?: string;
        }
        • accountAddress: string

          Address of the wallet making the listing

        • asset: AssetWithTokenId

          The asset to trade. tokenAddress and tokenId must be defined.

        • Optional buyerAddress?: string

          Optional address that's allowed to purchase this item. If specified, no other address will be able to take the order, unless its value is the null address.

          @@ -86,7 +86,7 @@

          Throws

          Error if the order's protocol address is not supported by

          Throws

          Error if the accountAddress is not available through wallet or provider.

          Throws

          Error if the startAmount is not greater than 0.

          Throws

          Error if paymentTokenAddress is not WETH on anything other than Ethereum mainnet.

          -

    createOffer

    • createOffer(options): Promise<OrderV2>

    • Create and submit an offer on an asset.

      +

    createOffer

    • createOffer(options): Promise<OrderV2>

    • Create and submit an offer on an asset.

      Parameters

      • options: {
            accountAddress: string;
            asset: AssetWithTokenId;
            domain?: string;
            excludeOptionalCreatorFees?: boolean;
            expirationTime?: BigNumberish;
            paymentTokenAddress?: string;
            quantity?: BigNumberish;
            salt?: BigNumberish;
            startAmount: BigNumberish;
            zone?: string;
        }
        • accountAddress: string

          Address of the wallet making the offer.

        • asset: AssetWithTokenId

          The asset to trade. tokenAddress and tokenId must be defined.

        • Optional domain?: string

          An optional domain to be hashed and included in the first four bytes of the random salt.

          @@ -102,7 +102,7 @@

          Throws

          Error if paymentTokenAddress is not WETH on anything other tha

          Throws

          Error if the accountAddress is not available through wallet or provider.

          Throws

          Error if the startAmount is not greater than 0.

          Throws

          Error if paymentTokenAddress is not WETH on anything other than Ethereum mainnet.

          -

    fulfillOrder

    • fulfillOrder(options): Promise<string>

    • Fulfill an order for an asset. The order can be either a listing or an offer.

      +

    fulfillOrder

    • fulfillOrder(options): Promise<string>

    • Fulfill an order for an asset. The order can be either a listing or an offer.

      Parameters

      • options: {
            accountAddress: string;
            domain?: string;
            order: OrderV2 | Order;
            overrides?: Overrides;
            recipientAddress?: string;
        }
        • accountAddress: string

          Address of the wallet taking the offer.

        • Optional domain?: string

          An optional domain to be hashed and included at the end of fulfillment calldata. This can be used for on-chain order attribution to assist with analytics.

        • order: OrderV2 | Order

          The order to fulfill, a.k.a. "take"

          @@ -112,12 +112,12 @@

          Throws

          Error if paymentTokenAddress is not WETH on anything other tha

          Throws

          Error if the accountAddress is not available through wallet or provider.

          Throws

          Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.

          Throws

          Error if attempting to fulfill the order with a recipient address which does not match a private listing.

          -

    getBalance

    • getBalance(options): Promise<bigint>

    • Get an account's balance of any Asset. This asset can be an ERC20, ERC1155, or ERC721.

      +

    getBalance

    • getBalance(options): Promise<bigint>

    • Get an account's balance of any Asset. This asset can be an ERC20, ERC1155, or ERC721.

      Parameters

      Returns Promise<bigint>

      The balance of the asset for the account.

      Throws

      Error if the token standard does not support balanceOf.

      -

    isOrderFulfillable

    • isOrderFulfillable(options): Promise<boolean>

    • Returns whether an order is fulfillable. +

    isOrderFulfillable

    • isOrderFulfillable(options): Promise<boolean>

    • Returns whether an order is fulfillable. An order may not be fulfillable if a target item's transfer function is locked for some reason, e.g. an item is being rented within a game or trading has been locked for an item type.

      @@ -125,7 +125,7 @@

      Throws

      Error if attempting to fulfill the order with a recipient addr

    • order: OrderV2

      Order to check

    Returns Promise<boolean>

    True if the order is fulfillable, else False.

    Throws

    Error if the order's protocol address is not supported by OpenSea. See isValidProtocol.

    -

    offchainCancelOrder

    offchainCancelOrder

    removeAllListeners

    removeAllListeners

    removeListener

    Returns void

    removeListener

    transfer

    Returns void

    transfer

    unwrapWeth

    Returns Promise<void>

    unwrapWeth

    wrapEth

    Returns Promise<void>

    wrapEth

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapichainloggerproviderseaport_v1_5seaport_v1_6addListenerapproveOrdercancelOrdercreateCollectionOffercreateListingcreateOfferfulfillOrdergetBalanceisOrderFulfillableoffchainCancelOrderremoveAllListenersremoveListenertransferunwrapWethwrapEth
    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorapichainloggerproviderseaport_v1_5seaport_v1_6addListenerapproveOrdercancelOrdercreateCollectionOffercreateListingcreateOfferfulfillOrdergetBalanceisOrderFulfillableoffchainCancelOrderremoveAllListenersremoveListenertransferunwrapWethwrapEth
    \ No newline at end of file diff --git a/enums/Chain.html b/enums/Chain.html index fc142e2b1..0a0addc16 100644 --- a/enums/Chain.html +++ b/enums/Chain.html @@ -1,6 +1,6 @@ Chain | opensea-js - v7.1.12

    Enumeration Chain

    Each of the possible chains that OpenSea supports. ⚠️NOTE: When adding to this list, also add to the util functions getChainId and getWETHAddress

    -

    Enumeration Members

    Amoy +

    Enumeration Members

    Amoy Arbitrum ArbitrumNova ArbitrumSepolia @@ -26,28 +26,28 @@ Zora ZoraSepolia

    Enumeration Members

    Amoy

    Amoy: "amoy"

    Polygon Amoy

    -

    Arbitrum

    Arbitrum: "arbitrum"

    Arbitrum

    -

    ArbitrumNova

    ArbitrumNova: "arbitrum_nova"

    Arbitrum Nova

    -

    ArbitrumSepolia

    ArbitrumSepolia: "arbitrum_sepolia"

    Arbitrum Sepolia

    -

    Avalanche

    Avalanche: "avalanche"

    Avalanche

    -

    BNB

    BNB: "bsc"

    Binance Smart Chain

    -

    BNBTestnet

    BNBTestnet: "bsctestnet"

    Binance Smart Chain Testnet

    -

    Baobab

    Baobab: "baobab"

    Klaytn Baobab

    -

    Base

    Base: "base"

    Base

    -

    BaseSepolia

    BaseSepolia: "base_sepolia"

    Base Testnet

    -

    Blast

    Blast: "blast"

    Blast

    -

    BlastSepolia

    BlastSepolia: "blast_sepolia"

    Blast Testnet

    -

    Fuji

    Fuji: "avalanche_fuji"

    Avalanche Fuji

    -

    Klaytn

    Klaytn: "klaytn"

    Klaytn

    -

    Mainnet

    Mainnet: "ethereum"

    Ethereum

    -

    Optimism

    Optimism: "optimism"

    Optimism

    -

    OptimismSepolia

    OptimismSepolia: "optimism_sepolia"

    Optimism Sepolia

    -

    Polygon

    Polygon: "matic"

    Polygon

    -

    Sei

    Sei: "sei"

    Sei

    -

    SeiTestnet

    SeiTestnet: "sei_testnet"

    Sei Testnet

    -

    Sepolia

    Sepolia: "sepolia"

    Sepolia

    -

    Solana

    Solana: "solana"

    Solana

    -

    SolanaDevnet

    SolanaDevnet: "soldev"

    Solana Devnet

    -

    Zora

    Zora: "zora"

    Zora

    -

    ZoraSepolia

    ZoraSepolia: "zora_sepolia"

    Zora Sepolia

    -

    Settings

    Member Visibility

    Theme

    On This Page

    AmoyArbitrumArbitrumNovaArbitrumSepoliaAvalancheBNBBNBTestnetBaobabBaseBaseSepoliaBlastBlastSepoliaFujiKlaytnMainnetOptimismOptimismSepoliaPolygonSeiSeiTestnetSepoliaSolanaSolanaDevnetZoraZoraSepolia
    \ No newline at end of file +

    Arbitrum

    Arbitrum: "arbitrum"

    Arbitrum

    +

    ArbitrumNova

    ArbitrumNova: "arbitrum_nova"

    Arbitrum Nova

    +

    ArbitrumSepolia

    ArbitrumSepolia: "arbitrum_sepolia"

    Arbitrum Sepolia

    +

    Avalanche

    Avalanche: "avalanche"

    Avalanche

    +

    BNB

    BNB: "bsc"

    Binance Smart Chain

    +

    BNBTestnet

    BNBTestnet: "bsctestnet"

    Binance Smart Chain Testnet

    +

    Baobab

    Baobab: "baobab"

    Klaytn Baobab

    +

    Base

    Base: "base"

    Base

    +

    BaseSepolia

    BaseSepolia: "base_sepolia"

    Base Testnet

    +

    Blast

    Blast: "blast"

    Blast

    +

    BlastSepolia

    BlastSepolia: "blast_sepolia"

    Blast Testnet

    +

    Fuji

    Fuji: "avalanche_fuji"

    Avalanche Fuji

    +

    Klaytn

    Klaytn: "klaytn"

    Klaytn

    +

    Mainnet

    Mainnet: "ethereum"

    Ethereum

    +

    Optimism

    Optimism: "optimism"

    Optimism

    +

    OptimismSepolia

    OptimismSepolia: "optimism_sepolia"

    Optimism Sepolia

    +

    Polygon

    Polygon: "matic"

    Polygon

    +

    Sei

    Sei: "sei"

    Sei

    +

    SeiTestnet

    SeiTestnet: "sei_testnet"

    Sei Testnet

    +

    Sepolia

    Sepolia: "sepolia"

    Sepolia

    +

    Solana

    Solana: "solana"

    Solana

    +

    SolanaDevnet

    SolanaDevnet: "soldev"

    Solana Devnet

    +

    Zora

    Zora: "zora"

    Zora

    +

    ZoraSepolia

    ZoraSepolia: "zora_sepolia"

    Zora Sepolia

    +

    Settings

    Member Visibility

    Theme

    On This Page

    AmoyArbitrumArbitrumNovaArbitrumSepoliaAvalancheBNBBNBTestnetBaobabBaseBaseSepoliaBlastBlastSepoliaFujiKlaytnMainnetOptimismOptimismSepoliaPolygonSeiSeiTestnetSepoliaSolanaSolanaDevnetZoraZoraSepolia
    \ No newline at end of file diff --git a/enums/CollectionOrderByOption.html b/enums/CollectionOrderByOption.html index 3cb3df766..e0e6227e7 100644 --- a/enums/CollectionOrderByOption.html +++ b/enums/CollectionOrderByOption.html @@ -1,7 +1,7 @@ -CollectionOrderByOption | opensea-js - v7.1.12

    Enumeration CollectionOrderByOption

    Enumeration Members

    CREATED_DATE +CollectionOrderByOption | opensea-js - v7.1.12

    Enumeration CollectionOrderByOption

    Enumeration Members

    CREATED_DATE MARKET_CAP NUM_OWNERS ONE_DAY_CHANGE SEVEN_DAY_CHANGE SEVEN_DAY_VOLUME -

    Enumeration Members

    CREATED_DATE

    CREATED_DATE: "created_date"

    MARKET_CAP

    MARKET_CAP: "market_cap"

    NUM_OWNERS

    NUM_OWNERS: "num_owners"

    ONE_DAY_CHANGE

    ONE_DAY_CHANGE: "one_day_change"

    SEVEN_DAY_CHANGE

    SEVEN_DAY_CHANGE: "seven_day_change"

    SEVEN_DAY_VOLUME

    SEVEN_DAY_VOLUME: "seven_day_volume"

    Settings

    Member Visibility

    Theme

    On This Page

    CREATED_DATEMARKET_CAPNUM_OWNERSONE_DAY_CHANGESEVEN_DAY_CHANGESEVEN_DAY_VOLUME
    \ No newline at end of file +

    Enumeration Members

    CREATED_DATE

    CREATED_DATE: "created_date"

    MARKET_CAP

    MARKET_CAP: "market_cap"

    NUM_OWNERS

    NUM_OWNERS: "num_owners"

    ONE_DAY_CHANGE

    ONE_DAY_CHANGE: "one_day_change"

    SEVEN_DAY_CHANGE

    SEVEN_DAY_CHANGE: "seven_day_change"

    SEVEN_DAY_VOLUME

    SEVEN_DAY_VOLUME: "seven_day_volume"

    Settings

    Member Visibility

    Theme

    On This Page

    CREATED_DATEMARKET_CAPNUM_OWNERSONE_DAY_CHANGESEVEN_DAY_CHANGESEVEN_DAY_VOLUME
    \ No newline at end of file diff --git a/enums/EventType.html b/enums/EventType.html index 7f4941a27..f942c6545 100644 --- a/enums/EventType.html +++ b/enums/EventType.html @@ -1,6 +1,6 @@ EventType | opensea-js - v7.1.12

    Enumeration EventType

    Events emitted by the SDK which can be used by frontend applications to update state or show useful messages to users.

    -

    Enumeration Members

    ApproveOrder +

    Enumeration Members

    ApproveOrder CancelOrder MatchOrders TransactionConfirmed @@ -11,14 +11,14 @@ UnwrapWeth WrapEth

    Enumeration Members

    ApproveOrder

    ApproveOrder: "ApproveOrder"

    Emitted when the OpenSeaSDK.approveOrder method is called.

    -

    CancelOrder

    CancelOrder: "CancelOrder"

    Emitted when the OpenSeaSDK.cancelOrder method is called.

    -

    MatchOrders

    MatchOrders: "MatchOrders"

    Emitted when fulfilling a public or private order.

    -

    TransactionConfirmed

    TransactionConfirmed: "TransactionConfirmed"

    Emitted when the transaction has succeeded is mined and confirmed.

    -

    TransactionCreated

    TransactionCreated: "TransactionCreated"

    Emitted when the transaction is sent to the network and the application +

    CancelOrder

    CancelOrder: "CancelOrder"

    Emitted when the OpenSeaSDK.cancelOrder method is called.

    +

    MatchOrders

    MatchOrders: "MatchOrders"

    Emitted when fulfilling a public or private order.

    +

    TransactionConfirmed

    TransactionConfirmed: "TransactionConfirmed"

    Emitted when the transaction has succeeded is mined and confirmed.

    +

    TransactionCreated

    TransactionCreated: "TransactionCreated"

    Emitted when the transaction is sent to the network and the application is waiting for the transaction to be mined.

    -

    TransactionDenied

    TransactionDenied: "TransactionDenied"

    Emitted when the transaction has failed to be submitted.

    -

    TransactionFailed

    TransactionFailed: "TransactionFailed"

    Emitted when the transaction has failed to be mined.

    -

    Transfer

    Transfer: "Transfer"

    Emitted when the OpenSeaSDK.transfer method is called.

    -

    UnwrapWeth

    UnwrapWeth: "UnwrapWeth"

    Emitted when the OpenSeaSDK.unwrapWeth method is called.

    -

    WrapEth

    WrapEth: "WrapEth"

    Emitted when the OpenSeaSDK.wrapEth method is called.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ApproveOrderCancelOrderMatchOrdersTransactionConfirmedTransactionCreatedTransactionDeniedTransactionFailedTransferUnwrapWethWrapEth
    \ No newline at end of file +

    TransactionDenied

    TransactionDenied: "TransactionDenied"

    Emitted when the transaction has failed to be submitted.

    +

    TransactionFailed

    TransactionFailed: "TransactionFailed"

    Emitted when the transaction has failed to be mined.

    +

    Transfer

    Transfer: "Transfer"

    Emitted when the OpenSeaSDK.transfer method is called.

    +

    UnwrapWeth

    UnwrapWeth: "UnwrapWeth"

    Emitted when the OpenSeaSDK.unwrapWeth method is called.

    +

    WrapEth

    WrapEth: "WrapEth"

    Emitted when the OpenSeaSDK.wrapEth method is called.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    ApproveOrderCancelOrderMatchOrdersTransactionConfirmedTransactionCreatedTransactionDeniedTransactionFailedTransferUnwrapWethWrapEth
    \ No newline at end of file diff --git a/enums/OrderSide.html b/enums/OrderSide.html index c1c62af01..590cd4b9a 100644 --- a/enums/OrderSide.html +++ b/enums/OrderSide.html @@ -1,4 +1,4 @@ OrderSide | opensea-js - v7.1.12

    Enumeration OrderSide

    Order side: listing (ask) or offer (bid)

    -

    Enumeration Members

    LISTING +

    Enumeration Members

    LISTING OFFER -

    Enumeration Members

    LISTING

    LISTING: "ask"

    OFFER

    OFFER: "bid"

    Settings

    Member Visibility

    Theme

    On This Page

    LISTINGOFFER
    \ No newline at end of file +

    Enumeration Members

    LISTING

    LISTING: "ask"

    OFFER

    OFFER: "bid"

    Settings

    Member Visibility

    Theme

    On This Page

    LISTINGOFFER
    \ No newline at end of file diff --git a/enums/OrderType.html b/enums/OrderType.html index b0b5aa7f8..a23333406 100644 --- a/enums/OrderType.html +++ b/enums/OrderType.html @@ -1,4 +1,4 @@ -OrderType | opensea-js - v7.1.12

    Enumeration OrderType

    Enumeration Members

    BASIC +OrderType | opensea-js - v7.1.12

    Enumeration OrderType

    Enumeration Members

    BASIC CRITERIA ENGLISH -

    Enumeration Members

    BASIC

    BASIC: "basic"

    CRITERIA

    CRITERIA: "criteria"

    ENGLISH

    ENGLISH: "english"

    Settings

    Member Visibility

    Theme

    On This Page

    BASICCRITERIAENGLISH
    \ No newline at end of file +

    Enumeration Members

    BASIC

    BASIC: "basic"

    CRITERIA

    CRITERIA: "criteria"

    ENGLISH

    ENGLISH: "english"

    Settings

    Member Visibility

    Theme

    On This Page

    BASICCRITERIAENGLISH
    \ No newline at end of file diff --git a/enums/SafelistStatus.html b/enums/SafelistStatus.html index 988643a9b..62ba973cf 100644 --- a/enums/SafelistStatus.html +++ b/enums/SafelistStatus.html @@ -6,9 +6,9 @@
  • approved: collections that are approved on our site and can be found in search results
  • verified: verified collections
    • -

    Enumeration Members

    APPROVED +

    Enumeration Members

    APPROVED DISABLED_TOP_TRENDING NOT_REQUESTED REQUESTED VERIFIED -

    Enumeration Members

    APPROVED

    APPROVED: "approved"

    DISABLED_TOP_TRENDING

    DISABLED_TOP_TRENDING: "disabled_top_trending"

    NOT_REQUESTED

    NOT_REQUESTED: "not_requested"

    REQUESTED

    REQUESTED: "requested"

    VERIFIED

    VERIFIED: "verified"

    Settings

    Member Visibility

    Theme

    On This Page

    APPROVEDDISABLED_TOP_TRENDINGNOT_REQUESTEDREQUESTEDVERIFIED
    \ No newline at end of file +

    Enumeration Members

    APPROVED

    APPROVED: "approved"

    DISABLED_TOP_TRENDING

    DISABLED_TOP_TRENDING: "disabled_top_trending"

    NOT_REQUESTED

    NOT_REQUESTED: "not_requested"

    REQUESTED

    REQUESTED: "requested"

    VERIFIED

    VERIFIED: "verified"

    Settings

    Member Visibility

    Theme

    On This Page

    APPROVEDDISABLED_TOP_TRENDINGNOT_REQUESTEDREQUESTEDVERIFIED
    \ No newline at end of file diff --git a/enums/TokenStandard.html b/enums/TokenStandard.html index 2b3866d69..7fce24a29 100644 --- a/enums/TokenStandard.html +++ b/enums/TokenStandard.html @@ -1,5 +1,5 @@ TokenStandard | opensea-js - v7.1.12

    Enumeration TokenStandard

    Token standards

    -

    Enumeration Members

    ERC1155 +

    Enumeration Members

    ERC1155 ERC20 ERC721 -

    Enumeration Members

    ERC1155

    ERC1155: "ERC1155"

    ERC20

    ERC20: "ERC20"

    ERC721

    ERC721: "ERC721"

    Settings

    Member Visibility

    Theme

    On This Page

    ERC1155ERC20ERC721
    \ No newline at end of file +

    Enumeration Members

    ERC1155

    ERC1155: "ERC1155"

    ERC20

    ERC20: "ERC20"

    ERC721

    ERC721: "ERC721"

    Settings

    Member Visibility

    Theme

    On This Page

    ERC1155ERC20ERC721
    \ No newline at end of file diff --git a/enums/TraitDisplayType.html b/enums/TraitDisplayType.html index 05b6e3b38..e3db329c7 100644 --- a/enums/TraitDisplayType.html +++ b/enums/TraitDisplayType.html @@ -1,9 +1,9 @@ TraitDisplayType | opensea-js - v7.1.12

    Enumeration TraitDisplayType

    Trait display type returned by OpenSea API.

    -

    Enumeration Members

    AUTHOR +

    Enumeration Members

    AUTHOR BOOST_NUMBER BOOST_PERCENTAGE DATE NONE NUMBER -

    Enumeration Members

    AUTHOR

    AUTHOR: "author"

    BOOST_NUMBER

    BOOST_NUMBER: "boost_number"

    BOOST_PERCENTAGE

    BOOST_PERCENTAGE: "boost_percentage"

    DATE

    DATE: "date"

    NONE

    NONE: "None"

    "None" is used for string traits

    -

    NUMBER

    NUMBER: "number"

    Settings

    Member Visibility

    Theme

    On This Page

    AUTHORBOOST_NUMBERBOOST_PERCENTAGEDATENONENUMBER
    \ No newline at end of file +

    Enumeration Members

    AUTHOR

    AUTHOR: "author"

    BOOST_NUMBER

    BOOST_NUMBER: "boost_number"

    BOOST_PERCENTAGE

    BOOST_PERCENTAGE: "boost_percentage"

    DATE

    DATE: "date"

    NONE

    NONE: "None"

    "None" is used for string traits

    +

    NUMBER

    NUMBER: "number"

    Settings

    Member Visibility

    Theme

    On This Page

    AUTHORBOOST_NUMBERBOOST_PERCENTAGEDATENONENUMBER
    \ No newline at end of file diff --git a/interfaces/Asset.html b/interfaces/Asset.html index ee282afd0..96cf60e28 100644 --- a/interfaces/Asset.html +++ b/interfaces/Asset.html @@ -1,12 +1,12 @@ Asset | opensea-js - v7.1.12

    Interface Asset

    Generic Blockchain Asset.

    -
    interface Asset {
        decimals?: number;
        name?: string;
        tokenAddress: string;
        tokenId: null | string;
        tokenStandard?: TokenStandard;
    }

    Hierarchy (view full)

    Properties

    decimals? +
    interface Asset {
        decimals?: number;
        name?: string;
        tokenAddress: string;
        tokenId: null | string;
        tokenStandard?: TokenStandard;
    }

    Hierarchy (view full)

    Properties

    decimals? name? tokenAddress tokenId tokenStandard?

    Properties

    Optional decimals

    decimals?: number

    Optional for fungible items

    -

    Optional name

    name?: string

    Optional for ENS names

    -

    tokenAddress

    tokenAddress: string

    The asset's contract address

    -

    tokenId

    tokenId: null | string

    The asset's token ID, or null if ERC-20

    -

    Optional tokenStandard

    tokenStandard?: TokenStandard

    The token standard (e.g. "ERC721") for this asset

    -

    Settings

    Member Visibility

    Theme

    On This Page

    decimalsnametokenAddresstokenIdtokenStandard
    \ No newline at end of file +

    Optional name

    name?: string

    Optional for ENS names

    +

    tokenAddress

    tokenAddress: string

    The asset's contract address

    +

    tokenId

    tokenId: null | string

    The asset's token ID, or null if ERC-20

    +

    Optional tokenStandard

    tokenStandard?: TokenStandard

    The token standard (e.g. "ERC721") for this asset

    +

    Settings

    Member Visibility

    Theme

    On This Page

    decimalsnametokenAddresstokenIdtokenStandard
    \ No newline at end of file diff --git a/interfaces/AssetWithTokenId.html b/interfaces/AssetWithTokenId.html index 8e14d08fd..873c64268 100644 --- a/interfaces/AssetWithTokenId.html +++ b/interfaces/AssetWithTokenId.html @@ -1,12 +1,12 @@ AssetWithTokenId | opensea-js - v7.1.12

    Interface AssetWithTokenId

    Generic Blockchain Asset, with tokenId required.

    -
    interface AssetWithTokenId {
        decimals?: number;
        name?: string;
        tokenAddress: string;
        tokenId: string;
        tokenStandard?: TokenStandard;
    }

    Hierarchy (view full)

    Properties

    decimals? +
    interface AssetWithTokenId {
        decimals?: number;
        name?: string;
        tokenAddress: string;
        tokenId: string;
        tokenStandard?: TokenStandard;
    }

    Hierarchy (view full)

    Properties

    decimals? name? tokenAddress tokenId tokenStandard?

    Properties

    Optional decimals

    decimals?: number

    Optional for fungible items

    -

    Optional name

    name?: string

    Optional for ENS names

    -

    tokenAddress

    tokenAddress: string

    The asset's contract address

    -

    tokenId

    tokenId: string

    The asset's token ID

    -

    Optional tokenStandard

    tokenStandard?: TokenStandard

    The token standard (e.g. "ERC721") for this asset

    -

    Settings

    Member Visibility

    Theme

    On This Page

    decimalsnametokenAddresstokenIdtokenStandard
    \ No newline at end of file +

    Optional name

    name?: string

    Optional for ENS names

    +

    tokenAddress

    tokenAddress: string

    The asset's contract address

    +

    tokenId

    tokenId: string

    The asset's token ID

    +

    Optional tokenStandard

    tokenStandard?: TokenStandard

    The token standard (e.g. "ERC721") for this asset

    +

    Settings

    Member Visibility

    Theme

    On This Page

    decimalsnametokenAddresstokenIdtokenStandard
    \ No newline at end of file diff --git a/interfaces/AssetWithTokenStandard.html b/interfaces/AssetWithTokenStandard.html index 4d8152465..02e38d059 100644 --- a/interfaces/AssetWithTokenStandard.html +++ b/interfaces/AssetWithTokenStandard.html @@ -1,12 +1,12 @@ AssetWithTokenStandard | opensea-js - v7.1.12

    Interface AssetWithTokenStandard

    Generic Blockchain Asset, with tokenStandard required.

    -
    interface AssetWithTokenStandard {
        decimals?: number;
        name?: string;
        tokenAddress: string;
        tokenId: null | string;
        tokenStandard: TokenStandard;
    }

    Hierarchy (view full)

    • Asset
      • AssetWithTokenStandard

    Properties

    decimals? +
    interface AssetWithTokenStandard {
        decimals?: number;
        name?: string;
        tokenAddress: string;
        tokenId: null | string;
        tokenStandard: TokenStandard;
    }

    Hierarchy (view full)

    • Asset
      • AssetWithTokenStandard

    Properties

    decimals? name? tokenAddress tokenId tokenStandard

    Properties

    Optional decimals

    decimals?: number

    Optional for fungible items

    -

    Optional name

    name?: string

    Optional for ENS names

    -

    tokenAddress

    tokenAddress: string

    The asset's contract address

    -

    tokenId

    tokenId: null | string

    The asset's token ID, or null if ERC-20

    -

    tokenStandard

    tokenStandard: TokenStandard

    The token standard (e.g. "ERC721") for this asset

    -

    Settings

    Member Visibility

    Theme

    On This Page

    decimalsnametokenAddresstokenIdtokenStandard
    \ No newline at end of file +

    Optional name

    name?: string

    Optional for ENS names

    +

    tokenAddress

    tokenAddress: string

    The asset's contract address

    +

    tokenId

    tokenId: null | string

    The asset's token ID, or null if ERC-20

    +

    tokenStandard

    tokenStandard: TokenStandard

    The token standard (e.g. "ERC721") for this asset

    +

    Settings

    Member Visibility

    Theme

    On This Page

    decimalsnametokenAddresstokenIdtokenStandard
    \ No newline at end of file diff --git a/interfaces/EventData.html b/interfaces/EventData.html index dbcff9301..6193594e1 100644 --- a/interfaces/EventData.html +++ b/interfaces/EventData.html @@ -1,14 +1,14 @@ EventData | opensea-js - v7.1.12

    Interface EventData

    Data that gets sent with each EventType

    -
    interface EventData {
        accountAddress?: string;
        amount?: BigNumberish;
        error?: unknown;
        event?: EventType;
        orderV2?: OrderV2;
        transactionHash?: string;
    }

    Properties

    accountAddress? +
    interface EventData {
        accountAddress?: string;
        amount?: BigNumberish;
        error?: unknown;
        event?: EventType;
        orderV2?: OrderV2;
        transactionHash?: string;
    }

    Properties

    accountAddress? amount? error? event? orderV2? transactionHash?

    Properties

    Optional accountAddress

    accountAddress?: string

    Wallet address of the user who initiated the event.

    -

    Optional amount

    amount?: BigNumberish

    Amount of ETH sent when wrapping or unwrapping.

    -

    Optional error

    error?: unknown

    Error which occurred when transaction was denied or failed.

    -

    Optional event

    event?: EventType

    The EventType of the event.

    -

    Optional orderV2

    orderV2?: OrderV2

    The OrderV2 object.

    -

    Optional transactionHash

    transactionHash?: string

    The transaction hash of the event.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    accountAddressamounterroreventorderV2transactionHash
    \ No newline at end of file +

    Optional amount

    amount?: BigNumberish

    Amount of ETH sent when wrapping or unwrapping.

    +

    Optional error

    error?: unknown

    Error which occurred when transaction was denied or failed.

    +

    Optional event

    event?: EventType

    The EventType of the event.

    +

    Optional orderV2

    orderV2?: OrderV2

    The OrderV2 object.

    +

    Optional transactionHash

    transactionHash?: string

    The transaction hash of the event.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    accountAddressamounterroreventorderV2transactionHash
    \ No newline at end of file diff --git a/interfaces/Fee.html b/interfaces/Fee.html index b49fbe99d..5a4da0a55 100644 --- a/interfaces/Fee.html +++ b/interfaces/Fee.html @@ -1,5 +1,5 @@ Fee | opensea-js - v7.1.12

    Interface Fee

    Collection fees

    -
    interface Fee {
        fee: number;
        recipient: string;
        required: boolean;
    }

    Properties

    fee +
    interface Fee {
        fee: number;
        recipient: string;
        required: boolean;
    }

    Properties

    fee recipient required -

    Properties

    fee

    fee: number

    recipient

    recipient: string

    required

    required: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    feerecipientrequired
    \ No newline at end of file +

    Properties

    fee

    fee: number

    recipient

    recipient: string

    required

    required: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    feerecipientrequired
    \ No newline at end of file diff --git a/interfaces/GetCollectionsArgs.html b/interfaces/GetCollectionsArgs.html index 81bc6024a..c1a626ce3 100644 --- a/interfaces/GetCollectionsArgs.html +++ b/interfaces/GetCollectionsArgs.html @@ -1,8 +1,8 @@ GetCollectionsArgs | opensea-js - v7.1.12

    Interface GetCollectionsArgs

    Query args for Get Collections

    -
    interface GetCollectionsArgs {
        chain?: string;
        creator_username?: string;
        include_hidden?: boolean;
        limit?: number;
        next?: string;
        order_by?: string;
    }

    Properties

    chain? +
    interface GetCollectionsArgs {
        chain?: string;
        creator_username?: string;
        include_hidden?: boolean;
        limit?: number;
        next?: string;
        order_by?: string;
    }

    Properties

    chain? creator_username? include_hidden? limit? next? order_by? -

    Properties

    Optional chain

    chain?: string

    Optional creator_username

    creator_username?: string

    Optional include_hidden

    include_hidden?: boolean

    Optional limit

    limit?: number

    Optional next

    next?: string

    Optional order_by

    order_by?: string

    Settings

    Member Visibility

    Theme

    On This Page

    chaincreator_usernameinclude_hiddenlimitnextorder_by
    \ No newline at end of file +

    Properties

    Optional chain

    chain?: string

    Optional creator_username

    creator_username?: string

    Optional include_hidden

    include_hidden?: boolean

    Optional limit

    limit?: number

    Optional next

    next?: string

    Optional order_by

    order_by?: string

    Settings

    Member Visibility

    Theme

    On This Page

    chaincreator_usernameinclude_hiddenlimitnextorder_by
    \ No newline at end of file diff --git a/interfaces/OpenSeaAPIConfig.html b/interfaces/OpenSeaAPIConfig.html index 552877f92..b57d71d48 100644 --- a/interfaces/OpenSeaAPIConfig.html +++ b/interfaces/OpenSeaAPIConfig.html @@ -2,7 +2,7 @@

    Param: chain

    Chain to use. Defaults to Ethereum Mainnet (Chain.Mainnet)

    Param: apiKey

    API key to use. Not required for testnets

    Param: apiBaseUrl

    Optional base URL to use for the API

    -
    interface OpenSeaAPIConfig {
        apiBaseUrl?: string;
        apiKey?: string;
        chain?: Chain;
    }

    Properties

    apiBaseUrl? +
    interface OpenSeaAPIConfig {
        apiBaseUrl?: string;
        apiKey?: string;
        chain?: Chain;
    }

    Properties

    apiBaseUrl? apiKey? chain? -

    Properties

    Optional apiBaseUrl

    apiBaseUrl?: string

    Optional apiKey

    apiKey?: string

    Optional chain

    chain?: Chain

    Settings

    Member Visibility

    Theme

    On This Page

    apiBaseUrlapiKeychain
    \ No newline at end of file +

    Properties

    Optional apiBaseUrl

    apiBaseUrl?: string

    Optional apiKey

    apiKey?: string

    Optional chain

    chain?: Chain

    Settings

    Member Visibility

    Theme

    On This Page

    apiBaseUrlapiKeychain
    \ No newline at end of file diff --git a/interfaces/OpenSeaAccount.html b/interfaces/OpenSeaAccount.html index 0ee77e71f..bc7afaf11 100644 --- a/interfaces/OpenSeaAccount.html +++ b/interfaces/OpenSeaAccount.html @@ -1,5 +1,5 @@ OpenSeaAccount | opensea-js - v7.1.12

    Interface OpenSeaAccount

    OpenSea Account

    -
    interface OpenSeaAccount {
        address: string;
        bannerImageUrl: string;
        bio: string;
        joinedDate: string;
        profileImageUrl: string;
        socialMediaAccounts: SocialMediaAccount[];
        username: string;
        website: string;
    }

    Properties

    address +
    interface OpenSeaAccount {
        address: string;
        bannerImageUrl: string;
        bio: string;
        joinedDate: string;
        profileImageUrl: string;
        socialMediaAccounts: SocialMediaAccount[];
        username: string;
        website: string;
    }

    Properties

    address bannerImageUrl bio joinedDate @@ -7,4 +7,4 @@ socialMediaAccounts username website -

    Properties

    address

    address: string

    bannerImageUrl

    bannerImageUrl: string

    bio

    bio: string

    joinedDate

    joinedDate: string

    profileImageUrl

    profileImageUrl: string

    socialMediaAccounts

    socialMediaAccounts: SocialMediaAccount[]

    username

    username: string

    website

    website: string

    Settings

    Member Visibility

    Theme

    On This Page

    addressbannerImageUrlbiojoinedDateprofileImageUrlsocialMediaAccountsusernamewebsite
    \ No newline at end of file +

    Properties

    address

    address: string

    bannerImageUrl

    bannerImageUrl: string

    bio

    bio: string

    joinedDate

    joinedDate: string

    profileImageUrl

    profileImageUrl: string

    socialMediaAccounts

    socialMediaAccounts: SocialMediaAccount[]

    username

    username: string

    website

    website: string

    Settings

    Member Visibility

    Theme

    On This Page

    addressbannerImageUrlbiojoinedDateprofileImageUrlsocialMediaAccountsusernamewebsite
    \ No newline at end of file diff --git a/interfaces/OpenSeaCollection.html b/interfaces/OpenSeaCollection.html index d0ad23fe3..eef9a3ac6 100644 --- a/interfaces/OpenSeaCollection.html +++ b/interfaces/OpenSeaCollection.html @@ -1,5 +1,5 @@ OpenSeaCollection | opensea-js - v7.1.12

    Interface OpenSeaCollection

    OpenSea collection metadata.

    -
    interface OpenSeaCollection {
        bannerImageUrl: string;
        category: string;
        collection: string;
        collectionOffersEnabled: boolean;
        contracts: {
            address: string;
            chain: Chain;
        }[];
        createdDate: string;
        description: string;
        discordUrl: string;
        editors: string[];
        fees: Fee[];
        imageUrl: string;
        instagramUsername: string;
        isDisabled: boolean;
        isNSFW: boolean;
        name: string;
        openseaUrl: string;
        owner: string;
        paymentTokens: OpenSeaPaymentToken[];
        projectUrl: string;
        rarity: null | RarityStrategy;
        requiredZone?: string;
        safelistStatus: SafelistStatus;
        telegramUrl: string;
        totalSupply: number;
        traitOffersEnabled: boolean;
        twitterUsername: string;
        wikiUrl: string;
    }

    Properties

    bannerImageUrl +
    interface OpenSeaCollection {
        bannerImageUrl: string;
        category: string;
        collection: string;
        collectionOffersEnabled: boolean;
        contracts: {
            address: string;
            chain: Chain;
        }[];
        createdDate: string;
        description: string;
        discordUrl: string;
        editors: string[];
        fees: Fee[];
        imageUrl: string;
        instagramUsername: string;
        isDisabled: boolean;
        isNSFW: boolean;
        name: string;
        openseaUrl: string;
        owner: string;
        paymentTokens: OpenSeaPaymentToken[];
        projectUrl: string;
        rarity: null | RarityStrategy;
        requiredZone?: string;
        safelistStatus: SafelistStatus;
        telegramUrl: string;
        totalSupply: number;
        traitOffersEnabled: boolean;
        twitterUsername: string;
        wikiUrl: string;
    }

    Properties

    bannerImageUrl category collection collectionOffersEnabled @@ -27,30 +27,30 @@ twitterUsername wikiUrl

    Properties

    bannerImageUrl

    bannerImageUrl: string

    Banner image for the collection

    -

    category

    category: string

    The category of the collection

    -

    collection

    collection: string

    The identifier (slug) of the collection

    -

    collectionOffersEnabled

    collectionOffersEnabled: boolean

    If collection offers are enabled

    -

    contracts

    contracts: {
        address: string;
        chain: Chain;
    }[]

    The contracts for the collection

    -

    Type declaration

    • address: string
    • chain: Chain

    createdDate

    createdDate: string

    The created date of the collection

    -

    description

    description: string

    Description of the collection

    -

    discordUrl

    discordUrl: string

    The discord url for the collection

    -

    editors

    editors: string[]

    Accounts allowed to edit this collection

    -

    fees

    fees: Fee[]

    The fees for the collection

    -

    imageUrl

    imageUrl: string

    Image for the collection

    -

    instagramUsername

    instagramUsername: string

    The instagram username for the collection

    -

    isDisabled

    isDisabled: boolean

    If the collection is disabled

    -

    isNSFW

    isNSFW: boolean

    If the collection is NSFW (not safe for work)

    -

    name

    name: string

    Name of the collection

    -

    openseaUrl

    openseaUrl: string

    The OpenSea url for the collection

    -

    owner

    owner: string

    Owner address of the collection

    -

    paymentTokens

    paymentTokens: OpenSeaPaymentToken[]

    Payment tokens allowed for orders for this collection

    -

    projectUrl

    projectUrl: string

    The project url for the collection

    -

    rarity

    rarity: null | RarityStrategy

    The rarity strategy for the collection

    -

    Optional requiredZone

    requiredZone?: string

    When defined, the zone required for orders for the collection

    -

    safelistStatus

    safelistStatus: SafelistStatus

    The collection's safelist status

    -

    telegramUrl

    telegramUrl: string

    The telegram url for the collection

    -

    totalSupply

    totalSupply: number

    The total supply of the collection (minted minus burned)

    -

    traitOffersEnabled

    traitOffersEnabled: boolean

    If trait offers are enabled

    -

    twitterUsername

    twitterUsername: string

    The twitter username for the collection

    -

    wikiUrl

    wikiUrl: string

    The wiki url for the collection

    -

    Settings

    Member Visibility

    Theme

    On This Page

    bannerImageUrlcategorycollectioncollectionOffersEnabledcontractscreatedDatedescriptiondiscordUrleditorsfeesimageUrlinstagramUsernameisDisabledisNSFWnameopenseaUrlownerpaymentTokensprojectUrlrarityrequiredZonesafelistStatustelegramUrltotalSupplytraitOffersEnabledtwitterUsernamewikiUrl
    \ No newline at end of file +

    category

    category: string

    The category of the collection

    +

    collection

    collection: string

    The identifier (slug) of the collection

    +

    collectionOffersEnabled

    collectionOffersEnabled: boolean

    If collection offers are enabled

    +

    contracts

    contracts: {
        address: string;
        chain: Chain;
    }[]

    The contracts for the collection

    +

    Type declaration

    • address: string
    • chain: Chain

    createdDate

    createdDate: string

    The created date of the collection

    +

    description

    description: string

    Description of the collection

    +

    discordUrl

    discordUrl: string

    The discord url for the collection

    +

    editors

    editors: string[]

    Accounts allowed to edit this collection

    +

    fees

    fees: Fee[]

    The fees for the collection

    +

    imageUrl

    imageUrl: string

    Image for the collection

    +

    instagramUsername

    instagramUsername: string

    The instagram username for the collection

    +

    isDisabled

    isDisabled: boolean

    If the collection is disabled

    +

    isNSFW

    isNSFW: boolean

    If the collection is NSFW (not safe for work)

    +

    name

    name: string

    Name of the collection

    +

    openseaUrl

    openseaUrl: string

    The OpenSea url for the collection

    +

    owner

    owner: string

    Owner address of the collection

    +

    paymentTokens

    paymentTokens: OpenSeaPaymentToken[]

    Payment tokens allowed for orders for this collection

    +

    projectUrl

    projectUrl: string

    The project url for the collection

    +

    rarity

    rarity: null | RarityStrategy

    The rarity strategy for the collection

    +

    Optional requiredZone

    requiredZone?: string

    When defined, the zone required for orders for the collection

    +

    safelistStatus

    safelistStatus: SafelistStatus

    The collection's safelist status

    +

    telegramUrl

    telegramUrl: string

    The telegram url for the collection

    +

    totalSupply

    totalSupply: number

    The total supply of the collection (minted minus burned)

    +

    traitOffersEnabled

    traitOffersEnabled: boolean

    If trait offers are enabled

    +

    twitterUsername

    twitterUsername: string

    The twitter username for the collection

    +

    wikiUrl

    wikiUrl: string

    The wiki url for the collection

    +

    Settings

    Member Visibility

    Theme

    On This Page

    bannerImageUrlcategorycollectioncollectionOffersEnabledcontractscreatedDatedescriptiondiscordUrleditorsfeesimageUrlinstagramUsernameisDisabledisNSFWnameopenseaUrlownerpaymentTokensprojectUrlrarityrequiredZonesafelistStatustelegramUrltotalSupplytraitOffersEnabledtwitterUsernamewikiUrl
    \ No newline at end of file diff --git a/interfaces/OpenSeaCollectionStats.html b/interfaces/OpenSeaCollectionStats.html index b32e4e9fd..54172cdc0 100644 --- a/interfaces/OpenSeaCollectionStats.html +++ b/interfaces/OpenSeaCollectionStats.html @@ -1,4 +1,4 @@ OpenSeaCollectionStats | opensea-js - v7.1.12

    Interface OpenSeaCollectionStats

    OpenSea Collection Stats

    -
    interface OpenSeaCollectionStats {
        intervals: OpenSeaCollectionStatsIntervalData[];
        total: {
            average_price: number;
            floor_price: number;
            floor_price_symbol: string;
            market_cap: number;
            num_owners: number;
            sales: number;
            volume: number;
        };
    }

    Properties

    intervals +
    interface OpenSeaCollectionStats {
        intervals: OpenSeaCollectionStatsIntervalData[];
        total: {
            average_price: number;
            floor_price: number;
            floor_price_symbol: string;
            market_cap: number;
            num_owners: number;
            sales: number;
            volume: number;
        };
    }

    Properties

    intervals total -

    Properties

    intervals

    intervals: OpenSeaCollectionStatsIntervalData[]

    total

    total: {
        average_price: number;
        floor_price: number;
        floor_price_symbol: string;
        market_cap: number;
        num_owners: number;
        sales: number;
        volume: number;
    }

    Type declaration

    • average_price: number
    • floor_price: number
    • floor_price_symbol: string
    • market_cap: number
    • num_owners: number
    • sales: number
    • volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    intervalstotal
    \ No newline at end of file +

    Properties

    intervals

    intervals: OpenSeaCollectionStatsIntervalData[]

    total

    total: {
        average_price: number;
        floor_price: number;
        floor_price_symbol: string;
        market_cap: number;
        num_owners: number;
        sales: number;
        volume: number;
    }

    Type declaration

    • average_price: number
    • floor_price: number
    • floor_price_symbol: string
    • market_cap: number
    • num_owners: number
    • sales: number
    • volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    intervalstotal
    \ No newline at end of file diff --git a/interfaces/OpenSeaPaymentToken.html b/interfaces/OpenSeaPaymentToken.html index 2da8d3578..777c46847 100644 --- a/interfaces/OpenSeaPaymentToken.html +++ b/interfaces/OpenSeaPaymentToken.html @@ -1,5 +1,5 @@ OpenSeaPaymentToken | opensea-js - v7.1.12

    Interface OpenSeaPaymentToken

    Full annotated Fungible Token spec with OpenSea metadata

    -
    interface OpenSeaPaymentToken {
        address: string;
        chain: Chain;
        decimals: number;
        ethPrice?: string;
        imageUrl?: string;
        name: string;
        symbol: string;
        usdPrice?: string;
    }

    Properties

    address +
    interface OpenSeaPaymentToken {
        address: string;
        chain: Chain;
        decimals: number;
        ethPrice?: string;
        imageUrl?: string;
        name: string;
        symbol: string;
        usdPrice?: string;
    }

    Properties

    address chain decimals ethPrice? @@ -7,4 +7,4 @@ name symbol usdPrice? -

    Properties

    address

    address: string

    chain

    chain: Chain

    decimals

    decimals: number

    Optional ethPrice

    ethPrice?: string

    Optional imageUrl

    imageUrl?: string

    name

    name: string

    symbol

    symbol: string

    Optional usdPrice

    usdPrice?: string

    Settings

    Member Visibility

    Theme

    On This Page

    addresschaindecimalsethPriceimageUrlnamesymbolusdPrice
    \ No newline at end of file +

    Properties

    address

    address: string

    chain

    chain: Chain

    decimals

    decimals: number

    Optional ethPrice

    ethPrice?: string

    Optional imageUrl

    imageUrl?: string

    name

    name: string

    symbol

    symbol: string

    Optional usdPrice

    usdPrice?: string

    Settings

    Member Visibility

    Theme

    On This Page

    addresschaindecimalsethPriceimageUrlnamesymbolusdPrice
    \ No newline at end of file diff --git a/interfaces/OpenSeaPaymentTokensQuery.html b/interfaces/OpenSeaPaymentTokensQuery.html index 6e5b70d51..bf4407b8e 100644 --- a/interfaces/OpenSeaPaymentTokensQuery.html +++ b/interfaces/OpenSeaPaymentTokensQuery.html @@ -1,6 +1,6 @@ OpenSeaPaymentTokensQuery | opensea-js - v7.1.12

    Interface OpenSeaPaymentTokensQuery

    Query interface for payment tokens

    -
    interface OpenSeaPaymentTokensQuery {
        address?: string;
        limit?: number;
        next?: string;
        symbol?: string;
    }

    Properties

    address? +
    interface OpenSeaPaymentTokensQuery {
        address?: string;
        limit?: number;
        next?: string;
        symbol?: string;
    }

    Properties

    address? limit? next? symbol? -

    Properties

    Optional address

    address?: string

    Optional limit

    limit?: number

    Optional next

    next?: string

    Optional symbol

    symbol?: string

    Settings

    Member Visibility

    Theme

    On This Page

    addresslimitnextsymbol
    \ No newline at end of file +

    Properties

    Optional address

    address?: string

    Optional limit

    limit?: number

    Optional next

    next?: string

    Optional symbol

    symbol?: string

    Settings

    Member Visibility

    Theme

    On This Page

    addresslimitnextsymbol
    \ No newline at end of file diff --git a/interfaces/RarityStrategy.html b/interfaces/RarityStrategy.html index 8a19c6e1d..60dc3db23 100644 --- a/interfaces/RarityStrategy.html +++ b/interfaces/RarityStrategy.html @@ -1,6 +1,6 @@ -RarityStrategy | opensea-js - v7.1.12

    Interface RarityStrategy

    interface RarityStrategy {
        calculatedAt: string;
        maxRank: number;
        strategyId: string;
        strategyVersion: string;
        tokensScored: number;
    }

    Properties

    calculatedAt +RarityStrategy | opensea-js - v7.1.12

    Interface RarityStrategy

    interface RarityStrategy {
        calculatedAt: string;
        maxRank: number;
        strategyId: string;
        strategyVersion: string;
        tokensScored: number;
    }

    Properties

    calculatedAt maxRank strategyId strategyVersion tokensScored -

    Properties

    calculatedAt

    calculatedAt: string

    maxRank

    maxRank: number

    strategyId

    strategyId: string

    strategyVersion

    strategyVersion: string

    tokensScored

    tokensScored: number

    Settings

    Member Visibility

    Theme

    On This Page

    calculatedAtmaxRankstrategyIdstrategyVersiontokensScored
    \ No newline at end of file +

    Properties

    calculatedAt

    calculatedAt: string

    maxRank

    maxRank: number

    strategyId

    strategyId: string

    strategyVersion

    strategyVersion: string

    tokensScored

    tokensScored: number

    Settings

    Member Visibility

    Theme

    On This Page

    calculatedAtmaxRankstrategyIdstrategyVersiontokensScored
    \ No newline at end of file diff --git a/interfaces/SocialMediaAccount.html b/interfaces/SocialMediaAccount.html index 802f09f13..1109ead03 100644 --- a/interfaces/SocialMediaAccount.html +++ b/interfaces/SocialMediaAccount.html @@ -1,4 +1,4 @@ SocialMediaAccount | opensea-js - v7.1.12

    Interface SocialMediaAccount

    Social media account

    -
    interface SocialMediaAccount {
        platform: string;
        username: string;
    }

    Properties

    platform +
    interface SocialMediaAccount {
        platform: string;
        username: string;
    }

    Properties

    platform username -

    Properties

    platform

    platform: string

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    platformusername
    \ No newline at end of file +

    Properties

    platform

    platform: string

    username

    username: string

    Settings

    Member Visibility

    Theme

    On This Page

    platformusername
    \ No newline at end of file diff --git a/types/BuildOfferResponse.html b/types/BuildOfferResponse.html index a2db28e66..46bbfccf3 100644 --- a/types/BuildOfferResponse.html +++ b/types/BuildOfferResponse.html @@ -1,3 +1,3 @@ BuildOfferResponse | opensea-js - v7.1.12

    Type alias BuildOfferResponse

    BuildOfferResponse: {
        partialParameters: PartialParameters;
    }

    Response from OpenSea API for building an offer.

    Type declaration

    • partialParameters: PartialParameters

      A portion of the parameters needed to submit a criteria offer, i.e. collection offer.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CancelOrderResponse.html b/types/CancelOrderResponse.html index d612769e9..289dbc681 100644 --- a/types/CancelOrderResponse.html +++ b/types/CancelOrderResponse.html @@ -1,2 +1,2 @@ CancelOrderResponse | opensea-js - v7.1.12

    Type alias CancelOrderResponse

    CancelOrderResponse: {
        last_signature_issued_valid_until: string | null;
    }

    Response from OpenSea API for offchain canceling an order.

    -

    Type declaration

    • last_signature_issued_valid_until: string | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CollectionOffer.html b/types/CollectionOffer.html index 361173f66..c9fcc0a4b 100644 --- a/types/CollectionOffer.html +++ b/types/CollectionOffer.html @@ -1,2 +1,2 @@ CollectionOffer | opensea-js - v7.1.12

    Type alias CollectionOffer

    CollectionOffer: Required<Pick<Offer, "criteria">> & Offer

    Collection Offer type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/FulfillmentDataResponse.html b/types/FulfillmentDataResponse.html index e347f68d9..95627f644 100644 --- a/types/FulfillmentDataResponse.html +++ b/types/FulfillmentDataResponse.html @@ -1 +1 @@ -FulfillmentDataResponse | opensea-js - v7.1.12

    Type alias FulfillmentDataResponse

    FulfillmentDataResponse: {
        fulfillment_data: FulfillmentData;
        protocol: string;
    }

    Type declaration

    • fulfillment_data: FulfillmentData
    • protocol: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +FulfillmentDataResponse | opensea-js - v7.1.12

    Type alias FulfillmentDataResponse

    FulfillmentDataResponse: {
        fulfillment_data: FulfillmentData;
        protocol: string;
    }

    Type declaration

    • fulfillment_data: FulfillmentData
    • protocol: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetBestListingResponse.html b/types/GetBestListingResponse.html index 99851fdf5..e820dbb0e 100644 --- a/types/GetBestListingResponse.html +++ b/types/GetBestListingResponse.html @@ -1,2 +1,2 @@ GetBestListingResponse | opensea-js - v7.1.12

    Type alias GetBestListingResponse

    GetBestListingResponse: Listing

    Response from OpenSea API for fetching a best listing.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetBestOfferResponse.html b/types/GetBestOfferResponse.html index 7756e7add..f77d6feaf 100644 --- a/types/GetBestOfferResponse.html +++ b/types/GetBestOfferResponse.html @@ -1,2 +1,2 @@ GetBestOfferResponse | opensea-js - v7.1.12

    Type alias GetBestOfferResponse

    GetBestOfferResponse: Offer | CollectionOffer

    Response from OpenSea API for fetching a best offer.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetCollectionResponse.html b/types/GetCollectionResponse.html index e280d6e7a..da191cd38 100644 --- a/types/GetCollectionResponse.html +++ b/types/GetCollectionResponse.html @@ -1,3 +1,3 @@ GetCollectionResponse | opensea-js - v7.1.12

    Type alias GetCollectionResponse

    GetCollectionResponse: {
        collection: OpenSeaCollection;
    }

    Response from OpenSea API for fetching a single collection.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetCollectionsResponse.html b/types/GetCollectionsResponse.html index 750169ec4..34c912968 100644 --- a/types/GetCollectionsResponse.html +++ b/types/GetCollectionsResponse.html @@ -1,3 +1,3 @@ GetCollectionsResponse | opensea-js - v7.1.12

    Type alias GetCollectionsResponse

    GetCollectionsResponse: QueryCursorsV2 & {
        collections: OpenSeaCollection[];
    }

    Response from OpenSea API for fetching a list of collections.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetListingsResponse.html b/types/GetListingsResponse.html index 44e8ef194..42bdc2749 100644 --- a/types/GetListingsResponse.html +++ b/types/GetListingsResponse.html @@ -1,2 +1,2 @@ GetListingsResponse | opensea-js - v7.1.12

    Type alias GetListingsResponse

    GetListingsResponse: QueryCursorsV2 & {
        listings: Listing[];
    }

    Response from OpenSea API for fetching listings.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetNFTResponse.html b/types/GetNFTResponse.html index 62f8f5046..402e5e534 100644 --- a/types/GetNFTResponse.html +++ b/types/GetNFTResponse.html @@ -1,3 +1,3 @@ GetNFTResponse | opensea-js - v7.1.12

    Type alias GetNFTResponse

    GetNFTResponse: {
        nft: NFT;
    }

    Response from OpenSea API for fetching a single NFT.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetOffersResponse.html b/types/GetOffersResponse.html index 36af7cf68..5cc5da7c3 100644 --- a/types/GetOffersResponse.html +++ b/types/GetOffersResponse.html @@ -1,2 +1,2 @@ GetOffersResponse | opensea-js - v7.1.12

    Type alias GetOffersResponse

    GetOffersResponse: QueryCursorsV2 & {
        offers: Offer[];
    }

    Response from OpenSea API for fetching offers.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GetOrdersResponse.html b/types/GetOrdersResponse.html index e3414b1ea..8f0e65dd6 100644 --- a/types/GetOrdersResponse.html +++ b/types/GetOrdersResponse.html @@ -1,3 +1,3 @@ GetOrdersResponse | opensea-js - v7.1.12

    Type alias GetOrdersResponse

    GetOrdersResponse: QueryCursors & {
        orders: OrderV2[];
    }

    Response from OpenSea API for fetching Orders.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ListCollectionOffersResponse.html b/types/ListCollectionOffersResponse.html index 4a2b5c109..94882b4ae 100644 --- a/types/ListCollectionOffersResponse.html +++ b/types/ListCollectionOffersResponse.html @@ -1,3 +1,3 @@ ListCollectionOffersResponse | opensea-js - v7.1.12

    Type alias ListCollectionOffersResponse

    ListCollectionOffersResponse: {
        offers: CollectionOffer[];
    }

    Response from OpenSea API for fetching a list of collection offers.

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ListNFTsResponse.html b/types/ListNFTsResponse.html index 7f78019e8..52d4c8d09 100644 --- a/types/ListNFTsResponse.html +++ b/types/ListNFTsResponse.html @@ -1,4 +1,4 @@ ListNFTsResponse | opensea-js - v7.1.12

    Type alias ListNFTsResponse

    ListNFTsResponse: {
        next: string;
        nfts: NFT[];
    }

    Response from OpenSea API for fetching a list of NFTs.

    Type declaration

    • next: string

      Cursor for next page of results.

    • nfts: NFT[]

      List of NFT

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Listing.html b/types/Listing.html index b6b6e54dc..69a0ae104 100644 --- a/types/Listing.html +++ b/types/Listing.html @@ -1,3 +1,3 @@ Listing | opensea-js - v7.1.12

    Type alias Listing

    Listing: Order & {
        type: OrderType;
    }

    Listing order type.

    Type declaration

    • type: OrderType

      The order type of the listing.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/NFT.html b/types/NFT.html index 7590375fe..3a9164222 100644 --- a/types/NFT.html +++ b/types/NFT.html @@ -15,4 +15,4 @@
  • token_standard: string

    Token standard, i.e. ERC721, ERC1155, etc.

  • traits: Trait[] | null

    Traits for the NFT, returns null if the NFT has than 50 traits

  • updated_at: string

    Date of latest NFT update

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Offer.html b/types/Offer.html index 9cff4ecfc..d04deb501 100644 --- a/types/Offer.html +++ b/types/Offer.html @@ -1,3 +1,3 @@ Offer | opensea-js - v7.1.12

    Type alias Offer

    Offer: Order & {
        criteria?: Criteria;
    }

    Offer type.

    Type declaration

    • Optional criteria?: Criteria

      The criteria for the offer if it is a collection or trait offer.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Order.html b/types/Order.html index cf3484c0e..c2b08dc76 100644 --- a/types/Order.html +++ b/types/Order.html @@ -4,4 +4,4 @@
  • price: Price

    The price of the order.

  • protocol_address: string

    The contract address of the protocol.

  • protocol_data: ProtocolData

    The protocol data for the order. Only 'seaport' is currently supported.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OrderAPIOptions.html b/types/OrderAPIOptions.html index fcadc83fc..3f0af8ec2 100644 --- a/types/OrderAPIOptions.html +++ b/types/OrderAPIOptions.html @@ -1 +1 @@ -OrderAPIOptions | opensea-js - v7.1.12

    Type alias OrderAPIOptions

    OrderAPIOptions: {
        protocol?: OrderProtocol;
        protocolAddress?: string;
        side: OrderSide;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +OrderAPIOptions | opensea-js - v7.1.12

    Type alias OrderAPIOptions

    OrderAPIOptions: {
        protocol?: OrderProtocol;
        protocolAddress?: string;
        side: OrderSide;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OrderProtocol.html b/types/OrderProtocol.html index ba9d2f8a8..c6fffb804 100644 --- a/types/OrderProtocol.html +++ b/types/OrderProtocol.html @@ -1 +1 @@ -OrderProtocol | opensea-js - v7.1.12

    Type alias OrderProtocol

    OrderProtocol: keyof OrderProtocolToProtocolData

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +OrderProtocol | opensea-js - v7.1.12

    Type alias OrderProtocol

    OrderProtocol: keyof OrderProtocolToProtocolData

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OrderV2.html b/types/OrderV2.html index e4f82c2bc..07ded49da 100644 --- a/types/OrderV2.html +++ b/types/OrderV2.html @@ -18,4 +18,4 @@
  • side: OrderSide

    The side of the order. Listing/Offer

  • taker: OpenSeaAccount | null

    The account that filled the order.

  • takerFees: OrderFee[]

    The taker fees for the order.

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OrdersPostQueryResponse.html b/types/OrdersPostQueryResponse.html index a5f7c7284..6f0f3ee33 100644 --- a/types/OrdersPostQueryResponse.html +++ b/types/OrdersPostQueryResponse.html @@ -1 +1 @@ -OrdersPostQueryResponse | opensea-js - v7.1.12

    Type alias OrdersPostQueryResponse

    OrdersPostQueryResponse: {
        order: SerializedOrderV2;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +OrdersPostQueryResponse | opensea-js - v7.1.12

    Type alias OrdersPostQueryResponse

    OrdersPostQueryResponse: {
        order: SerializedOrderV2;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OrdersQueryOptions.html b/types/OrdersQueryOptions.html index fe966041b..45f67adef 100644 --- a/types/OrdersQueryOptions.html +++ b/types/OrdersQueryOptions.html @@ -1 +1 @@ -OrdersQueryOptions | opensea-js - v7.1.12

    Type alias OrdersQueryOptions

    OrdersQueryOptions: OrderAPIOptions & {
        assetContractAddress?: string;
        cursor?: string;
        limit?: number;
        listedAfter?: number | string;
        listedBefore?: number | string;
        maker?: string;
        next?: string;
        onlyEnglish?: boolean;
        orderBy?: OpenOrderOrderingOption;
        orderDirection?: OrderByDirection;
        owner?: string;
        paymentTokenAddress?: string;
        taker?: string;
        tokenId?: string;
        tokenIds?: string[];
    }

    Type declaration

    • Optional assetContractAddress?: string
    • Optional cursor?: string
    • Optional limit?: number
    • Optional listedAfter?: number | string
    • Optional listedBefore?: number | string
    • Optional maker?: string
    • Optional next?: string
    • Optional onlyEnglish?: boolean
    • Optional orderBy?: OpenOrderOrderingOption
    • Optional orderDirection?: OrderByDirection
    • Optional owner?: string
    • Optional paymentTokenAddress?: string
    • Optional taker?: string
    • Optional tokenId?: string
    • Optional tokenIds?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +OrdersQueryOptions | opensea-js - v7.1.12

    Type alias OrdersQueryOptions

    OrdersQueryOptions: OrderAPIOptions & {
        assetContractAddress?: string;
        cursor?: string;
        limit?: number;
        listedAfter?: number | string;
        listedBefore?: number | string;
        maker?: string;
        next?: string;
        onlyEnglish?: boolean;
        orderBy?: OpenOrderOrderingOption;
        orderDirection?: OrderByDirection;
        owner?: string;
        paymentTokenAddress?: string;
        taker?: string;
        tokenId?: string;
        tokenIds?: string[];
    }

    Type declaration

    • Optional assetContractAddress?: string
    • Optional cursor?: string
    • Optional limit?: number
    • Optional listedAfter?: number | string
    • Optional listedBefore?: number | string
    • Optional maker?: string
    • Optional next?: string
    • Optional onlyEnglish?: boolean
    • Optional orderBy?: OpenOrderOrderingOption
    • Optional orderDirection?: OrderByDirection
    • Optional owner?: string
    • Optional paymentTokenAddress?: string
    • Optional taker?: string
    • Optional tokenId?: string
    • Optional tokenIds?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OrdersQueryResponse.html b/types/OrdersQueryResponse.html index c80dd972d..6c6cbabc0 100644 --- a/types/OrdersQueryResponse.html +++ b/types/OrdersQueryResponse.html @@ -1 +1 @@ -OrdersQueryResponse | opensea-js - v7.1.12

    Type alias OrdersQueryResponse

    OrdersQueryResponse: QueryCursors & {
        orders: SerializedOrderV2[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +OrdersQueryResponse | opensea-js - v7.1.12

    Type alias OrdersQueryResponse

    OrdersQueryResponse: QueryCursors & {
        orders: SerializedOrderV2[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Price.html b/types/Price.html index 95bc32280..371cc23b2 100644 --- a/types/Price.html +++ b/types/Price.html @@ -1,2 +1,2 @@ Price | opensea-js - v7.1.12

    Type alias Price

    Price: {
        current: {
            currency: string;
            decimals: number;
            value: string;
        };
    }

    Price response.

    -

    Type declaration

    • current: {
          currency: string;
          decimals: number;
          value: string;
      }
      • currency: string
      • decimals: number
      • value: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ProtocolData.html b/types/ProtocolData.html index 32b82bf8b..0d92666f2 100644 --- a/types/ProtocolData.html +++ b/types/ProtocolData.html @@ -1 +1 @@ -ProtocolData | opensea-js - v7.1.12

    Type alias ProtocolData

    ProtocolData: OrderProtocolToProtocolData[keyof OrderProtocolToProtocolData]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ProtocolData | opensea-js - v7.1.12

    Type alias ProtocolData

    ProtocolData: OrderProtocolToProtocolData[keyof OrderProtocolToProtocolData]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/QueryCursors.html b/types/QueryCursors.html index 824377013..6e43e494e 100644 --- a/types/QueryCursors.html +++ b/types/QueryCursors.html @@ -1 +1 @@ -QueryCursors | opensea-js - v7.1.12

    Type alias QueryCursors

    QueryCursors: {
        next: string | null;
        previous: string | null;
    }

    Type declaration

    • next: string | null
    • previous: string | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +QueryCursors | opensea-js - v7.1.12

    Type alias QueryCursors

    QueryCursors: {
        next: string | null;
        previous: string | null;
    }

    Type declaration

    • next: string | null
    • previous: string | null

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/QueryCursorsV2.html b/types/QueryCursorsV2.html index 0c17c3353..8d26079e7 100644 --- a/types/QueryCursorsV2.html +++ b/types/QueryCursorsV2.html @@ -1,2 +1,2 @@ QueryCursorsV2 | opensea-js - v7.1.12

    Type alias QueryCursorsV2

    QueryCursorsV2: {
        next?: string;
    }

    Base query cursors response from OpenSea API.

    -

    Type declaration

    • Optional next?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/SerializedOrderV2.html b/types/SerializedOrderV2.html index 6c3c3bc1a..417786e02 100644 --- a/types/SerializedOrderV2.html +++ b/types/SerializedOrderV2.html @@ -1 +1 @@ -SerializedOrderV2 | opensea-js - v7.1.12

    Type alias SerializedOrderV2

    SerializedOrderV2: {
        cancelled: boolean;
        client_signature: string | null;
        closing_date: string | null;
        created_date: string;
        current_price: string;
        expiration_time: number;
        finalized: boolean;
        listing_time: number;
        maker: unknown;
        maker_fees: {
            account: unknown;
            basis_points: string;
        }[];
        marked_invalid: boolean;
        order_hash: string | null;
        order_type: OrderType;
        protocol_address: string;
        protocol_data: ProtocolData;
        remaining_quantity: number;
        side: OrderSide;
        taker: unknown | null;
        taker_fees: {
            account: unknown;
            basis_points: string;
        }[];
    }

    Type declaration

    • cancelled: boolean
    • client_signature: string | null
    • closing_date: string | null
    • created_date: string
    • current_price: string
    • expiration_time: number
    • finalized: boolean
    • listing_time: number
    • maker: unknown
    • maker_fees: {
          account: unknown;
          basis_points: string;
      }[]
    • marked_invalid: boolean
    • order_hash: string | null
    • order_type: OrderType
    • protocol_address: string
    • protocol_data: ProtocolData
    • remaining_quantity: number
    • side: OrderSide
    • taker: unknown | null
    • taker_fees: {
          account: unknown;
          basis_points: string;
      }[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +SerializedOrderV2 | opensea-js - v7.1.12

    Type alias SerializedOrderV2

    SerializedOrderV2: {
        cancelled: boolean;
        client_signature: string | null;
        closing_date: string | null;
        created_date: string;
        current_price: string;
        expiration_time: number;
        finalized: boolean;
        listing_time: number;
        maker: unknown;
        maker_fees: {
            account: unknown;
            basis_points: string;
        }[];
        marked_invalid: boolean;
        order_hash: string | null;
        order_type: OrderType;
        protocol_address: string;
        protocol_data: ProtocolData;
        remaining_quantity: number;
        side: OrderSide;
        taker: unknown | null;
        taker_fees: {
            account: unknown;
            basis_points: string;
        }[];
    }

    Type declaration

    • cancelled: boolean
    • client_signature: string | null
    • closing_date: string | null
    • created_date: string
    • current_price: string
    • expiration_time: number
    • finalized: boolean
    • listing_time: number
    • maker: unknown
    • maker_fees: {
          account: unknown;
          basis_points: string;
      }[]
    • marked_invalid: boolean
    • order_hash: string | null
    • order_type: OrderType
    • protocol_address: string
    • protocol_data: ProtocolData
    • remaining_quantity: number
    • side: OrderSide
    • taker: unknown | null
    • taker_fees: {
          account: unknown;
          basis_points: string;
      }[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Trait.html b/types/Trait.html index 0ac424ef8..8bebe2612 100644 --- a/types/Trait.html +++ b/types/Trait.html @@ -3,4 +3,4 @@
  • max_value: string

    Ceiling for possible numeric trait values

  • trait_type: string

    The name of the trait category (e.g. 'Background')

  • value: string | number | Date

    The value of the trait (e.g. 'Red')

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file