Module account 

Authenticated trading-account endpoints (/api/v5/account/*).

Structs

Account

Accessor for the authenticated account endpoints.

AccountBalance

The trading-account balance summary.

AccountBill

Account bill row.

AccountConfig

Account configuration.

AccountInstrument

Account-level instrument configuration.

AccountInstrumentsRequest

Query parameters for account instruments.

AccountPositionTier

Account position-tier row.

AccountPositionTiersRequest

Query parameters for account position tiers.

ActivateOptionResult

Result of activating option trading.

AdjustLeverageInfo

Estimated impact and limits for a leverage adjustment.

AdjustLeverageInfoRequest

Query parameters for estimating leverage adjustment effects.

AdjustMarginRequest

Request body for adjusting position margin.

AdjustMarginResult

Result of adding or reducing margin on a position.

ApplyBillsHistoryArchiveResult

Result returned after applying for historical account-bills archive generation.

BalanceDetail

Balance details for a single currency.

BalanceRequest

Request for get_balance, get_interest_rate, get_max_withdrawal, and get_greeks.

BillSubtypeDetail

Account bill subtype details.

BillSubtypeMapping

Mapping for an account bill type and its subtypes.

BillSubtypesRequest

Query parameters for account bill type/subtype mapping.

BillsArchiveRequest

Query parameters for archived account bills.

BillsHistoryArchiveFile

Historical account-bills archive download-link information.

BillsHistoryArchiveRequest

Parameters for historical account-bills archive generation and download-link lookup.

BillsRequest

Query parameters for account bills.

BorrowRepayHistory

Borrow/repay history row.

BorrowRepayHistoryRequest

Query parameters for borrow/repay history.

BorrowRepayRequest

Request body for borrow/repay.

BorrowRepayResult

Result of a borrow/repay request.

FeeGroup

Fee-rate group row nested in FeeRate.

FeeRate

Trade fee-rate information.

FeeRatesRequest

Query parameters for trade fee rates.

Greek

Account greeks row.

InterestAccrued

Interest accrued by account borrowing.

InterestAccruedRequest

Query parameters for interest-accrued records.

InterestLimit

Borrowing interest and limit information, as returned by GET /api/v5/account/interest-limits.

InterestLimitsRequest

Query parameters for interest limits.

InterestRate

Account borrowing interest rate.

LeverageInfo

Leverage information.

LeverageRequest

Query parameters for retrieving leverage.

LoanRecord

Per-currency loan record nested in InterestLimit.

MaxAvailableSize

Maximum available size information.

MaxAvailableSizeRequest

Query parameters for maximum available size.

MaxLoan

Maximum loan amount available for an instrument or currency.

MaxLoanRequest

Query parameters for maximum loan.

MaxOrderSize

Maximum order size information.

MaxOrderSizeRequest

Query parameters for maximum order size.

MaxWithdrawal

Maximum withdrawal amount for a currency.

Position

An open position.

PositionBuilderAsset

Asset info returned by position builder.

PositionBuilderMr1Scenarios

MR1 scenario analysis for a risk unit.

PositionBuilderRequest

Request body for position builder.

PositionBuilderResult

Position-builder result, as returned by POST /api/v5/account/position-builder.

PositionBuilderRiskUnit

Risk unit info returned by position builder.

PositionHistory

Historical position row.

PositionRisk

Account position-risk snapshot.

PositionRiskRequest

Request for get_position_risk.

PositionsHistoryRequest

Query parameters for position history.

PositionsRequest

Request for get_positions.

RiskState

Account risk state, as returned by GET /api/v5/account/risk-state.

SetAccountLevelRequest

Request for set_account_level.

SetAccountLevelResult

Result of updating account level.

SetAutoEarnRequest

Request body for POST /api/v5/account/set-auto-earn.

SetAutoEarnResult

Auto-earn setting result.

SetAutoLoanRequest

Request for set_auto_loan.

SetAutoLoanResult

Result of updating auto loan.

SetAutoRepayRequest

Request body for POST /api/v5/account/set-auto-repay.

SetAutoRepayResult

Auto-repay setting result.

SetCollateralAssetsRequest

Request for set_collateral_assets.

SetCollateralAssetsResult

Result of updating collateral assets.

SetGreeksRequest

Request for set_greeks.

SetGreeksResult

Result of updating the greeks display type.

SetIsolatedModeRequest

Request for set_isolated_mode.

SetIsolatedModeResult

Result of updating isolated margin mode.

SetLeverageRequest

Request body for setting leverage.

SetPositionModeRequest

Request for set_position_mode.

SetPositionModeResult

Result of setting position mode.

SetRiskOffsetAmountRequest

Request body for setting the spot risk offset amount.

SetRiskOffsetAmountResult

Result of setting the spot risk offset amount.

SimulatedAsset

A simulated asset used by position-builder requests.

SimulatedMargin

Simulated margin calculation result.

SimulatedMarginDetail

Per-instrument detail in a simulated margin response.

SimulatedMarginRequest

Request body for simulated margin calculation.

SimulatedPosition

A simulated position used by position-builder and simulated-margin requests.

SpotBorrowRepayHistory

Spot borrow/repay history row.

SpotBorrowRepayHistoryRequest

Query parameters for GET /api/v5/account/spot-borrow-repay-history.

SpotBorrowRepayResult

Spot borrow/repay mutation result.

SpotManualBorrowRepayRequest

Request body for POST /api/v5/account/spot-manual-borrow-repay.

Enums

BillsHistoryArchiveFileState

Download-link state for historical account-bills archive files.

BillsHistoryArchiveQuarter

Quarter selector for historical account-bills archive generation.

BillsHistoryArchiveStatus

Status returned after applying for a historical bills archive.

Type Aliases

ApplyBillsHistoryArchiveRequest

Request body for applying historical account-bills archive generation.