Skip to content

API ReferenceVaults, collateral, and riskInterface

GetCollateralReservationsParams

Collection Request parameters.

Extends

Properties

accountAddress?

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

Match the reservation owner; omission includes every account.


active?

optional active?: boolean;

Omit to include indexed inactive reservations, whose current amounts are zero.


collateralContractAddress?

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

One vault namespace; defaults to the profile’s current vault. Explicitly select an older vault when needed.


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


limit?

optional limit?: number;

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

Inherited from

CollectionRequest.limit


reservingContractAddress?

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

Match the collateralizable reserving contract; omission is unfiltered, not LOC-only.


tokenAddress?

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

Match the reserved token address; omission includes every token.