DOCS

useOffers

Get all the offers for a listing

Fetch all the offers for a specified direct or auction listing.

Example

const listingId = 0;
const {
  data: offers,
  isLoading,
  error,
} = useOffers(contract, listingId);

Parameters

Returns

type ReturnType =
  | {
      data: undefined | Record<string, any>[];
      dataUpdatedAt: number;
      error: unknown;
      errorUpdateCount: number;
      errorUpdatedAt: number;
      failureCount: number;
      failureReason: unknown;
      fetchStatus: FetchStatus;
      isError: true;
      isFetched: boolean;
      isFetchedAfterMount: boolean;
      isFetching: boolean;
      isInitialLoading: boolean;
      isLoading: false;
      isLoadingError: false;
      isPaused: boolean;
      isPlaceholderData: boolean;
      isPreviousData: boolean;
      isRefetchError: true;
      isRefetching: boolean;
      isStale: boolean;
      isSuccess: false;
      refetch: (
        options?: RefetchOptions & RefetchQueryFilters<TPageData>,
      ) => Promise<
        QueryObserverResult<
          ContractEvent<Record<string, any>>[],
          unknown
        >
      >;
      remove: () => void;
      status: "error";
    }
  | {
      data: undefined | Record<string, any>[];
      dataUpdatedAt: number;
      error: null;
      errorUpdateCount: number;
      errorUpdatedAt: number;
      failureCount: number;
      failureReason: unknown;
      fetchStatus: FetchStatus;
      isError: false;
      isFetched: boolean;
      isFetchedAfterMount: boolean;
      isFetching: boolean;
      isInitialLoading: boolean;
      isLoading: false;
      isLoadingError: false;
      isPaused: boolean;
      isPlaceholderData: boolean;
      isPreviousData: boolean;
      isRefetchError: false;
      isRefetching: boolean;
      isStale: boolean;
      isSuccess: true;
      refetch: (
        options?: RefetchOptions & RefetchQueryFilters<TPageData>,
      ) => Promise<
        QueryObserverResult<
          ContractEvent<Record<string, any>>[],
          unknown
        >
      >;
      remove: () => void;
      status: "success";
    }
  | {
      data: undefined | Record<string, any>[];
      dataUpdatedAt: number;
      error: unknown;
      errorUpdateCount: number;
      errorUpdatedAt: number;
      failureCount: number;
      failureReason: unknown;
      fetchStatus: FetchStatus;
      isError: true;
      isFetched: boolean;
      isFetchedAfterMount: boolean;
      isFetching: boolean;
      isInitialLoading: boolean;
      isLoading: false;
      isLoadingError: true;
      isPaused: boolean;
      isPlaceholderData: boolean;
      isPreviousData: boolean;
      isRefetchError: false;
      isRefetching: boolean;
      isStale: boolean;
      isSuccess: false;
      refetch: (
        options?: RefetchOptions & RefetchQueryFilters<TPageData>,
      ) => Promise<
        QueryObserverResult<
          ContractEvent<Record<string, any>>[],
          unknown
        >
      >;
      remove: () => void;
      status: "error";
    }
  | {
      data: undefined | Record<string, any>[];
      dataUpdatedAt: number;
      error: null;
      errorUpdateCount: number;
      errorUpdatedAt: number;
      failureCount: number;
      failureReason: unknown;
      fetchStatus: FetchStatus;
      isError: false;
      isFetched: boolean;
      isFetchedAfterMount: boolean;
      isFetching: boolean;
      isInitialLoading: boolean;
      isLoading: true;
      isLoadingError: false;
      isPaused: boolean;
      isPlaceholderData: boolean;
      isPreviousData: boolean;
      isRefetchError: false;
      isRefetching: boolean;
      isStale: boolean;
      isSuccess: false;
      refetch: (
        options?: RefetchOptions & RefetchQueryFilters<TPageData>,
      ) => Promise<
        QueryObserverResult<
          ContractEvent<Record<string, any>>[],
          unknown
        >
      >;
      remove: () => void;
      status: "loading";
    };