Class AuthenticatedClient

Hierarchy (View Summary)

PublicClient
- AuthenticatedClient

Index

Constructors

constructor

Accessors

base_url currency init nonce reject symbol transform

Methods

activeCredits cancelAllOrders cancelOffer cancelOrder cancelOrders claimPosition closeFunding closePosition delete fetch get getAccountFees getAccountInfo getBalanceHistory getDepositAddress getDepositsWithdrawals getFundingBook getFundingTrades getKeyPermissions getLends getMarginInformation getOffers getOrder getOrderBook getOrderHistory getOrders getPastTrades getPositions getStats getSummary getSymbolDetails getSymbols getTakenFunds getTicker getTotalFunds getTrades getUnusedFunds getWalletBalances head newOffer newOrder newOrders offersHistory offerStatus options patch post put replaceOrder transfer withdraw setQuery

Constructors

constructor

new AuthenticatedClient(
__namedParameters: IAuthenticatedClientOptions,
): AuthenticatedClient
Parameters
- __namedParameters: IAuthenticatedClientOptions
Returns AuthenticatedClient
Overrides PublicClient.constructor
- Defined in src/auth.ts:476

Accessors

base_url

get base_url(): URL
Returns URL
Inherited from PublicClient.base_url
- Defined in src/public.ts:129

currency

get currency(): string
Returns string
Inherited from PublicClient.currency
- Defined in src/public.ts:138

init

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

nonce

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

reject

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

symbol

get symbol(): string
Returns string
Inherited from PublicClient.symbol
- Defined in src/public.ts:134

transform

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

Methods

activeCredits

activeCredits(): Promise<ICredit[]>
Get the funds currently taken.

Returns Promise<ICredit[]>
- Defined in src/auth.ts:702

cancelAllOrders

cancelAllOrders(): Promise<{ result: string }>
Cancel all active orders at once.

Returns Promise<{ result: string }>
- Defined in src/auth.ts:617

cancelOffer

cancelOffer(body: ICancelOfferOptions): Promise<IOffer>
Cancel an offer.
Parameters
- body: ICancelOfferOptions
Returns Promise<IOffer>
- Defined in src/auth.ts:692

cancelOrder

cancelOrder(body: ICancelOrderOptions): Promise<IOrderResponse>
Cancel an order.
Parameters
- body: ICancelOrderOptions
Returns Promise<IOrderResponse>
- Defined in src/auth.ts:603

cancelOrders

cancelOrders(body: ICancelOrdersOptions): Promise<{ result: string }>
Cancel multiples orders at once.
Parameters
- body: ICancelOrdersOptions
Returns Promise<{ result: string }>
- Defined in src/auth.ts:608

claimPosition

claimPosition(body: IClaimPositionOptions): Promise<IPosition>
Claim your position.
Parameters
- body: IClaimPositionOptions
Returns Promise<IPosition>
- Defined in src/auth.ts:656

closeFunding

closeFunding(body: ICloseFundingOptions): Promise<ITakenFund>
Close a taken funding.
Parameters
- body: ICloseFundingOptions
Returns Promise<ITakenFund>
- Defined in src/auth.ts:739

closePosition

closePosition(body: IClosePositionOptions): Promise<IClosePositionResponse>
Close the position with a market order.
Parameters
- body: IClosePositionOptions
Returns Promise<IClosePositionResponse>
- Defined in src/auth.ts:744

delete

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

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 PublicClient.fetch
- Defined in node_modules/rpc-request/dist/index.d.ts:27

get

get<T = unknown>(
path?: string,
__namedParameters?: IBitfinexGetOptions,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- __namedParameters: IBitfinexGetOptions = {}
Returns Promise<T>
Inherited from PublicClient.get
- Defined in src/public.ts:142

getAccountFees

getAccountFees(): Promise<IAccountFees>
Return the fees applied to your withdrawals.

Returns Promise<IAccountFees>
- Defined in src/auth.ts:527

getAccountInfo

getAccountInfo(): Promise<IAccountInfo>
Return information about your account (trading fees).

Returns Promise<IAccountInfo>
- Defined in src/auth.ts:522

getBalanceHistory

getBalanceHistory(body: IBalanceHistoryOptions): Promise<IHistoryBalance[]>
Get balance ledger entries.
Parameters
- body: IBalanceHistoryOptions
Returns Promise<IHistoryBalance[]>
- Defined in src/auth.ts:661

getDepositAddress

getDepositAddress(body: IDepositOptions): Promise<IDepositAddress>
Return your deposit address to make a new deposit.
Parameters
- body: IDepositOptions
Returns Promise<IDepositAddress>
- Defined in src/auth.ts:537

getDepositsWithdrawals

getDepositsWithdrawals(
body: IDepositsWithdrawalsOptions,
): Promise<IDepositWithdrawal[]>
Get past deposits/withdrawals.
Parameters
- body: IDepositsWithdrawalsOptions
Returns Promise<IDepositWithdrawal[]>
- Defined in src/auth.ts:668

getFundingBook

getFundingBook(__namedParameters?: IFundingBookOptions): Promise<IFundingBook>
Get the full margin funding book.
Parameters
- __namedParameters: IFundingBookOptions = {}
Returns Promise<IFundingBook>
Inherited from PublicClient.getFundingBook
- Defined in src/public.ts:167

getFundingTrades

getFundingTrades(body: IFundingTradesOptions): Promise<IFundingTrade[]>
Get past funding trades.
Parameters
- body: IFundingTradesOptions
Returns Promise<IFundingTrade[]>
- Defined in src/auth.ts:717

getKeyPermissions

getKeyPermissions(): Promise<IKeyPermissions>
Return the permissions of the key being used to generate this request.

Returns Promise<IKeyPermissions>
- Defined in src/auth.ts:542

getLends

getLends(__namedParameters?: ILendsOptions): Promise<ILend[]>
Get a list of the most recent funding data for the given currency: total amount provided and Flash Return Rate (in % by 365 days) over time.
Parameters
- __namedParameters: ILendsOptions = {}
Returns Promise<ILend[]>
Inherited from PublicClient.getLends
- Defined in src/public.ts:194

getMarginInformation

getMarginInformation(): Promise<IMarginInformation[]>
Return the trading wallet information for margin trading.

Returns Promise<IMarginInformation[]>
- Defined in src/auth.ts:547

getOffers

getOffers(): Promise<IOffer[]>
Get active offers.

Returns Promise<IOffer[]>
- Defined in src/auth.ts:707

getOrder

getOrder(body: IOrderStatusOptions): Promise<IOrderResponse>
Get the status of an order.
Parameters
- body: IOrderStatusOptions
Returns Promise<IOrderResponse>
- Defined in src/auth.ts:634

getOrderBook

getOrderBook(__namedParameters?: IOrderBookOptions): Promise<IOrderBook>
Get the full order book.
Parameters
- __namedParameters: IOrderBookOptions = {}
Returns Promise<IOrderBook>
Inherited from PublicClient.getOrderBook
- Defined in src/public.ts:175

getOrderHistory

getOrderHistory(body?: IOrderHistoryOptions): Promise<IOrderResponse[]>
Get your latest inactive orders.
Parameters
- body: IOrderHistoryOptions = {}
Returns Promise<IOrderResponse[]>
- Defined in src/auth.ts:644

getOrders

getOrders(): Promise<IOrderResponse[]>
Get your active orders.

Returns Promise<IOrderResponse[]>
- Defined in src/auth.ts:639

getPastTrades

getPastTrades(__namedParameters?: IPastTradesOptions): Promise<IPastTrade[]>
Get past trades.
Parameters
- __namedParameters: IPastTradesOptions = {}
Returns Promise<IPastTrade[]>
- Defined in src/auth.ts:679

getPositions

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

Returns Promise<IPosition[]>
- Defined in src/auth.ts:651

getStats

getStats(__namedParameters?: ISymbolOptions): Promise<IStat[]>
Various statistics about the requested pair.
Parameters
- __namedParameters: ISymbolOptions = {}
Returns Promise<IStat[]>
Inherited from PublicClient.getStats
- Defined in src/public.ts:160

getSummary

getSummary(): Promise<ISummary>
Return a 30-day summary of your trading volume and return on margin funding.

Returns Promise<ISummary>
- Defined in src/auth.ts:532

getSymbolDetails

getSymbolDetails(): Promise<ISymbolDetail[]>
Get a list of valid symbol IDs and the pair details.

Returns Promise<ISymbolDetail[]>
Inherited from PublicClient.getSymbolDetails
- Defined in src/public.ts:207

getSymbols

getSymbols(): Promise<string[]>
Get the list of symbol names.

Returns Promise<string[]>
Inherited from PublicClient.getSymbols
- Defined in src/public.ts:202

getTakenFunds

getTakenFunds(): Promise<ITakenFund[]>
Get funds used in a margin position.

Returns Promise<ITakenFund[]>
- Defined in src/auth.ts:724

getTicker

getTicker(__namedParameters?: ISymbolOptions): Promise<ITicker>
Get the ticker.
Parameters
- __namedParameters: ISymbolOptions = {}
Returns Promise<ITicker>
Inherited from PublicClient.getTicker
- Defined in src/public.ts:153

getTotalFunds

getTotalFunds(): Promise<ITotalFund[]>
Get the total of active funding used in positions.

Returns Promise<ITotalFund[]>
- Defined in src/auth.ts:734

getTrades

getTrades(__namedParameters?: ITradesOptions): Promise<ITrade[]>
Get a list of the most recent trades for the given symbol.
Parameters
- __namedParameters: ITradesOptions = {}
Returns Promise<ITrade[]>
Inherited from PublicClient.getTrades
- Defined in src/public.ts:183

getUnusedFunds

getUnusedFunds(): Promise<ITakenFund[]>
Get borrowed funds and not used in a margin position.

Returns Promise<ITakenFund[]>
- Defined in src/auth.ts:729

getWalletBalances

getWalletBalances(): Promise<IWalletBalance[]>
Return your balances.

Returns Promise<IWalletBalance[]>
- Defined in src/auth.ts:552

head

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

newOffer

newOffer(body: INewOfferOptions): Promise<IOffer>
Submit a new offer.
Parameters
- body: INewOfferOptions
Returns Promise<IOffer>
- Defined in src/auth.ts:687

newOrder

newOrder(__namedParameters: IOrderOptions): Promise<IOrderResponse>
Submit a new Order.
Parameters
- __namedParameters: IOrderOptions
Returns Promise<IOrderResponse>
- Defined in src/auth.ts:574

newOrders

newOrders(
__namedParameters: { orders: IOrderOptions[] },
): Promise<INewOrdersResponse>
Submit several new orders at once.
Parameters
- __namedParameters: { orders: IOrderOptions[] }
Returns Promise<INewOrdersResponse>
- Defined in src/auth.ts:586

offersHistory

offersHistory(body?: IOrderHistoryOptions): Promise<IOffer[]>
Get latest inactive offers.
Parameters
- body: IOrderHistoryOptions = {}
Returns Promise<IOffer[]>
- Defined in src/auth.ts:712

offerStatus

offerStatus(body: IOfferStatusOptions): Promise<IOffer>
Get the status of an offer.
Parameters
- body: IOfferStatusOptions
Returns Promise<IOffer>
- Defined in src/auth.ts:697

options

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

patch

patch<T = unknown>(path?: string, init?: IFetchOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optionalpath: string
- Optionalinit: IFetchOptions
Returns Promise<T>
Inherited from PublicClient.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 PublicClient.post
- Defined in src/auth.ts:496

put

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

replaceOrder

replaceOrder(__namedParameters: IReplaceOrderOptions): Promise<IOrderResponse>
Replace an order with a new one.
Parameters
- __namedParameters: IReplaceOrderOptions
Returns Promise<IOrderResponse>
- Defined in src/auth.ts:622

transfer

transfer(__namedParameters: ITransferOptions): Promise<ITransferResponse>
Move available balances between your wallets.
Parameters
- __namedParameters: ITransferOptions
Returns Promise<ITransferResponse>
- Defined in src/auth.ts:557

withdraw

withdraw(body: IWithdrawOptions): Promise<IWithdrawResponse>
Request a withdrawal from one of your wallet.
Parameters
- body: IWithdrawOptions
Returns Promise<IWithdrawResponse>
- Defined in src/auth.ts:569

`Static`setQuery

setQuery(query: URLSearchParams, object?: IRecordType): void
Parameters
- query: URLSearchParams
- Optionalobject: IRecordType
Returns void
Inherited from PublicClient.setQuery
- Defined in src/public.ts:211

Class AuthenticatedClient

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AuthenticatedClient

Accessors

base_url

Returns URL

currency

Returns string

init

Returns RequestInit

nonce

Returns () => string

Parameters

Returns void

reject

Returns boolean

symbol

Returns string

transform

Returns ITransformType | null

Methods

activeCredits

Returns Promise<ICredit[]>

cancelAllOrders

Returns Promise<{ result: string }>

cancelOffer

Parameters

Returns Promise<IOffer>

cancelOrder

Parameters

Returns Promise<IOrderResponse>

cancelOrders

Parameters

Returns Promise<{ result: string }>

claimPosition

Parameters

Returns Promise<IPosition>

closeFunding

Parameters

Returns Promise<ITakenFund>

closePosition

Parameters

Returns Promise<IClosePositionResponse>

delete

Type Parameters

Parameters

Returns Promise<T>

fetch

Type Parameters

Parameters

Returns Promise<T>

get

Type Parameters

Parameters

Returns Promise<T>

getAccountFees

Returns Promise<IAccountFees>

getAccountInfo

Returns Promise<IAccountInfo>

getBalanceHistory

Parameters

Returns Promise<IHistoryBalance[]>

getDepositAddress

Parameters

Returns Promise<IDepositAddress>

getDepositsWithdrawals

Parameters

Returns Promise<IDepositWithdrawal[]>

getFundingBook

Parameters

Returns Promise<IFundingBook>

getFundingTrades

Parameters