Skip to content

API ReferenceVaults, collateral, and riskInterface

GetCollateralTokensParams

Collection Request parameters.

Extends

Properties

collateralContractAddress?

optional collateralContractAddress?: `0x${string}`;

One vault’s token registry; defaults to the profile’s current vault.


cursor?

optional cursor?: string | null;

The cursor string to request a specific page. null, undefined, and omission all request the first page.

Inherited from

CollectionRequest.cursor


enabled?

optional enabled?: boolean;

Filter on whether the CollateralVault currently accepts the token for new deposits and reservations. true returns only usable tokens (the common case for a token picker); false returns tokens governance has disabled but that may still back existing LOCs; omit for both.


limit?

optional limit?: number;

The maximum number of items per page. This field is optional.

Inherited from

CollectionRequest.limit


tokenAddressAllowlist?

optional tokenAddressAllowlist?: `0x${string}`[];

Restrict results to these token addresses. Omit or pass [] for all collateral tokens.