Interface TransferApiInterface

TransferApi - interface TransferApi

interface TransferApiInterface {
    getCrossMarginTransferHistory(
        requestParameters?: GetCrossMarginTransferHistoryRequest,
    ): Promise<RestApiResponse<GetCrossMarginTransferHistoryResponse>>;
    queryMaxTransferOutAmount(
        requestParameters: QueryMaxTransferOutAmountRequest,
    ): Promise<RestApiResponse<QueryMaxTransferOutAmountResponse>>;
}

Implemented by

MarginTradingRestAPI.TransferApi

Index

Methods

getCrossMarginTransferHistory queryMaxTransferOutAmount

Methods

getCrossMarginTransferHistory

getCrossMarginTransferHistory(
requestParameters?: GetCrossMarginTransferHistoryRequest,
): Promise<RestApiResponse<GetCrossMarginTransferHistoryResponse>>
Get Cross Margin Transfer History

Weight(IP): 1

Security Type: USER_DATA

Notes:
- Response in descending order
- The max interval between startTime and endTime is 30 days.
- Returns data for last 7 days by default
Parameters
- OptionalrequestParameters: GetCrossMarginTransferHistoryRequest
  Request parameters.
Returns Promise<RestApiResponse<GetCrossMarginTransferHistoryResponse>>
Throws
Memberof
TransferApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/transfer-api.ts:183

queryMaxTransferOutAmount

queryMaxTransferOutAmount(
requestParameters: QueryMaxTransferOutAmountRequest,
): Promise<RestApiResponse<QueryMaxTransferOutAmountResponse>>
Query Max Transfer-Out Amount

Weight(IP): 50

Security Type: USER_DATA

Notes:
- If isolatedSymbol is not sent, crossed margin data will be sent.
Parameters
- requestParameters: QueryMaxTransferOutAmountRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryMaxTransferOutAmountResponse>>
Throws
Memberof
TransferApiInterface
- Defined in clients/margin-trading/src/rest-api/modules/transfer-api.ts:202