getCollateralReservations()

function getCollateralReservations(ctx, params?, options?): Promise<CollateralReservationPage>;

Lists generic collateral reservations, including inactive identities, in numeric ID order within one vault. Every continuation retains its initial deployment and block. Display metadata is not part of the result.

Parameters

Parameter	Type	Description
ctx	SDKContext	SDK context selecting the chain and index endpoint.
params	GetCollateralReservationsParams	Optional account, token, reserving-contract and activity filters in one vault.
options	ReadExecutionOptions	Cancellation controls for the entire page.

Returns

Promise<CollateralReservationPage>

A complete page of normalized reservation facts at one index boundary.

Throws

InvalidArgumentError for invalid filters or a cursor from another request, before I/O.

Throws

SubgraphCompatibilityError when the selected vault or returned data lacks the required index facts.

Example

const page = await getCollateralReservations(sdk, { accountAddress, active: true });