Class PublicClient

Hierarchy

Fetch
- PublicClient
  - AuthenticatedClient

Index

Constructors

constructor

Properties

#private #symbol

Accessors

base_url init reject symbol transform

Methods

delete fetch get getBorrowRates getCandles getCollateral getCurrency getMarkPrice getMarkPriceComponents getMarkPrices getMarket getMarkets getOrderBook getPrice getPrices getPublicTrades getSystemTime getTicker getTickers head options patch post put #formatCandle #formatCurrency setQuery

Constructors

constructor

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

Properties

`Private` #private

#private: any

`Private` `Readonly` #symbol

#symbol: string

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

fetch

fetch<T>(path?, __namedParameters?): Promise<T>
Type Parameters
- T = unknown
Parameters
- Optional path: 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>(path?, __namedParameters?): 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): 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): Promise<ICollateral>
Get collateral information for all currencies or a single currency..
Parameters
- options: {
  currency: string;
  }
  - currency: string
Returns Promise<ICollateral>
- Defined in src/public.ts:386
getCollateral(options?): Promise<ICollateral[]>
Parameters
- Optional options: {
  currency?: undefined;
  }
  - Optional currency?: undefined
Returns Promise<ICollateral[]>
- 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>
- Defined in src/public.ts:271
getCurrency(query): Promise<IExtendedCurrency[]>
Parameters
- query: {
  currency?: undefined;
  includeMultiChainCurrencies: true;
  }
  - Optional currency?: undefined
  - includeMultiChainCurrencies: true
Returns Promise<IExtendedCurrency[]>
- Defined in src/public.ts:275
getCurrency(query): Promise<ICurrency>
Parameters
- query: {
  currency: string;
  includeMultiChainCurrencies?: false;
  }
  - currency: string
  - Optional includeMultiChainCurrencies?: false
Returns Promise<ICurrency>
- 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[]>
- Defined in src/public.ts:283

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>
- 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>
- 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

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]>
- 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

getOrderBook

getOrderBook(__namedParameters?): 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?): Promise<IPrice>
Get the latest trade price for a symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | 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?): 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?): Promise<ITicker>
Get ticker in last 24 hours for a given symbol.
Parameters
- __namedParameters: {
  symbol: undefined | string;
  } = {}
  - symbol: undefined | 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?, init?): Promise<Response>
Parameters
- Optional path: string
- Optional init: IFetchOptions
Returns Promise<Response>
Inherited from Fetch.head
- Defined in node_modules/rpc-request/dist/index.d.ts:22

options

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

post

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

put

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

`Static` `Private` #formatCandle

#formatCandle(__namedParameters): ICandle
Parameters
- __namedParameters: IRawCandle
Returns ICandle
- Defined in src/public.ts:423

`Static` `Private` #formatCurrency

#formatCurrency(currency): ICurrency
Parameters
- currency: Record<string, Omit<ICurrency, "currency">>
Returns ICurrency
- Defined in src/public.ts:416

`Static` setQuery

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

Class PublicClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: IPublicClientOptions = {}

Returns PublicClient

Properties

Private #private

Private Readonly #symbol

Accessors

base_url

Returns URL

init

Returns RequestInit

reject

Returns boolean

symbol

Returns string

transform

Returns null | ITransformType

Methods

delete

Type Parameters

T = unknown

Parameters

Optional path: string

Optional init: IFetchOptions

Returns Promise<T>

fetch

Type Parameters

T = unknown

Parameters

Optional path: string

Optional __namedParameters: IFetchOptions

Returns Promise<T>

get

Type Parameters

T = unknown

Parameters

path: string = ""

__namedParameters: IPoloniexGetOptions = {}

Returns Promise<T>

getBorrowRates

Returns Promise<IBorrowRate[]>

getCandles

Parameters

__namedParameters: ICandlesOptions

Returns Promise<ICandle[]>

getCollateral

Parameters

options: { currency: string; }

currency: string

Returns Promise<ICollateral>

Parameters

Optional options: { currency?: undefined; }

Optional currency?: undefined

Returns Promise<ICollateral[]>

getCurrency

Parameters

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

currency: string

includeMultiChainCurrencies: true

Returns Promise<IExtendedCurrency>

Parameters

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

Optional currency?: undefined

includeMultiChainCurrencies: true

Returns Promise<IExtendedCurrency[]>

Parameters

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

currency: string

Optional includeMultiChainCurrencies?: false

Returns Promise<ICurrency>

Parameters

`Private` #private

`Private` `Readonly` #symbol

`Optional` path: string

`Optional` init: IFetchOptions

`Optional` path: string

`Optional` __namedParameters: IFetchOptions

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;
}

`Optional` currency?: string

`Optional` includeMultiChainCurrencies?: false

__namedParameters: {
symbol: undefined | string;
} = {}

__namedParameters: {
symbol: undefined | string;
} = {}

__namedParameters: {
symbol: undefined | string;
} = {}

__namedParameters: {
symbol: undefined | string;
} = {}

__namedParameters: {
symbol: undefined | string;
} = {}

`Optional` path: string

`Optional` init: IFetchOptions

`Optional` path: string

`Optional` init: IFetchOptions

`Optional` path: string

`Optional` init: IFetchOptions