Type Alias ApiPerpetualsPreviewEditCollateralResponse

ApiPerpetualsPreviewEditCollateralResponse:
| { error: string }
| { collateralChange: number; updatedPosition: PerpetualsPosition }

Response type for a allocate/deallocate collateral preview request.

Either returns an error, or the position and collateral after the change.

Type Declaration

{ error: string }
- error: string
  
  Error message returned when the operation cannot be completed.
{ collateralChange: number; updatedPosition: PerpetualsPosition }
- collateralChange: number
  
  Collateral amount to allocate, deallocate, or change.
- updatedPosition: PerpetualsPosition
  
  Position after the simulated operation.