Skip to content

useRunes

Gets the runes for an address, with optional limit and offset. If no address is provided, the address from the ordinals account will be used.

Import

ts
import { useRunes } from "@midl/react";

Example

tsx
function Runes () {
    const { runes, isLoading, error } = useRunes({
        // address is optional; will use ordinals account address if not provided
    });

    if (isLoading) return <p>Loading...</p>;
    if (error) return <p>Error: {error.message}</p>;

    return (
        <div>
        {runes?.map(rune => (
            <div key={rune.id}>
                <p>{rune.id}</p>
            </div>
        ))}
        </div>
    );
}

Parameters

NameTypeDescription
addressstring(optional) Address to fetch runes for. If not provided, uses the ordinals account address.
limitnumber(optional) Limit the number of runes returned (default: 20).
offsetnumber(optional) Offset for pagination (default: 0).
queryUseQueryOptions(optional) Query options for react-query.
configConfig(optional) Custom config to override the default from context.

Returns

NameTypeDescription
runesGetRunesResponseThe list of fetched runes.
...restobjectAdditional query state (e.g. isLoading, error, etc.).