Class PublicClient

Hierarchy (View Summary)

Fetch
- PublicClient
  - AuthenticatedClient

Index

Constructors

constructor

Accessors

base_url init reject symbol transform

Methods

Constructors

constructor

new PublicClient(__namedParameters?: IPublicClientOptions): PublicClient
Parameters
- __namedParameters: IPublicClientOptions = {}
Returns PublicClient
Overrides Fetch.constructor
- Defined in src/public.ts:226

Accessors

base_url

get base_url(): URL
Returns URL
Overrides Fetch.base_url
- Defined in src/public.ts:234

init

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

reject

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

symbol

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

transform

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

Methods

delete

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

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

get

get<T = unknown>(
path?: string,
__namedParameters?: IPoloniexGetOptions,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- __namedParameters: IPoloniexGetOptions = {}
Returns Promise<T>
Overrides Fetch.get
- Defined in src/public.ts:243

getBorrowRates

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

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

getCandles

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

getCollateral

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

getCurrency

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

getMarket

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

getMarkets

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

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

getMarkPrice

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

getMarkPriceComponents

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

getMarkPrices

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

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

getOrderBook

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

getPrice

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

getPrices

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

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

getPublicTrades

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

getSystemTime

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

Returns Promise<ISystemTimestamp>
- Defined in src/public.ts:314

getTicker

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

getTickers

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

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

head

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

options

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

patch

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

post

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

put

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

`Static`setQuery

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

Class PublicClient

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PublicClient

Accessors

base_url

Returns URL

init

Returns RequestInit

reject

Returns boolean

symbol

Returns string

transform

Returns null | ITransformType

Methods

delete

Type Parameters

Parameters

Returns Promise<T>

fetch

Type Parameters

Parameters

Returns Promise<T>

get

Type Parameters

Parameters

Returns Promise<T>

getBorrowRates

Returns Promise<IBorrowRate[]>

getCandles

Parameters

Returns Promise<ICandle[]>

getCollateral

Parameters

Returns Promise<ICollateral>

Parameters

Returns Promise<ICollateral[]>

getCurrency

Parameters

Returns Promise<IExtendedCurrency>

Parameters

Returns Promise<IExtendedCurrency[]>

Parameters

Returns Promise<ICurrency>

Parameters

Returns Promise<ICurrency[]>

getMarket

Parameters

Returns Promise<[ISymbolInformation]>

getMarkets

Returns Promise<ISymbolInformation[]>

getMarkPrice

Parameters

Returns Promise<IMarkPrice>

getMarkPriceComponents

Parameters

Returns Promise<IMarkPriceComponents>

getMarkPrices

Returns Promise<IMarkPrice[]>

getOrderBook

Parameters

Returns Promise<IOrderBook>

getPrice

Parameters

Returns Promise<IPrice>

getPrices

Returns Promise<IPrice[]>

getPublicTrades

Parameters

Returns Promise<IPublicTrade[]>

getSystemTime

Returns Promise<ISystemTimestamp>

getTicker

`Static`setQuery