Skip to main content

Function: useSignatures()

useSignatures(params: { options: QueryOptions<SignaturesResponse>; query: SignaturesQueryParams; }): UseQueryResult<SignaturesResponse, Error>

Get pending signatures for the authenticated user.

Returns pending signatures that require user action, such as order signatures or link address signatures. Accepts filtering by address, chain, kind, and profile.

Parameters

ParameterTypeDescription
params{ options: QueryOptions<SignaturesResponse>; query: SignaturesQueryParams; }
params.options?QueryOptions<SignaturesResponse>See Tanstack Query - useQuery options.
params.query?SignaturesQueryParamsOptional query parameters to filter signatures

Returns

UseQueryResult<SignaturesResponse, Error>

Example

// Get all pending signatures
const {
data: signatures,
isLoading,
isError,
error,
refetch,
...moreUseQueryResults
} = useSignatures();

// Get pending order signatures for a specific address
const { data: orderSignatures } = useSignatures({
query: {
address: '0x1234...',
kind: 'order'
}
});

// Check the kind of signature
signatures?.pending.forEach(sig => {
if (sig.kind === 'order') {
console.log('Order signature:', sig.id, sig.amount);
} else {
console.log('Link address signature');
}
});

See

API Documentation