Class AuthenticatedClientV2

Hierarchy (View Summary)

PublicClientV2
- AuthenticatedClientV2

Index

Constructors

constructor

Accessors

base_url init nonce reject symbol transform

Methods

cancelAllFundingOffers cancelFundingOffer cancelOrder cancelOrdersMultiple claimPosition delete deleteAlert deleteUserSettings derivPositionCollateralLimits derivPositionCollateralSet fetch fundingAutoRenew fundingClose generateDepositInvoice generateToken get getActiveOrders getAlerts getAuditHistory getBook getCalcOrderAvailable getCandles getConfigs getDepositAddress getDepositAddressAll getDerivativesStatus getDerivativesStatusHistory getForeignExchangeRate getFundingCredits getFundingCreditsHistory getFundingInfo getFundingLoans getFundingLoansHistory getFundingOffers getFundingOffersHistory getFundingStats getFundingTradesHistory getIncreasePositionInfo getKeyPermissions getLeaderboards getLedgers getLiquidations getLoginsHistory getMarginInfo getMarketAveragePrice getMovementInfo getMovements getOrdersHistory getOrderTrades getOtcOrdersHistory getPlatformStatus getPositions getPositionsAudit getPositionsHistory getPositionsSnapshot getStats getSummary getTicker getTickers getTickersHistory getTrades getTradesHistory getUserInfo getUserSettings getVASPs getWallets head increasePosition keepFunding lnxInvoicePayments options orderMulti patch post put setAlert setUserSettings submitFundingOffer submitOrder thalexDeposit thalexFreeTransferCount thalexWithdrawal transfer updateOrder updatePositionFundingType withdraw

Constructors

constructor

new AuthenticatedClientV2(
__namedParameters: IAuthenticatedClientV2Options,
): AuthenticatedClientV2
Parameters
- __namedParameters: IAuthenticatedClientV2Options
Returns AuthenticatedClientV2
Overrides PublicClientV2.constructor
- Defined in src/auth-v2.ts:1319

Accessors

base_url

get base_url(): URL
Returns URL
Inherited from PublicClientV2.base_url
- Defined in src/public-v2.ts:649

init

get init(): RequestInit
Returns RequestInit
Inherited from PublicClientV2.init
- Defined in node_modules/rpc-request/dist/index.d.ts:19

nonce

get nonce(): () => string
Returns () => string
- Defined in src/auth-v2.ts:1336
set nonce(nonce: () => string): void
Parameters
- nonce: () => string
Returns void
- Defined in src/auth-v2.ts:1332

reject

get reject(): boolean
Returns boolean
Inherited from PublicClientV2.reject
- Defined in node_modules/rpc-request/dist/index.d.ts:16

symbol

get symbol(): string
Returns string
Inherited from PublicClientV2.symbol
- Defined in src/public-v2.ts:654

transform

get transform(): ITransformType | null
Returns ITransformType | null
Inherited from PublicClientV2.transform
- Defined in node_modules/rpc-request/dist/index.d.ts:17

Methods

cancelAllFundingOffers

cancelAllFundingOffers(
body?: ICancelAllFundingOffersOptions,
): Promise<INotificationV2<null>>
Cancel all funding offers, optionally for a single currency.
Parameters
- body: ICancelAllFundingOffersOptions = {}
Returns Promise<INotificationV2<null>>
- Defined in src/auth-v2.ts:1680

cancelFundingOffer

cancelFundingOffer(
body: ICancelFundingOfferOptions,
): Promise<INotificationV2<IFundingOfferV2>>
Cancel a funding offer.
Parameters
- body: ICancelFundingOfferOptions
Returns Promise<INotificationV2<IFundingOfferV2>>
- Defined in src/auth-v2.ts:1668

cancelOrder

cancelOrder(body: ICancelOrderOptionsV2): Promise<INotificationV2<IOrderV2>>
Cancel an order by id, cid, or cid+cid_date.
Parameters
- body: ICancelOrderOptionsV2
Returns Promise<INotificationV2<IOrderV2>>
- Defined in src/auth-v2.ts:1411

cancelOrdersMultiple

cancelOrdersMultiple(
body?: ICancelOrdersMultipleOptions,
): Promise<INotificationV2<IOrderV2[]>>
Cancel multiple orders by id, gid, cid, or all flag.
Parameters
- body: ICancelOrdersMultipleOptions = {}
Returns Promise<INotificationV2<IOrderV2[]>>
- Defined in src/auth-v2.ts:1423

claimPosition

claimPosition(
body: IClaimPositionOptionsV2,
): Promise<INotificationV2<IPositionV2>>
Claim a position.
Parameters
- body: IClaimPositionOptionsV2
Returns Promise<INotificationV2<IPositionV2>>
- Defined in src/auth-v2.ts:1530

delete

delete<T = unknown>(path?: string, init?: IFetchOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optionalpath: string
- Optionalinit: IFetchOptions
Returns Promise<T>
Inherited from PublicClientV2.delete
- Defined in node_modules/rpc-request/dist/index.d.ts:24

deleteAlert

deleteAlert(__namedParameters: IAlertDeleteOptions): Promise<boolean>
Delete a price alert.
Parameters
- __namedParameters: IAlertDeleteOptions
Returns Promise<boolean>
- Defined in src/auth-v2.ts:1963

deleteUserSettings

deleteUserSettings(
body: IUserSettingsDeleteOptions,
): Promise<INotificationV2<readonly unknown[]>>
Delete user settings by keys.
Parameters
- body: IUserSettingsDeleteOptions
Returns Promise<INotificationV2<readonly unknown[]>>
- Defined in src/auth-v2.ts:2012

derivPositionCollateralLimits

derivPositionCollateralLimits(
body: IDerivCollateralLimitsOptions,
): Promise<IDerivCollateralLimits>
Get derivative position collateral limits.
Parameters
- body: IDerivCollateralLimitsOptions
Returns Promise<IDerivCollateralLimits>
- Defined in src/auth-v2.ts:1627

derivPositionCollateralSet

derivPositionCollateralSet(
body: IDerivCollateralSetOptions,
): Promise<{ status: 0 | 1 }>
Set derivative position collateral.
Parameters
- body: IDerivCollateralSetOptions
Returns Promise<{ status: 0 | 1 }>
- Defined in src/auth-v2.ts:1613

fetch

fetch<T = unknown>(path?: string, __namedParameters?: IFetchOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optionalpath: string
- Optional__namedParameters: IFetchOptions
Returns Promise<T>
Inherited from PublicClientV2.fetch
- Defined in node_modules/rpc-request/dist/index.d.ts:27

fundingAutoRenew

fundingAutoRenew(
body: IFundingAutoRenewOptions,
): Promise<INotificationV2<IFundingAutoRenewStateV2 | null>>
Activate or deactivate funding auto-renew.
Parameters
- body: IFundingAutoRenewOptions
Returns Promise<INotificationV2<IFundingAutoRenewStateV2 | null>>
- Defined in src/auth-v2.ts:1704

fundingClose

fundingClose(body: IFundingCloseOptions): Promise<INotificationV2<null>>
Close a funding loan/credit.
Parameters
- body: IFundingCloseOptions
Returns Promise<INotificationV2<null>>
- Defined in src/auth-v2.ts:1692

generateDepositInvoice

generateDepositInvoice(body: IDepositInvoiceOptions): Promise<IDepositInvoiceV2>
Generate a deposit invoice (e.g. LNX).
Parameters
- body: IDepositInvoiceOptions
Returns Promise<IDepositInvoiceV2>
- Defined in src/auth-v2.ts:1899

generateToken

generateToken(body: IGenerateTokenOptions): Promise<string>
Generate a short-lived API token.
Parameters
- body: IGenerateTokenOptions
Returns Promise<string>
- Defined in src/auth-v2.ts:1849

get

get<T = unknown>(
path?: string,
init?: IFetchOptions & { options?: IRecordType },
): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IFetchOptions & { options?: IRecordType } = {}
Returns Promise<T>
Inherited from PublicClientV2.get
- Defined in src/public-v2.ts:658

getActiveOrders

getActiveOrders(__namedParameters?: IRetrieveOrdersOptions): Promise<IOrderV2[]>
Retrieve active orders, optionally filtered by symbol.
Parameters
- __namedParameters: IRetrieveOrdersOptions = {}
Returns Promise<IOrderV2[]>
- Defined in src/auth-v2.ts:1374

getAlerts

getAlerts(): Promise<IAlertV2[]>
List all active price alerts.

Returns Promise<IAlertV2[]>
- Defined in src/auth-v2.ts:1951

getAuditHistory

getAuditHistory(body?: IPaginationOptions): Promise<IAuditLogV2[]>
Account changelog.
Parameters
- body: IPaginationOptions = {}
Returns Promise<IAuditLogV2[]>
- Defined in src/auth-v2.ts:1855

getBook

getBook(__namedParameters?: IBookOptionsV2): Promise<IBookEntryV2[]>
Order book of a given pair.
Parameters
- __namedParameters: IBookOptionsV2 = {}
Returns Promise<IBookEntryV2[]>
Inherited from PublicClientV2.getBook
- Defined in src/public-v2.ts:739

getCalcOrderAvailable

getCalcOrderAvailable(body: ICalcOrderAvailOptions): Promise<number>
Calculate balance available for orders/offers.
Parameters
- body: ICalcOrderAvailOptions
Returns Promise<number>
- Defined in src/auth-v2.ts:1974

getCandles

getCandles(__namedParameters: ICandlesOptions): Promise<ICandleV2 | ICandleV2[]>
Provides a way to access charting candle info.
Parameters
- __namedParameters: ICandlesOptions
Returns Promise<ICandleV2 | ICandleV2[]>
Inherited from PublicClientV2.getCandles
- Defined in src/public-v2.ts:771

getConfigs

getConfigs(__namedParameters: IConfigsOptions): Promise<unknown[]>
Public configurations endpoint. Returns raw data as documented per config key.
Parameters
- __namedParameters: IConfigsOptions
Returns Promise<unknown[]>
Inherited from PublicClientV2.getConfigs
- Defined in src/public-v2.ts:801

getDepositAddress

getDepositAddress(
body: IDepositAddressOptions,
): Promise<INotificationV2<IDepositAddressV2>>
Get a deposit address.
Parameters
- body: IDepositAddressOptions
Returns Promise<INotificationV2<IDepositAddressV2>>
- Defined in src/auth-v2.ts:1875

getDepositAddressAll

getDepositAddressAll(
body: IDepositAddressAllOptions,
): Promise<IDepositAddressAllEntry[]>
List all deposit addresses for a method.
Parameters
- body: IDepositAddressAllOptions
Returns Promise<IDepositAddressAllEntry[]>
- Defined in src/auth-v2.ts:1887

getDerivativesStatus

getDerivativesStatus(
__namedParameters: IDerivativesStatusOptions,
): Promise<IDerivativeStatus[]>
Endpoint used to receive different types of platform information.
Parameters
- __namedParameters: IDerivativesStatusOptions
Returns Promise<IDerivativeStatus[]>
Inherited from PublicClientV2.getDerivativesStatus
- Defined in src/public-v2.ts:807

getDerivativesStatusHistory

getDerivativesStatusHistory(
__namedParameters: IDerivativesStatusHistoryOptions,
): Promise<IDerivativeStatus[]>
History of derivative statuses for a single key.
Parameters
- __namedParameters: IDerivativesStatusHistoryOptions
Returns Promise<IDerivativeStatus[]>
Inherited from PublicClientV2.getDerivativesStatusHistory
- Defined in src/public-v2.ts:817

getForeignExchangeRate

getForeignExchangeRate(
body: IForeignExchangeRateOptions,
): Promise<IForeignExchangeRate>
Calculate the exchange rate between two currencies.
Parameters
- body: IForeignExchangeRateOptions
Returns Promise<IForeignExchangeRate>
Inherited from PublicClientV2.getForeignExchangeRate
- Defined in src/public-v2.ts:880

getFundingCredits

getFundingCredits(
__namedParameters?: ISymbolOptionalOptions,
): Promise<IFundingCreditV2[]>
Active funding credits, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolOptionalOptions = {}
Returns Promise<IFundingCreditV2[]>
- Defined in src/auth-v2.ts:1771

getFundingCreditsHistory

getFundingCreditsHistory(
__namedParameters?: ISymbolPathHistoryOptions,
): Promise<IFundingCreditV2[]>
Funding credits history, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolPathHistoryOptions = {}
Returns Promise<IFundingCreditV2[]>
- Defined in src/auth-v2.ts:1783

getFundingInfo

getFundingInfo(__namedParameters: IInfoFundingOptions): Promise<IFundingInfoV2>
Get funding info for a symbol.
Parameters
- __namedParameters: IInfoFundingOptions
Returns Promise<IFundingInfoV2>
- Defined in src/auth-v2.ts:1809

getFundingLoans

getFundingLoans(
__namedParameters?: ISymbolOptionalOptions,
): Promise<IFundingLoanV2[]>
Active funding loans, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolOptionalOptions = {}
Returns Promise<IFundingLoanV2[]>
- Defined in src/auth-v2.ts:1746

getFundingLoansHistory

getFundingLoansHistory(
__namedParameters?: ISymbolPathHistoryOptions,
): Promise<IFundingLoanV2[]>
Funding loans history, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolPathHistoryOptions = {}
Returns Promise<IFundingLoanV2[]>
- Defined in src/auth-v2.ts:1758

getFundingOffers

getFundingOffers(
__namedParameters?: ISymbolOptionalOptions,
): Promise<IFundingOfferV2[]>
Get active funding offers, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolOptionalOptions = {}
Returns Promise<IFundingOfferV2[]>
- Defined in src/auth-v2.ts:1644

getFundingOffersHistory

getFundingOffersHistory(
__namedParameters?: ISymbolPathHistoryOptions,
): Promise<IFundingOfferV2[]>
Funding offers history, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolPathHistoryOptions = {}
Returns Promise<IFundingOfferV2[]>
- Defined in src/auth-v2.ts:1733

getFundingStats

getFundingStats(
__namedParameters?: IFundingStatsOptions,
): Promise<IFundingStat[]>
Get a list of the most recent funding data: FRR, average period, etc.
Parameters
- __namedParameters: IFundingStatsOptions = {}
Returns Promise<IFundingStat[]>
Inherited from PublicClientV2.getFundingStats
- Defined in src/public-v2.ts:852

getFundingTradesHistory

getFundingTradesHistory(
__namedParameters?: ISymbolPathHistoryOptions,
): Promise<IFundingTradeAuthV2[]>
Funding trades history, optionally filtered by symbol.
Parameters
- __namedParameters: ISymbolPathHistoryOptions = {}
Returns Promise<IFundingTradeAuthV2[]>
- Defined in src/auth-v2.ts:1796

getIncreasePositionInfo

getIncreasePositionInfo(
body: IIncreasePositionInfoOptions,
): Promise<IIncreasePositionInfoV2>
Get info about increasing a position.
Parameters
- body: IIncreasePositionInfoOptions
Returns Promise<IIncreasePositionInfoV2>
- Defined in src/auth-v2.ts:1554

getKeyPermissions

getKeyPermissions(): Promise<IKeyPermissionV2[]>
Get key permissions for the active API key.

Returns Promise<IKeyPermissionV2[]>
- Defined in src/auth-v2.ts:1843

getLeaderboards

getLeaderboards(
__namedParameters: ILeaderboardsOptions,
): Promise<ILeaderboardEntry[]>
Get leaderboards entries.
Parameters
- __namedParameters: ILeaderboardsOptions
Returns Promise<ILeaderboardEntry[]>
Inherited from PublicClientV2.getLeaderboards
- Defined in src/public-v2.ts:838

getLedgers

getLedgers(__namedParameters?: ILedgersOptions): Promise<ILedgerEntryV2[]>
Get ledger entries, optionally filtered by currency.
Parameters
- __namedParameters: ILedgersOptions = {}
Returns Promise<ILedgerEntryV2[]>
- Defined in src/auth-v2.ts:1499

getLiquidations

getLiquidations(options?: ILiquidationsOptions): Promise<ILiquidation[]>
Endpoint to retrieve liquidations.
Parameters
- options: ILiquidationsOptions = {}
Returns Promise<ILiquidation[]>
Inherited from PublicClientV2.getLiquidations
- Defined in src/public-v2.ts:828

getLoginsHistory

getLoginsHistory(body?: IPaginationOptions): Promise<ILoginEntryV2[]>
Login history.
Parameters
- body: IPaginationOptions = {}
Returns Promise<ILoginEntryV2[]>
- Defined in src/auth-v2.ts:1831

getMarginInfo

getMarginInfo(
__namedParameters: IInfoMarginOptions,
): Promise<IMarginInfoV2 | IMarginInfoV2[]>
Get margin info for the given key ("base", "sym_all" or a symbol).
Parameters
- __namedParameters: IInfoMarginOptions
Returns Promise<IMarginInfoV2 | IMarginInfoV2[]>
- Defined in src/auth-v2.ts:1513

getMarketAveragePrice

getMarketAveragePrice(
body: IMarketAveragePriceOptions,
): Promise<IMarketAveragePrice>
Calculate the average execution price for trading.
Parameters
- body: IMarketAveragePriceOptions
Returns Promise<IMarketAveragePrice>
Inherited from PublicClientV2.getMarketAveragePrice
- Defined in src/public-v2.ts:868

getMovementInfo

getMovementInfo(body: IMovementInfoOptions): Promise<IMovementInfoV2>
Detailed movement info by id.
Parameters
- body: IMovementInfoOptions
Returns Promise<IMovementInfoV2>
- Defined in src/auth-v2.ts:1939

getMovements

getMovements(__namedParameters?: IMovementsOptions): Promise<IMovementV2[]>
Movements (deposits/withdrawals), optionally filtered by currency.
Parameters
- __namedParameters: IMovementsOptions = {}
Returns Promise<IMovementV2[]>
- Defined in src/auth-v2.ts:1926

getOrdersHistory

getOrdersHistory(__namedParameters?: IOrdersHistoryOptions): Promise<IOrderV2[]>
Get orders history, optionally filtered by symbol.
Parameters
- __namedParameters: IOrdersHistoryOptions = {}
Returns Promise<IOrderV2[]>
- Defined in src/auth-v2.ts:1447

getOrderTrades

getOrderTrades(__namedParameters: IOrderTradesOptions): Promise<IAuthTradeV2[]>
Get trades executed for a specific order.
Parameters
- __namedParameters: IOrderTradesOptions
Returns Promise<IAuthTradeV2[]>
- Defined in src/auth-v2.ts:1460

getOtcOrdersHistory

getOtcOrdersHistory(
__namedParameters?: IOtcOrdersHistoryOptions,
): Promise<IOtcOrderV2[]>
Get OTC orders history (Symbol path segment is mandatory, may be a marker).
Parameters
- __namedParameters: IOtcOrdersHistoryOptions = {}
Returns Promise<IOtcOrderV2[]>
- Defined in src/auth-v2.ts:1484

getPlatformStatus

getPlatformStatus(): Promise<IPlatformStatus>
Get the current status of the platform (operative or maintenance).

Returns Promise<IPlatformStatus>
Inherited from PublicClientV2.getPlatformStatus
- Defined in src/public-v2.ts:692

getPositions

getPositions(): Promise<IPositionV2[]>
Get active positions.

Returns Promise<IPositionV2[]>
- Defined in src/auth-v2.ts:1524

getPositionsAudit

getPositionsAudit(body: IPositionsAuditOptions): Promise<IPositionV2[]>
Audit positions by id list.
Parameters
- body: IPositionsAuditOptions
Returns Promise<IPositionV2[]>
- Defined in src/auth-v2.ts:1590

getPositionsHistory

getPositionsHistory(body?: IPositionsHistoryOptions): Promise<IPositionV2[]>
Get positions history.
Parameters
- body: IPositionsHistoryOptions = {}
Returns Promise<IPositionV2[]>
- Defined in src/auth-v2.ts:1566

getPositionsSnapshot

getPositionsSnapshot(body?: IPositionsSnapshotOptions): Promise<IPositionV2[]>
Get positions snapshot.
Parameters
- body: IPositionsSnapshotOptions = {}
Returns Promise<IPositionV2[]>
- Defined in src/auth-v2.ts:1578

getStats

getStats(options: IStatsOptions): Promise<IStatV2 | IStatV2[]>
Various statistics about the requested pair.
Parameters
- options: IStatsOptions
Returns Promise<IStatV2 | IStatV2[]>
Inherited from PublicClientV2.getStats
- Defined in src/public-v2.ts:753

getSummary

getSummary(): Promise<ISummaryV2>
Get account summary (fees, volumes, LEO).

Returns Promise<ISummaryV2>
- Defined in src/auth-v2.ts:1825

getTicker

getTicker(__namedParameters?: ISymbolOptionsV2): Promise<ITickerV2>
High level overview of the state of the market for a single trading or funding pair.
Parameters
- __namedParameters: ISymbolOptionsV2 = {}
Returns Promise<ITickerV2>
Inherited from PublicClientV2.getTicker
- Defined in src/public-v2.ts:698

getTickers

getTickers(__namedParameters: ITickersOptions): Promise<ITickerV2[]>
High level overview of the state of the market for several pairs.
Parameters
- __namedParameters: ITickersOptions
Returns Promise<ITickerV2[]>
Inherited from PublicClientV2.getTickers
- Defined in src/public-v2.ts:706

getTickersHistory

getTickersHistory(
__namedParameters: ITickersHistoryOptions,
): Promise<ITickerHistoryV2[]>
Historical data for the tickers endpoint.
Parameters
- __namedParameters: ITickersHistoryOptions
Returns Promise<ITickerHistoryV2[]>
Inherited from PublicClientV2.getTickersHistory
- Defined in src/public-v2.ts:714

getTrades

getTrades(__namedParameters?: ITradesOptionsV2): Promise<ITradeV2[]>
Public trades that have occurred for the requested trading or funding pair.
Parameters
- __namedParameters: ITradesOptionsV2 = {}
Returns Promise<ITradeV2[]>
Inherited from PublicClientV2.getTrades
- Defined in src/public-v2.ts:725

getTradesHistory

getTradesHistory(
__namedParameters?: ITradesHistoryOptions,
): Promise<IAuthTradeV2[]>
Get trades history, optionally filtered by symbol.
Parameters
- __namedParameters: ITradesHistoryOptions = {}
Returns Promise<IAuthTradeV2[]>
- Defined in src/auth-v2.ts:1471

getUserInfo

getUserInfo(): Promise<IUserInfoV2>
Get user info.

Returns Promise<IUserInfoV2>
- Defined in src/auth-v2.ts:1819

getUserSettings

getUserSettings(body: IUserSettingsReadOptions): Promise<IUserSettingEntry[]>
Read user settings by keys.
Parameters
- body: IUserSettingsReadOptions
Returns Promise<IUserSettingEntry[]>
- Defined in src/auth-v2.ts:1986

getVASPs

getVASPs(): Promise<IVASPs>
List of Virtual Asset Service Providers supported by Bitfinex.

Returns Promise<IVASPs>
Inherited from PublicClientV2.getVASPs
- Defined in src/public-v2.ts:863

getWallets

getWallets(): Promise<IWalletV2[]>
Returns an array of all the current user's wallets.

Returns Promise<IWalletV2[]>
- Defined in src/auth-v2.ts:1366

head

head(path?: string, init?: IFetchOptions): Promise<Response>
Parameters
- Optionalpath: string
- Optionalinit: IFetchOptions
Returns Promise<Response>
Inherited from PublicClientV2.head
- Defined in node_modules/rpc-request/dist/index.d.ts:21

increasePosition

increasePosition(
body: IIncreasePositionOptions,
): Promise<INotificationV2<IPositionV2>>
Increase an active position.
Parameters
- body: IIncreasePositionOptions
Returns Promise<INotificationV2<IPositionV2>>
- Defined in src/auth-v2.ts:1542

keepFunding

keepFunding(body: IKeepFundingOptions): Promise<INotificationV2<null>>
Keep funding (credit/loan).
Parameters
- body: IKeepFundingOptions
Returns Promise<INotificationV2<null>>
- Defined in src/auth-v2.ts:1721

lnxInvoicePayments

lnxInvoicePayments(body: ILnxInvoicePaymentsOptions): Promise<unknown>
Query LNX invoice payments (action-driven).
Parameters
- body: ILnxInvoicePaymentsOptions
Returns Promise<unknown>
- Defined in src/auth-v2.ts:1911

options

options<T = unknown>(path?: string, init?: IFetchOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optionalpath: string
- Optionalinit: IFetchOptions
Returns Promise<T>
Inherited from PublicClientV2.options
- Defined in node_modules/rpc-request/dist/index.d.ts:25

orderMulti

orderMulti(body: IOrderMultiOptions): Promise<unknown>
Send multiple order operations in a single request. Each operation is [command, params].
Parameters
- body: IOrderMultiOptions
Returns Promise<unknown>
- Defined in src/auth-v2.ts:1438

patch

patch<T = unknown>(path?: string, init?: IFetchOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optionalpath: string
- Optionalinit: IFetchOptions
Returns Promise<T>
Inherited from PublicClientV2.patch
- Defined in node_modules/rpc-request/dist/index.d.ts:26

post

post<T = unknown>(
    path?: string,
    init?: IFetchOptions,
    body?: Record<string, unknown>,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IFetchOptions = {}
- body: Record<string, unknown> = {}
Returns Promise<T>
Overrides PublicClientV2.post
- Defined in src/auth-v2.ts:1340

put

put<T = unknown>(path?: string, init?: IFetchOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optionalpath: string
- Optionalinit: IFetchOptions
Returns Promise<T>
Inherited from PublicClientV2.put
- Defined in node_modules/rpc-request/dist/index.d.ts:23

setAlert

setAlert(body: IAlertSetOptions): Promise<IAlertV2>
Set a price alert.
Parameters
- body: IAlertSetOptions
Returns Promise<IAlertV2>
- Defined in src/auth-v2.ts:1957

setUserSettings

setUserSettings(
body: IUserSettingsWriteOptions,
): Promise<INotificationV2<readonly unknown[]>>
Write user settings. Each entry is [key, value]; the API expects them inside a {settings: [...]} wrapper.
Parameters
- body: IUserSettingsWriteOptions
Returns Promise<INotificationV2<readonly unknown[]>>
- Defined in src/auth-v2.ts:2001

submitFundingOffer

submitFundingOffer(
body: ISubmitFundingOfferOptions,
): Promise<INotificationV2<IFundingOfferV2>>
Submit a new funding offer.
Parameters
- body: ISubmitFundingOfferOptions
Returns Promise<INotificationV2<IFundingOfferV2>>
- Defined in src/auth-v2.ts:1656

submitOrder

submitOrder(body: ISubmitOrderOptions): Promise<INotificationV2<IOrderV2[]>>
Submit a new order.
Parameters
- body: ISubmitOrderOptions
Returns Promise<INotificationV2<IOrderV2[]>>
- Defined in src/auth-v2.ts:1387

thalexDeposit

thalexDeposit(body: IThalexProviderOptions): Promise<IThalexTransferV2>
Submit a Thalex deposit request.
Parameters
- body: IThalexProviderOptions
Returns Promise<IThalexTransferV2>
- Defined in src/auth-v2.ts:2023

thalexFreeTransferCount

thalexFreeTransferCount(
__namedParameters: IThalexFreeTransferCountOptions,
): Promise<IThalexFreeTransferCountV2>
Get Thalex free transfer counts (deposits/withdrawals).

Unlike the deposit/withdrawal endpoints (lowercase provider), the docs specify this endpoint's body key as capitalized Provider; the lowercase option is mapped accordingly.
Parameters
- __namedParameters: IThalexFreeTransferCountOptions
Returns Promise<IThalexFreeTransferCountV2>
- Defined in src/auth-v2.ts:2051

thalexWithdrawal

thalexWithdrawal(body: IThalexProviderOptions): Promise<IThalexTransferV2>
Submit a Thalex withdrawal request.
Parameters
- body: IThalexProviderOptions
Returns Promise<IThalexTransferV2>
- Defined in src/auth-v2.ts:2034

transfer

transfer(body: ITransferOptionsV2): Promise<INotificationV2<ITransferV2>>
Transfer between wallets.
Parameters
- body: ITransferOptionsV2
Returns Promise<INotificationV2<ITransferV2>>
- Defined in src/auth-v2.ts:1867

updateOrder

updateOrder(body: IUpdateOrderOptions): Promise<INotificationV2<IOrderV2>>
Update an existing order.
Parameters
- body: IUpdateOrderOptions
Returns Promise<INotificationV2<IOrderV2>>
- Defined in src/auth-v2.ts:1399

updatePositionFundingType

updatePositionFundingType(
body: IUpdatePositionFundingTypeOptions,
): Promise<INotificationV2<null>>
Update position funding type (0 = daily, 1 = term).
Parameters
- body: IUpdatePositionFundingTypeOptions
Returns Promise<INotificationV2<null>>
- Defined in src/auth-v2.ts:1602

withdraw

withdraw(body: IWithdrawOptionsV2): Promise<INotificationV2<IWithdrawalV2>>
Submit a withdrawal request.
Parameters
- body: IWithdrawOptionsV2
Returns Promise<INotificationV2<IWithdrawalV2>>
- Defined in src/auth-v2.ts:1918

Class AuthenticatedClientV2

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AuthenticatedClientV2

Accessors

base_url

Returns URL

init

Returns RequestInit

nonce

Returns () => string

Parameters

Returns void

reject

Returns boolean

symbol

Returns string

transform

Returns ITransformType | null

Methods

cancelAllFundingOffers

Parameters

Returns Promise<INotificationV2<null>>

cancelFundingOffer

Parameters

Returns Promise<INotificationV2<IFundingOfferV2>>

cancelOrder

Parameters

Returns Promise<INotificationV2<IOrderV2>>

cancelOrdersMultiple

Parameters

Returns Promise<INotificationV2<IOrderV2[]>>

claimPosition

Parameters

Returns Promise<INotificationV2<IPositionV2>>

delete

Type Parameters

Parameters

Returns Promise<T>

deleteAlert

Parameters

Returns Promise<boolean>

deleteUserSettings

Parameters

Returns Promise<INotificationV2<readonly unknown[]>>

derivPositionCollateralLimits

Parameters

Returns Promise<IDerivCollateralLimits>

derivPositionCollateralSet

Parameters

Returns Promise<{ status: 0 | 1 }>

fetch

Type Parameters

Parameters

Returns Promise<T>

fundingAutoRenew

Parameters

Returns Promise<INotificationV2<IFundingAutoRenewStateV2 | null>>

fundingClose

Parameters

Returns Promise<INotificationV2<null>>

generateDepositInvoice

Parameters

Returns Promise<IDepositInvoiceV2>

generateToken

Parameters

Returns Promise<string>

get

Type Parameters

Parameters

Returns Promise<T>

getActiveOrders

Parameters

Returns Promise<IOrderV2[]>