Class AuthenticatedClient

Hierarchy

PublicClient
- AuthenticatedClient

Index

Constructors

constructor

Properties

#key #private #secret #signTimestamp #symbol

Accessors

base_url init reject symbol transform

Methods

cancelAllOrders cancelAllSmartOrders cancelOrder cancelOrders cancelSmartOrder cancelSmartOrders createOrder createOrders createSmartOrder delete fetch get getAccountActivity getAccountBalances getAccountTransfers getAccounts getBorrowRates getBorrowStatus getCandles getCollateral getCurrency getFeeInfo getKillSwitch getMargin getMarkPrice getMarkPriceComponents getMarkPrices getMarket getMarkets getMaxSize getOpenOrders getOpenSmartOrders getOrder getOrderBook getOrderTrades getOrders getPrice getPrices getPublicTrades getSmartOrder getSystemTime getTicker getTickers getTrades getWallets getWalletsActivity head killSwitch newAddress options patch post put replaceOrder replaceSmartOrder transfer withdraw setQuery

Constructors

constructor

new AuthenticatedClient(__namedParameters): AuthenticatedClient
Parameters
- __namedParameters: AuthenticatedClientOptions
Returns AuthenticatedClient
Overrides PublicClient.constructor
- Defined in src/auth.ts:379

Properties

`Private` `Readonly` #key

#key: string

`Private` #private

#private: any

`Private` `Readonly` #secret

#secret: string

`Private` `Readonly` #signTimestamp

#signTimestamp: (() => string)

Type declaration

- (): string
- Returns string

`Private` `Readonly` #symbol

#symbol: string

Accessors

base_url

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

init

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

reject

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

symbol

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

transform

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

Methods

cancelAllOrders

cancelAllOrders(options?): Promise<ICanceledOrder[]>
Batch cancel all orders.
Parameters
- options: {
  accountTypes?: IAccountType[];
  symbols?: string[];
  } = {}
  - Optional accountTypes?: IAccountType[]
  - Optional symbols?: string[]
Returns Promise<ICanceledOrder[]>
- Defined in src/auth.ts:665

cancelAllSmartOrders

cancelAllSmartOrders(options?): Promise<ICanceledSmartOrder[]>
Batch cancel all orders.
Parameters
- options: {
  accountTypes?: IAccountType[];
  symbols?: string[];
  } = {}
  - Optional accountTypes?: IAccountType[]
  - Optional symbols?: string[]
Returns Promise<ICanceledSmartOrder[]>
- Defined in src/auth.ts:790

cancelOrder

cancelOrder(options): Promise<ICanceledOrder>
Cancel an active order.
Parameters
- options: {
  clientOrderId: string;
  } | {
  id: string;
  }
Returns Promise<ICanceledOrder>
- Defined in src/auth.ts:624

cancelOrders

cancelOrders(orders): Promise<ICanceledOrder[]>
Batch cancel one or many active orders.
Parameters
- orders: ({
  clientOrderId: string;
  } | {
  id: string;
  })[]
Returns Promise<ICanceledOrder[]>
- Defined in src/auth.ts:642

cancelSmartOrder

cancelSmartOrder(options): Promise<ICanceledSmartOrder>
Cancel an active smart order.
Parameters
- options: {
  clientOrderId: string;
  } | {
  id: string;
  }
Returns Promise<ICanceledSmartOrder>
- Defined in src/auth.ts:746

cancelSmartOrders

cancelSmartOrders(orders): Promise<ICanceledSmartOrder[]>
Batch cancel one or many active smart orders.
Parameters
- orders: ({
  clientOrderId: string;
  } | {
  id: string;
  })[]
Returns Promise<ICanceledSmartOrder[]>
- Defined in src/auth.ts:766

createOrder

createOrder(options): Promise<IOrderId>
Create an order.
Parameters
- options: IOrderOptions
Returns Promise<IOrderId>
- Defined in src/auth.ts:569

createOrders

createOrders(options): Promise<IOrderIds>
Create multiple orders via a single request.
Parameters
- options: IOrderOptions[]
Returns Promise<IOrderIds>
- Defined in src/auth.ts:574

createSmartOrder

createSmartOrder(options): Promise<IOrderId>
Create a smart order.
Parameters
- options: ISmartOrderOptions
Returns Promise<IOrderId>
- Defined in src/auth.ts:692

delete

delete<T>(path?, init?): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IPoloniexFetchOptions = {}
Returns Promise<T>
Overrides PublicClient.delete
- Defined in src/auth.ts:405

fetch

fetch<T>(path?, __namedParameters?): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- __namedParameters: IPoloniexFetchOptions = {}
Returns Promise<T>
Overrides PublicClient.fetch
- Defined in src/auth.ts:419

get

get<T>(path?, init?): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IPoloniexGetOptions = {}
Returns Promise<T>
Overrides PublicClient.get
- Defined in src/auth.ts:391

getAccountActivity

getAccountActivity(options?): Promise<IAccountActivity[]>
Get a list of activities such as airdrop, rebates, staking, credit/debit adjustments, and other (historical adjustments).
Parameters
- options: IAccountActivityOptions = {}
Returns Promise<IAccountActivity[]>
- Defined in src/auth.ts:486

getAccountBalances

getAccountBalances(options): Promise<[IAccountBalance]>
Get a list of all accounts.
Parameters
- options: {
  id: string;
  }
  - id: string
Returns Promise<[IAccountBalance]>
- Defined in src/auth.ts:469
getAccountBalances(options?): Promise<IAccountBalance[]>
Parameters
- Optional options: {
  accountType?: IAccountType;
  }
  - Optional accountType?: IAccountType
Returns Promise<IAccountBalance[]>
- Defined in src/auth.ts:472

getAccountTransfers

getAccountTransfers(options?): Promise<IAccountTransfer[]>
Get a list of transfer records.
Parameters
- options: IAccountTransferOptions = {}
Returns Promise<IAccountTransfer[]>
- Defined in src/auth.ts:498

getAccounts

getAccounts(): Promise<IAccount[]>
Get a list of all accounts.

Returns Promise<IAccount[]>
- Defined in src/auth.ts:464

getBorrowRates

getBorrowRates(): Promise<IBorrowRate[]>
Get borrow rates information for all tiers and currencies.

Returns Promise<IBorrowRate[]>
Inherited from PublicClient.getBorrowRates
- Defined in src/public.ts:403

getBorrowStatus

getBorrowStatus(options?): Promise<IBorrow>
Get borrow status of currencies.
Parameters
- options: {
  currency?: string;
  } = {}
  - Optional currency?: string
Returns Promise<IBorrow>
- Defined in src/auth.ts:557

getCandles

getCandles(__namedParameters): Promise<ICandle[]>
Get OHLC for a symbol at given timeframe (interval).
Parameters
- __namedParameters: ICandlesOptions
Returns Promise<ICandle[]>
Inherited from PublicClient.getCandles
- Defined in src/public.ts:356

getCollateral

getCollateral(options): Promise<ICollateral>
Get collateral information for all currencies or a single currency..
Parameters
- options: {
  currency: string;
  }
  - currency: string
Returns Promise<ICollateral>
Inherited from PublicClient.getCollateral
- Defined in src/public.ts:386
getCollateral(options?): Promise<ICollateral[]>
Parameters
- Optional options: {
  currency?: undefined;
  }
  - Optional currency?: undefined
Returns Promise<ICollateral[]>
Inherited from PublicClient.getCollateral
- Defined in src/public.ts:387

getCurrency

getCurrency(query): Promise<IExtendedCurrency>
Get data for a supported currency all supported currencies.
Parameters
- query: {
  currency: string;
  includeMultiChainCurrencies: true;
  }
  - currency: string
  - includeMultiChainCurrencies: true
Returns Promise<IExtendedCurrency>
Inherited from PublicClient.getCurrency
- Defined in src/public.ts:271
getCurrency(query): Promise<IExtendedCurrency[]>
Parameters
- query: {
  currency?: undefined;
  includeMultiChainCurrencies: true;
  }
  - Optional currency?: undefined
  - includeMultiChainCurrencies: true
Returns Promise<IExtendedCurrency[]>
Inherited from PublicClient.getCurrency
- Defined in src/public.ts:275
getCurrency(query): Promise<ICurrency>
Parameters
- query: {
  currency: string;
  includeMultiChainCurrencies?: false;
  }
  - currency: string
  - Optional includeMultiChainCurrencies?: false
Returns Promise<ICurrency>
Inherited from PublicClient.getCurrency
- Defined in src/public.ts:279
getCurrency(query?): Promise<ICurrency[]>
Parameters
- Optional query: {
  currency?: string;
  includeMultiChainCurrencies?: false;
  }
  - Optional currency?: string
  - Optional includeMultiChainCurrencies?: false
Returns Promise<ICurrency[]>
Inherited from PublicClient.getCurrency
- Defined in src/public.ts:283

getFeeInfo

getFeeInfo(): Promise<IFee>
Get fee rate.

Returns Promise<IFee>
- Defined in src/auth.ts:505

getKillSwitch

getKillSwitch(): Promise<IKillSwitch>
Get status of kill switch.

Returns Promise<IKillSwitch>
- Defined in src/auth.ts:687

getMargin

getMargin(__namedParameters?): Promise<IMarginInfo>
Get account margin information.
Parameters
- __namedParameters: {
  accountType?: IAccountType;
  } = {}
  - Optional accountType?: IAccountType
Returns Promise<IMarginInfo>
- Defined in src/auth.ts:548

getMarkPrice

getMarkPrice(__namedParameters?): Promise<IMarkPrice>
Get latest mark price for a single cross margin symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | string
Returns Promise<IMarkPrice>
Inherited from PublicClient.getMarkPrice
- Defined in src/public.ts:334

getMarkPriceComponents

getMarkPriceComponents(__namedParameters?): Promise<IMarkPriceComponents>
Get components of the mark price for a given symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | string
Returns Promise<IMarkPriceComponents>
Inherited from PublicClient.getMarkPriceComponents
- Defined in src/public.ts:339

getMarkPrices

getMarkPrices(): Promise<IMarkPrice[]>
Get latest mark price for all cross margin symbols.

Returns Promise<IMarkPrice[]>
Inherited from PublicClient.getMarkPrices
- Defined in src/public.ts:329

getMarket

getMarket(__namedParameters?): Promise<[ISymbolInformation]>
Get a single symbol and its trade limit info.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | string
Returns Promise<[ISymbolInformation]>
Inherited from PublicClient.getMarket
- Defined in src/public.ts:264

getMarkets

getMarkets(): Promise<ISymbolInformation[]>
Get all symbols and their trade limit info.

Returns Promise<ISymbolInformation[]>
Inherited from PublicClient.getMarkets
- Defined in src/public.ts:259

getMaxSize

getMaxSize(__namedParameters?): Promise<IMaxSize>
Get maximum and available buy/sell amount for a given symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | string
Returns Promise<IMaxSize>
- Defined in src/auth.ts:564

getOpenOrders

getOpenOrders(options?): Promise<IOpenOrder[]>
Get a list of active orders.
Parameters
- options: IOpenOrdersOptions = {}
Returns Promise<IOpenOrder[]>
- Defined in src/auth.ts:602

getOpenSmartOrders

getOpenSmartOrders(options?): Promise<IOpenSmartOrder[]>
Get a list of (pending) smart orders.
Parameters
- options: {
  limit?: number;
  } = {}
  - Optional limit?: number
Returns Promise<IOpenSmartOrder[]>
- Defined in src/auth.ts:719

getOrder

getOrder(options): Promise<IOrder>
Get an order’s status.
Parameters
- options: {
  clientOrderId: string;
  } | {
  id: string;
  }
Returns Promise<IOrder>
- Defined in src/auth.ts:609

getOrderBook

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

getOrderTrades

getOrderTrades(__namedParameters): Promise<ITrade[]>
Get a list of all trades for an order specified by its orderId.
Parameters
- __namedParameters: {
  id: string;
  }
  - id: string
Returns Promise<ITrade[]>
- Defined in src/auth.ts:818

getOrders

getOrders(__namedParameters?): Promise<IHistoricalOrder[]>
Get a list of historical orders.
Parameters
- __namedParameters: IOrdersOptions = {}
Returns Promise<IHistoricalOrder[]>
- Defined in src/auth.ts:797

getPrice

getPrice(__namedParameters?): Promise<IPrice>
Get the latest trade price for a symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | string
Returns Promise<IPrice>
Inherited from PublicClient.getPrice
- Defined in src/public.ts:324

getPrices

getPrices(): Promise<IPrice[]>
Get the latest trade price for all symbols.

Returns Promise<IPrice[]>
Inherited from PublicClient.getPrices
- Defined in src/public.ts:319

getPublicTrades

getPublicTrades(__namedParameters?): Promise<IPublicTrade[]>
Get a list of recent trades.
Parameters
- __namedParameters: IPublicTradeOptions = {}
Returns Promise<IPublicTrade[]>
Inherited from PublicClient.getPublicTrades
- Defined in src/public.ts:368

getSmartOrder

getSmartOrder(options): Promise<null | ISmartOrder>
Get a smart order’s status.
Parameters
- options: {
  clientOrderId: string;
  } | {
  id: string;
  }
Returns Promise<null | ISmartOrder>
- Defined in src/auth.ts:726

getSystemTime

getSystemTime(): Promise<ISystemTimestamp>
Get current server time.

Returns Promise<ISystemTimestamp>
Inherited from PublicClient.getSystemTime
- Defined in src/public.ts:314

getTicker

getTicker(__namedParameters?): Promise<ITicker>
Get ticker in last 24 hours for a given symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | string
Returns Promise<ITicker>
Inherited from PublicClient.getTicker
- Defined in src/public.ts:381

getTickers

getTickers(): Promise<ITicker[]>
Get ticker in last 24 hours for all symbols.

Returns Promise<ITicker[]>
Inherited from PublicClient.getTickers
- Defined in src/public.ts:376

getTrades

getTrades(__namedParameters?): Promise<ITrade[]>
Get a list of all trades.
Parameters
- __namedParameters: ITradeOptions = {}
Returns Promise<ITrade[]>
- Defined in src/auth.ts:810

getWallets

getWallets(options?): Promise<Record<string, string>>
Get deposit addresses.
Parameters
- options: {
  currency?: string;
  } = {}
  - Optional currency?: string
Returns Promise<Record<string, string>>
- Defined in src/auth.ts:510

getWalletsActivity

getWalletsActivity(__namedParameters): Promise<IActivity>
Get deposit and withdrawal activity history within a range window.
Parameters
- __namedParameters: IActivityOptions
Returns Promise<IActivity>
- Defined in src/auth.ts:517

head

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

killSwitch

killSwitch(options): Promise<IKillSwitch>
Parameters
- options: {
  timeout: string | number;
  }
  - timeout: string | number
Returns Promise<IKillSwitch>
- Defined in src/auth.ts:671

newAddress

newAddress(options): Promise<{
address: string;
}>
Create a new address for a currency.
Parameters
- options: {
  currency: string;
  }
  - currency: string
Returns Promise<{
address: string;
}>
- Defined in src/auth.ts:532

options

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

patch

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

post

post<T>(path?, init?): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IPoloniexFetchOptions = {}
Returns Promise<T>
Overrides PublicClient.post
- Defined in src/auth.ts:398

put

put<T>(path?, init?): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IPoloniexFetchOptions = {}
Returns Promise<T>
Overrides PublicClient.put
- Defined in src/auth.ts:412

replaceOrder

replaceOrder(id, options?): Promise<IOrderId>
Cancel an existing active order, new or partially filled, and place a new order on the same symbol with details from existing order unless amended by new parameters.
Parameters
- id: {
  clientOrderId: string;
  } | {
  id: string;
  }
- Optional options: IReplaceOrderOptions
Returns Promise<IOrderId>
- Defined in src/auth.ts:582

replaceSmartOrder

replaceSmartOrder(id, options): Promise<IOrderId>
Cancel an existing untriggered smart order and place a new smart order on the same symbol with details from existing smart order unless amended by new parameters.
Parameters
- id: {
  clientOrderId: string;
  } | {
  id: string;
  }
- options: IReplaceSmartOrderOptions
Returns Promise<IOrderId>
- Defined in src/auth.ts:697

transfer

transfer(options): Promise<{
transferId: string;
}>
Transfer amount of currency from an account to another account
Parameters
- options: ITransferOptions
Returns Promise<{
transferId: string;
}>
- Defined in src/auth.ts:493

withdraw

withdraw(options): Promise<{
withdrawalRequestsId: number;
}>
Immediately place a withdrawal for a given currency, with no email confirmation.
Parameters
- options: IWithdrawOptions
Returns Promise<{
withdrawalRequestsId: number;
}>
- Defined in src/auth.ts:539

`Static` setQuery

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

Class AuthenticatedClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: AuthenticatedClientOptions

Returns AuthenticatedClient

Properties

Private Readonly #key

Private #private

Private Readonly #secret

Private Readonly #signTimestamp

Type declaration

Returns string

Private Readonly #symbol

Accessors

base_url

Returns URL

init

Returns RequestInit

reject

Returns boolean

symbol

Returns string

transform

Returns null | ITransformType

Methods

cancelAllOrders

Parameters

options: { accountTypes?: IAccountType[]; symbols?: string[]; } = {}

Optional accountTypes?: IAccountType[]

Optional symbols?: string[]

Returns Promise<ICanceledOrder[]>

cancelAllSmartOrders

Parameters

options: { accountTypes?: IAccountType[]; symbols?: string[]; } = {}

Optional accountTypes?: IAccountType[]

Optional symbols?: string[]

Returns Promise<ICanceledSmartOrder[]>

cancelOrder

Parameters

options: { clientOrderId: string; } | { id: string; }

Returns Promise<ICanceledOrder>

cancelOrders

Parameters

orders: ({ clientOrderId: string; } | { id: string; })[]

Returns Promise<ICanceledOrder[]>

cancelSmartOrder

Parameters

options: { clientOrderId: string; } | { id: string; }

Returns Promise<ICanceledSmartOrder>

cancelSmartOrders

Parameters

orders: ({ clientOrderId: string; } | { id: string; })[]

Returns Promise<ICanceledSmartOrder[]>

createOrder

Parameters

options: IOrderOptions

Returns Promise<IOrderId>

createOrders

Parameters

options: IOrderOptions[]

Returns Promise<IOrderIds>

createSmartOrder

Parameters

options: ISmartOrderOptions

Returns Promise<IOrderId>

delete

Type Parameters

T = unknown

Parameters

path: string = ""

init: IPoloniexFetchOptions = {}

Returns Promise<T>

fetch

`Private` `Readonly` #key

`Private` #private

`Private` `Readonly` #secret

`Private` `Readonly` #signTimestamp

`Private` `Readonly` #symbol

options: {
accountTypes?: IAccountType[];
symbols?: string[];
} = {}

`Optional` accountTypes?: IAccountType[]

`Optional` symbols?: string[]

options: {
accountTypes?: IAccountType[];
symbols?: string[];
} = {}

`Optional` accountTypes?: IAccountType[]

`Optional` symbols?: string[]

options: {
clientOrderId: string;
} | {
id: string;
}

orders: ({
clientOrderId: string;
} | {
id: string;
})[]

options: {
clientOrderId: string;
} | {
id: string;
}

orders: ({
clientOrderId: string;
} | {
id: string;
})[]

options: {
id: string;
}

`Optional` options: {
accountType?: IAccountType;
}

`Optional` accountType?: IAccountType

options: {
currency?: string;
} = {}

`Optional` currency?: string

options: {
currency: string;
}

`Optional` options: {
currency?: undefined;
}

`Optional` currency?: undefined

query: {
currency: string;
includeMultiChainCurrencies: true;
}

query: {
currency?: undefined;
includeMultiChainCurrencies: true;
}

`Optional` currency?: undefined

query: {
currency: string;
includeMultiChainCurrencies?: false;
}

`Optional` includeMultiChainCurrencies?: false

`Optional` query: {
currency?: string;
includeMultiChainCurrencies?: false;
}