Class PublicClient

Hierarchy (View Summary)

Fetch
- PublicClient
  - AuthenticatedClient

Index

Constructors

constructor

Accessors

base_url currency init reject symbol transform

Methods

delete fetch get getFundingBook getLends getOrderBook getStats getSymbolDetails getSymbols getTicker getTrades head options patch post put setQuery

Constructors

constructor

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

Accessors

base_url

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

currency

get currency(): string
Returns string
- Defined in src/public.ts:138

init

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

reject

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

symbol

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

transform

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

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

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

get

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

getFundingBook

getFundingBook(__namedParameters?: IFundingBookOptions): Promise<IFundingBook>
Get the full margin funding book.
Parameters
- __namedParameters: IFundingBookOptions = {}
Returns Promise<IFundingBook>
- Defined in src/public.ts:167

getLends

getLends(__namedParameters?: ILendsOptions): Promise<ILend[]>
Get a list of the most recent funding data for the given currency: total amount provided and Flash Return Rate (in % by 365 days) over time.
Parameters
- __namedParameters: ILendsOptions = {}
Returns Promise<ILend[]>
- Defined in src/public.ts:194

getOrderBook

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

getStats

getStats(__namedParameters?: ISymbolOptions): Promise<IStat[]>
Various statistics about the requested pair.
Parameters
- __namedParameters: ISymbolOptions = {}
Returns Promise<IStat[]>
- Defined in src/public.ts:160

getSymbolDetails

getSymbolDetails(): Promise<ISymbolDetail[]>
Get a list of valid symbol IDs and the pair details.

Returns Promise<ISymbolDetail[]>
- Defined in src/public.ts:207

getSymbols

getSymbols(): Promise<string[]>
Get the list of symbol names.

Returns Promise<string[]>
- Defined in src/public.ts:202

getTicker

getTicker(__namedParameters?: ISymbolOptions): Promise<ITicker>
Get the ticker.
Parameters
- __namedParameters: ISymbolOptions = {}
Returns Promise<ITicker>
- Defined in src/public.ts:153

getTrades

getTrades(__namedParameters?: ITradesOptions): Promise<ITrade[]>
Get a list of the most recent trades for the given symbol.
Parameters
- __namedParameters: ITradesOptions = {}
Returns Promise<ITrade[]>
- Defined in src/public.ts:183

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

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

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

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

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

`Static`setQuery

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