Hooks de datos del Marketplace

Colección de hooks GET para obtener datos clave del Marketplace. Útiles para obtener y gestionar información del Marketplace en su interfaz de usuario.

​

useMarketplaceConfig

El hook useMarketplaceConfig obtiene la configuración de su Marketplace, incluidas colecciones, enlaces sociales, título y otros ajustes desde Builder.

import { useMarketplaceConfig } from "@0xsequence/marketplace-sdk/react";

## Into your React component:

const data = useMarketplaceConfig();

useMarketplaceConfig

* return properties

Mostrar atributos secundarios

publisherId · string

Identificador único del publicador del marketplace.

title · string

El título del marketplace.

shortDescription · string

Una breve descripción del marketplace.

socials · MarketplaceSocials

Enlaces a redes sociales asociadas al marketplace.

faviconUrl · string

URL del favicon del marketplace.

landingBannerUrl · string

URL del banner del Marketplace para la página de inicio

collections · MarketplaceCollection[]

Lista de colecciones del marketplace.

walletOptions · MarketplaceWalletOptions

Opciones de configuración para integraciones de wallet.

landingPageLayout · string

Configuración de diseño para la página de inicio del marketplace.

logoUrl · string

URL del logo del marketplace.

bannerUrl · string

URL del banner del marketplace.

fontUrl · string | undefined

URL de la fuente personalizada utilizada en el marketplace.

ogImage · string | undefined

URL del ogImage

cssString · string

Estilos CSS personalizados para el marketplace.

manifestUrl · string

URL del archivo manifest del marketplace.

​

useListCollectibles

El hook useListCollectibles obtiene los listados y ofertas actuales de una colección en su Marketplace. Es útil para acceder y gestionar listados y ofertas de manera eficiente.

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useListCollectibles } from '@0xsequence/marketplace-sdk/react';

## Into your React component:

const {
  data: collectibles,
  isLoading: collectiblesLoading,
  fetchNextPage: fetchNextCollectibles,
} = useListCollectibles({
  chainId,
  collectionAddress,
  filter: {
    // # Optional filters
    includeEmpty,
    searchText,
    properties,
  },
  side: OrderSide.listing,
});

const collectiblesFlat =
  collectibles?.pages.flatMap((p) => p.collectibles) ?? [];

return (
  <div>
    {collectiblesFlat?.map((collectible) => (
      // Your Collectibles component
    ))}
  </div>
);

useListCollectibles

* params

Mostrar atributos secundarios

interface UseListCollectiblesArgs {
  chainId: string;
  side: OrderSide;
  collectionAddress: `0x${string}`;
  page?: {
    page: number;
    pageSize: number;
    sort?: {
      order: SortOrder$1;
      column: string;
    }[];
    more?: boolean;
  };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      type: PropertyType;
      name: string;
      values?: any[];
      max?: number;
      min?: number;
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  query?: {
    enabled?: boolean;
  };
}

* return properties

Mostrar atributos secundarios

data · ListCollectiblesReturn

Contiene los datos paginados de órdenes de coleccionables.

data.pages · CollectibleOrder[]

Lista de órdenes de coleccionables devueltas en páginas.

isLoading · boolean

Indica si los datos se están cargando actualmente.

fetchNextPage · (options?: FetchNextPageOptions) => Promise<UseInfiniteQueryResult>

Esta función permite obtener la siguiente “página” de resultados.

​

useListCollectiblesPaginated

El hook useListCollectiblesPaginated obtiene y gestiona de manera eficiente los listados y ofertas actuales de su Marketplace, lo que lo hace ideal para mostrar NFTs paginados dentro de una colección.

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useListCollectiblesPaginated } from '@0xsequence/marketplace-sdk/react';

const chainId = 137;
const searchText = "";
const enabled = true;
const includeEmpty = true;
const properties = [];
const pageSize = 30;
const currentPage = 1;
const collectionAddress = "0x0e5566a108e617baedbebb44e3fcc7bf03e3a839";

## Into your React component:

const {
    data: collectiblesResponse,
    isLoading: collectiblesLoading,
} = useListCollectiblesPaginated({
  chainId: String(chainId),
  collectionAddress,
  side: OrderSide.listing,
  filter: {
    // # Optional filters
    includeEmpty,
    searchText,
    properties,
  },
  page: {
    page: currentPage,
    pageSize,
  },
  query: {
    page: currentPage,
    pageSize,
    enabled,
  },
});

const collectiblesList = collectiblesResponse?.collectibles ?? [];

return (
  <div>
    {collectiblesList?.map((collectible) => (
      // Your Collectibles component
    ))}
  </div>
);

useListCollectiblesPaginated details

* params

Mostrar atributos secundarios

interface UseListCollectiblesPaginatedArgs {
  chainId: string;
  side: OrderSide;
  collectionAddress: `0x${string}`;
  page?: {
    page: number;
    pageSize: number;
    sort?: {
      order: SortOrder$1;
      column: string;
    }[];
    more?: boolean;
  };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      type: PropertyType;
      name: string;
      values?: any[];
      max?: number;
      min?: number;
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  query: {
    page: number;
    pageSize: number;
    enabled?: boolean;
  };
}

* return properties

Mostrar atributos secundarios

data · ListCollectiblesReturn

Contiene los datos de órdenes de coleccionables.

data.collectibles · CollectibleOrder[]

Lista de órdenes de coleccionables.

isLoading · boolean

Indica si los datos se están cargando actualmente.

​

useCountOfCollectables

El hook useCountOfCollectables devuelve la cantidad de NFTs en una colección.

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useCountOfCollectables } from '@0xsequence/marketplace-sdk/react';

const countOfCollectables = useCountOfCollectables({
  chainId,
  collectionAddress,
  side: OrderSide.listing,
  filter: {
    searchText: text,
    includeEmpty,
    properties,
  },
});

useCountOfCollectables details

* params

Mostrar atributos secundarios

interface UseCountOfCollectables {
  chainId: ChainId;
  collectionAddress: CollectionAddress;
  query?: { enabled?: boolean };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      name: string;
      type: PropertyType;
      min?: number;
      max?: number;
      values?: any[];
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  side?: OrderSide;
}

* return properties

Mostrar atributos secundarios

data · number

Respuesta numérica de los datos.

isLoading · boolean

Indica si los datos se están cargando actualmente.