Class PublicClient

Hierarchy

FetchClient<unknown>
- PublicClient
  - AuthenticatedClient

Index

Constructors

constructor

Properties

Accessors

fetchOptions

Methods

Constructors

constructor

new PublicClient(__namedParameters?: PublicClientOptions): PublicClient

Overrides FetchClient<unknown>.constructor
- Defined in src/public.ts:147
Parameters
- __namedParameters: PublicClientOptions = {}
Returns PublicClient

Properties

Private #private

#private: any

Readonly apiUri

apiUri: string

Readonly symbol

symbol: string

Accessors

fetchOptions

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

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

Methods

delete

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

Inherited from FetchClient.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 FetchClient.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>

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

getAuctionHistory

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

- Defined in src/public.ts:243
Get the auction events.

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

getCandles

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

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

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

getCurrentAuction

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

- Defined in src/public.ts:236
Get current auction information.

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

getOrderBook

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

- Defined in src/public.ts:215
Get the current order book.

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

getPriceFeed

getPriceFeed(): Promise<PriceFeedItem[]>

- Defined in src/public.ts:254
Get the price feed.

Returns Promise<PriceFeedItem[]>

getSymbol

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

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

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

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

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

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

head

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

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

options

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

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

post

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

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

put

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

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

trace

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

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

Static Private #addOptions

#addOptions(target: URL, data: Record<string, undefined | string | number | boolean>): void

- Defined in src/public.ts:258
Parameters
- target: URL
- data: Record<string, undefined | string | number | boolean>
Returns void