Class AuthenticatedClient

Hierarchy

PublicClient
- AuthenticatedClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AuthenticatedClient(__namedParameters: AuthenticatedClientOptions): AuthenticatedClient

Overrides PublicClient.constructor
- Defined in src/auth.ts:403
Parameters
- __namedParameters: AuthenticatedClientOptions
Returns AuthenticatedClient

Properties

Private Readonly #key

#key: string

Private #nonce

#nonce: (() => number)

Type declaration

- (): number
- Returns number

Private #private

#private: any

Private Readonly #secret

#secret: string

Readonly apiUri

apiUri: string

Readonly symbol

symbol: string

Accessors

fetchOptions

get fetchOptions(): RequestInit
set fetchOptions(options: RequestInit): void

Inherited from PublicClient.fetchOptions
- Defined in node_modules/rpc-request/build/index.d.ts:30
Returns RequestInit
Inherited from PublicClient.fetchOptions
- Defined in node_modules/rpc-request/build/index.d.ts:31
Parameters
- options: RequestInit
Returns void

nonce

get nonce(): (() => number)
set nonce(nonce: (() => number)): void

- Defined in src/auth.ts:706
Returns (() => number)
- - (): number
  - Returns number
- Defined in src/auth.ts:702
Parameters
- nonce: (() => number)
  - - (): number
    - Returns number
Returns void

Methods

addBank

addBank(bank: AddBankOptions): Promise<AddBankResponse>

- Defined in src/auth.ts:649
The add bank API allows for banking information to be sent in via API. However, for the bank to be verified, you must still send in a wire for any amount from the bank account.

Parameters
- bank: AddBankOptions
Returns Promise<AddBankResponse>

buy

buy(__namedParameters: BasicOrderOptions): Promise<OrderStatus>

- Defined in src/auth.ts:457
Submit a new buy order.

Parameters
- __namedParameters: BasicOrderOptions
Returns Promise<OrderStatus>

cancelAll

cancelAll(account?: AccountName): Promise<CancelOrdersResponse>

- Defined in src/auth.ts:491
Cancel all outstanding orders created by all sessions owned by this account.

Parameters
- Optional account: AccountName
Returns Promise<CancelOrdersResponse>

cancelClearingOrder

cancelClearingOrder(order: ClearingOrderID): Promise<CancelClearingOrderResponse>

- Defined in src/auth.ts:566
Cancel a clearing order.

Parameters
- order: ClearingOrderID
Returns Promise<CancelClearingOrderResponse>

cancelOrder

cancelOrder(params: OrderID): Promise<OrderStatus>

- Defined in src/auth.ts:477
Cancel an order.

Parameters
- params: OrderID
Returns Promise<OrderStatus>

cancelSession

cancelSession(account?: AccountName): Promise<CancelOrdersResponse>

- Defined in src/auth.ts:484
Cancel all orders opened by this session.

Parameters
- Optional account: AccountName
Returns Promise<CancelOrdersResponse>

confirmClearingOrder

confirmClearingOrder(__namedParameters: ConfirmClearingOptions): Promise<ConfirmClearingOptionsResponse>

- Defined in src/auth.ts:575
Confirm a clearing order.

Parameters
- __namedParameters: ConfirmClearingOptions
Returns Promise<ConfirmClearingOptionsResponse>

createAccount

createAccount(account: Account): Promise<Account>

- Defined in src/auth.ts:677
Create a new exchange account within the group.

Parameters
- account: Account
Returns Promise<Account>

delete

delete(path?: string, _fetchOptions?: RequestInit): Promise<unknown>

Inherited from PublicClient.delete
- Defined in node_modules/rpc-request/build/index.d.ts:36
Parameters
- Optional path: string
- Optional _fetchOptions: RequestInit
Returns Promise<unknown>

fetch

fetch(path?: string, options?: RequestInit): Promise<unknown>

Inherited from PublicClient.fetch
- Defined in node_modules/rpc-request/build/index.d.ts:40
Parameters
- Optional path: string
- Optional options: RequestInit
Returns Promise<unknown>

get

get<T>(path: string): Promise<T>

Inherited from PublicClient.get
- Defined in src/public.ts:157
Type Parameters
- T = unknown
Parameters
- path: string
Returns Promise<T>

getAccountDetails

getAccountDetails(account?: AccountName): Promise<AccountDetails>

- Defined in src/auth.ts:670
Get details about the specific account requested such as users, country codes, etc.

Parameters
- Optional account: AccountName
Returns Promise<AccountDetails>

getAccounts

getAccounts(): Promise<AccountInfo[]>

- Defined in src/auth.ts:684
Get the accounts within the group.

Returns Promise<AccountInfo[]>

getActiveOrders

getActiveOrders(account?: AccountName): Promise<OrderStatus[]>

- Defined in src/auth.ts:505
Get all your live orders.

Parameters
- Optional account: AccountName
Returns Promise<OrderStatus[]>

getAuctionHistory

getAuctionHistory(__namedParameters?: AuctionHistoryFilter): Promise<AuctionHistory[]>

Inherited from PublicClient.getAuctionHistory
- Defined in src/public.ts:243
Get the auction events.

Parameters
- __namedParameters: AuctionHistoryFilter = {}
Returns Promise<AuctionHistory[]>

getAvailableBalances

getAvailableBalances(account?: AccountName): Promise<Balance[]>

- Defined in src/auth.ts:585
Get the available balances in the supported currencies.

Parameters
- Optional account: AccountName
Returns Promise<Balance[]>

getCandles

getCandles(__namedParameters?: CandlesFilter): Promise<Candle[]>

Inherited from PublicClient.getCandles
- Defined in src/public.ts:207
Get time-intervaled data for the provided symbol.

Parameters
- __namedParameters: CandlesFilter = {}
Returns Promise<Candle[]>

getClearingOrderStatus

getClearingOrderStatus(order: ClearingOrderID): Promise<ClearingOrderStatus>

- Defined in src/auth.ts:557
Get a clearing order status.

Parameters
- order: ClearingOrderID
Returns Promise<ClearingOrderStatus>

getCurrentAuction

getCurrentAuction(__namedParameters?: SymbolFilter): Promise<AuctionInfo>

Inherited from PublicClient.getCurrentAuction
- Defined in src/public.ts:236
Get current auction information.

Parameters
- __namedParameters: SymbolFilter = {}
Returns Promise<AuctionInfo>

getDepositAddresses

getDepositAddresses(__namedParameters: DepositAddressesFilter): Promise<DepositAddress[]>

- Defined in src/auth.ts:609
Get deposit addresses.

Parameters
- __namedParameters: DepositAddressesFilter
Returns Promise<DepositAddress[]>

getNewAddress

getNewAddress(__namedParameters: NewAddressFilter): Promise<NewAddress>

- Defined in src/auth.ts:619
Get a new deposit address.

Parameters
- __namedParameters: NewAddressFilter
Returns Promise<NewAddress>

getNotionalBalances

getNotionalBalances(__namedParameters?: NotionalBalancesOptions): Promise<NotionalBalance[]>

- Defined in src/auth.ts:592
Get the available balances in the supported currencies as well as in notional USD.

Parameters
- __namedParameters: NotionalBalancesOptions = {}
Returns Promise<NotionalBalance[]>

getNotionalVolume

getNotionalVolume(account?: AccountName): Promise<NotionalVolume>

- Defined in src/auth.ts:523
Get the volume in price currency that has been traded across all pairs over a period of 30 days.

Parameters
- Optional account: AccountName
Returns Promise<NotionalVolume>

getOrderBook

getOrderBook(__namedParameters?: BookFilter): Promise<OrderBook>

Inherited from PublicClient.getOrderBook
- Defined in src/public.ts:215
Get the current order book.

Parameters
- __namedParameters: BookFilter = {}
Returns Promise<OrderBook>

getOrderStatus

getOrderStatus(params: OrderID): Promise<OrderStatus>

- Defined in src/auth.ts:498
Get an order status.

Parameters
- params: OrderID
Returns Promise<OrderStatus>

getPastTrades

getPastTrades(__namedParameters?: PastTradesFilter): Promise<PastTrade[]>

- Defined in src/auth.ts:512
Get your past trades.

Parameters
- __namedParameters: PastTradesFilter = {}
Returns Promise<PastTrade[]>

getPaymentMethods

getPaymentMethods(account?: AccountName): Promise<PaymentMethods>

- Defined in src/auth.ts:656
Get data on balances in the account and linked banks

Parameters
- Optional account: AccountName
Returns Promise<PaymentMethods>

getPriceFeed

getPriceFeed(): Promise<PriceFeedItem[]>

Inherited from PublicClient.getPriceFeed
- Defined in src/public.ts:254
Get the price feed.

Returns Promise<PriceFeedItem[]>

getSymbol

getSymbol(__namedParameters: { symbol: string }): Promise<ISymbol>

Inherited from PublicClient.getSymbol
- Defined in src/public.ts:189
Get extra details about the symbol.

Parameters
- __namedParameters: { symbol: string }
  - symbol: string
Returns Promise<ISymbol>

getSymbols

getSymbols(): Promise<string[]>

Inherited from PublicClient.getSymbols
- Defined in src/public.ts:184
Get all available symbols for trading.

Returns Promise<string[]>

getTicker

getTicker(options: { symbol?: string; v: "v2" }): Promise<TickerV2>
getTicker(options?: { symbol?: string; v?: "v1" }): Promise<TickerV1>

Inherited from PublicClient.getTicker
- Defined in src/public.ts:194
Get information about recent trading activity for the symbol.

Parameters
- options: { symbol?: string; v: "v2" }
  - Optional symbol?: string
  - v: "v2"
Returns Promise<TickerV2>
Inherited from PublicClient.getTicker
- Defined in src/public.ts:195
Parameters
- Optional options: { symbol?: string; v?: "v1" }
  - Optional symbol?: string
  - Optional v?: "v1"
Returns Promise<TickerV1>

getTradeHistory

getTradeHistory(__namedParameters?: TradeHistoryFilter): Promise<Trade[]>

Inherited from PublicClient.getTradeHistory
- Defined in src/public.ts:225
Get the trades that have executed since the specified timestamp.

Parameters
- __namedParameters: TradeHistoryFilter = {}
Returns Promise<Trade[]>

getTradeVolume

getTradeVolume(account?: AccountName): Promise<TradeVolume[][]>

- Defined in src/auth.ts:530
Get the trade volume for each symbol.

Parameters
- Optional account: AccountName
Returns Promise<TradeVolume[][]>

getTransfers

getTransfers(rest?: TransferFilter): Promise<Transfer[]>

- Defined in src/auth.ts:602
Get deposits and withdrawals in the supported currencies.

Parameters
- Optional rest: TransferFilter
Returns Promise<Transfer[]>

head

head(path?: string, _fetchOptions?: RequestInit): Promise<unknown>

Inherited from PublicClient.head
- Defined in node_modules/rpc-request/build/index.d.ts:33
Parameters
- Optional path: string
- Optional _fetchOptions: RequestInit
Returns Promise<unknown>

heartbeat

heartbeat(): Promise<Heartbeat>

- Defined in src/auth.ts:697
Prevent a session from timing out and canceling orders if the require heartbeat flag has been set.

Returns Promise<Heartbeat>

internalTransfer

internalTransfer(__namedParameters: InternalTransferFilter): Promise<InternalTransferResponse>

- Defined in src/auth.ts:639
Make an internal transfer between any two exchange accounts within the Group.

Parameters
- __namedParameters: InternalTransferFilter
Returns Promise<InternalTransferResponse>

newBrokerOrder

newBrokerOrder(__namedParameters: BrokerOrderOptions): Promise<NewClearingOrderResponse>

- Defined in src/auth.ts:547
Submit a new broker clearing order.

Parameters
- __namedParameters: BrokerOrderOptions
Returns Promise<NewClearingOrderResponse>

newClearingOrder

newClearingOrder(__namedParameters: ClearingOrderOptions): Promise<NewClearingOrderResponse>

- Defined in src/auth.ts:537
Submit a new clearing order.

Parameters
- __namedParameters: ClearingOrderOptions
Returns Promise<NewClearingOrderResponse>

newOrder

newOrder(__namedParameters: OrderOptions): Promise<OrderStatus>

- Defined in src/auth.ts:447
Submit a new order.

Parameters
- __namedParameters: OrderOptions
Returns Promise<OrderStatus>

options

options(path?: string, _fetchOptions?: RequestInit): Promise<unknown>

Inherited from PublicClient.options
- Defined in node_modules/rpc-request/build/index.d.ts:37
Parameters
- Optional path: string
- Optional _fetchOptions: RequestInit
Returns Promise<unknown>

patch

patch(path?: string, _fetchOptions?: RequestInit): Promise<unknown>

Inherited from PublicClient.patch
- Defined in node_modules/rpc-request/build/index.d.ts:39
Parameters
- Optional path: string
- Optional _fetchOptions: RequestInit
Returns Promise<unknown>

post

post<T>(path: undefined | string, _options: undefined | RequestInit, body?: { request: string } & Record<string, unknown>): Promise<T>

Overrides PublicClient.post
- Defined in src/auth.ts:410
Type Parameters
- T = unknown
Parameters
- path: undefined | string
- _options: undefined | RequestInit
- body: { request: string } & Record<string, unknown> = ...
Returns Promise<T>

put

put(path?: string, _fetchOptions?: RequestInit): Promise<unknown>

Inherited from PublicClient.put
- Defined in node_modules/rpc-request/build/index.d.ts:35
Parameters
- Optional path: string
- Optional _fetchOptions: RequestInit
Returns Promise<unknown>

sell

sell(__namedParameters: BasicOrderOptions): Promise<OrderStatus>

- Defined in src/auth.ts:467
Submit a new sell order.

Parameters
- __namedParameters: BasicOrderOptions
Returns Promise<OrderStatus>

trace

trace(path?: string, _fetchOptions?: RequestInit): Promise<unknown>

Inherited from PublicClient.trace
- Defined in node_modules/rpc-request/build/index.d.ts:38
Parameters
- Optional path: string
- Optional _fetchOptions: RequestInit
Returns Promise<unknown>

withdrawCrypto

withdrawCrypto(__namedParameters: WithdrawCryptoFilter): Promise<Withdrawal>

- Defined in src/auth.ts:629
Withdraw cryptocurrency funds to a whitelisted address.

Parameters
- __namedParameters: WithdrawCryptoFilter
Returns Promise<Withdrawal>

withdrawGUSD

withdrawGUSD(options: WithdrawGUSDFilter): Promise<GUSDWithdrawal>

- Defined in src/auth.ts:690
Withdraw USD as GUSD.

Parameters
- options: WithdrawGUSDFilter
Returns Promise<GUSDWithdrawal>

withdrawSEN

withdrawSEN(options: SENWithdrawOptions): Promise<SENWithdrawal>

- Defined in src/auth.ts:663
The SEN Withdrawals API allows you to withdraw USD from your Gemini account via SEN

Parameters
- options: SENWithdrawOptions
Returns Promise<SENWithdrawal>