Class PublicClientV2

Hierarchy (View Summary)

Fetch
- PublicClientV2
  - AuthenticatedClientV2

Index

Constructors

constructor

Accessors

base_url init reject symbol transform

Methods

Constructors

constructor

new PublicClientV2(__namedParameters?: IPublicClientV2Options): PublicClientV2
Parameters
- __namedParameters: IPublicClientV2Options = {}
Returns PublicClientV2
Overrides Fetch.constructor
- Defined in src/public-v2.ts:641

Accessors

base_url

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

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-v2.ts:654

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,
init?: IFetchOptions & { options?: IRecordType },
): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IFetchOptions & { options?: IRecordType } = {}
Returns Promise<T>
Overrides Fetch.get
- Defined in src/public-v2.ts:658

getBook

getBook(__namedParameters?: IBookOptionsV2): Promise<IBookEntryV2[]>
Order book of a given pair.
Parameters
- __namedParameters: IBookOptionsV2 = {}
Returns Promise<IBookEntryV2[]>
- Defined in src/public-v2.ts:739

getCandles

getCandles(__namedParameters: ICandlesOptions): Promise<ICandleV2 | ICandleV2[]>
Provides a way to access charting candle info.
Parameters
- __namedParameters: ICandlesOptions
Returns Promise<ICandleV2 | ICandleV2[]>
- Defined in src/public-v2.ts:771

getConfigs

getConfigs(__namedParameters: IConfigsOptions): Promise<unknown[]>
Public configurations endpoint. Returns raw data as documented per config key.
Parameters
- __namedParameters: IConfigsOptions
Returns Promise<unknown[]>
- Defined in src/public-v2.ts:801

getDerivativesStatus

getDerivativesStatus(
__namedParameters: IDerivativesStatusOptions,
): Promise<IDerivativeStatus[]>
Endpoint used to receive different types of platform information.
Parameters
- __namedParameters: IDerivativesStatusOptions
Returns Promise<IDerivativeStatus[]>
- Defined in src/public-v2.ts:807

getDerivativesStatusHistory

getDerivativesStatusHistory(
__namedParameters: IDerivativesStatusHistoryOptions,
): Promise<IDerivativeStatus[]>
History of derivative statuses for a single key.
Parameters
- __namedParameters: IDerivativesStatusHistoryOptions
Returns Promise<IDerivativeStatus[]>
- Defined in src/public-v2.ts:817

getForeignExchangeRate

getForeignExchangeRate(
body: IForeignExchangeRateOptions,
): Promise<IForeignExchangeRate>
Calculate the exchange rate between two currencies.
Parameters
- body: IForeignExchangeRateOptions
Returns Promise<IForeignExchangeRate>
- Defined in src/public-v2.ts:880

getFundingStats

getFundingStats(
__namedParameters?: IFundingStatsOptions,
): Promise<IFundingStat[]>
Get a list of the most recent funding data: FRR, average period, etc.
Parameters
- __namedParameters: IFundingStatsOptions = {}
Returns Promise<IFundingStat[]>
- Defined in src/public-v2.ts:852

getLeaderboards

getLeaderboards(
__namedParameters: ILeaderboardsOptions,
): Promise<ILeaderboardEntry[]>
Get leaderboards entries.
Parameters
- __namedParameters: ILeaderboardsOptions
Returns Promise<ILeaderboardEntry[]>
- Defined in src/public-v2.ts:838

getLiquidations

getLiquidations(options?: ILiquidationsOptions): Promise<ILiquidation[]>
Endpoint to retrieve liquidations.
Parameters
- options: ILiquidationsOptions = {}
Returns Promise<ILiquidation[]>
- Defined in src/public-v2.ts:828

getMarketAveragePrice

getMarketAveragePrice(
body: IMarketAveragePriceOptions,
): Promise<IMarketAveragePrice>
Calculate the average execution price for trading.
Parameters
- body: IMarketAveragePriceOptions
Returns Promise<IMarketAveragePrice>
- Defined in src/public-v2.ts:868

getPlatformStatus

getPlatformStatus(): Promise<IPlatformStatus>
Get the current status of the platform (operative or maintenance).

Returns Promise<IPlatformStatus>
- Defined in src/public-v2.ts:692

getStats

getStats(options: IStatsOptions): Promise<IStatV2 | IStatV2[]>
Various statistics about the requested pair.
Parameters
- options: IStatsOptions
Returns Promise<IStatV2 | IStatV2[]>
- Defined in src/public-v2.ts:753

getTicker

getTicker(__namedParameters?: ISymbolOptionsV2): Promise<ITickerV2>
High level overview of the state of the market for a single trading or funding pair.
Parameters
- __namedParameters: ISymbolOptionsV2 = {}
Returns Promise<ITickerV2>
- Defined in src/public-v2.ts:698

getTickers

getTickers(__namedParameters: ITickersOptions): Promise<ITickerV2[]>
High level overview of the state of the market for several pairs.
Parameters
- __namedParameters: ITickersOptions
Returns Promise<ITickerV2[]>
- Defined in src/public-v2.ts:706

getTickersHistory

getTickersHistory(
__namedParameters: ITickersHistoryOptions,
): Promise<ITickerHistoryV2[]>
Historical data for the tickers endpoint.
Parameters
- __namedParameters: ITickersHistoryOptions
Returns Promise<ITickerHistoryV2[]>
- Defined in src/public-v2.ts:714

getTrades

getTrades(__namedParameters?: ITradesOptionsV2): Promise<ITradeV2[]>
Public trades that have occurred for the requested trading or funding pair.
Parameters
- __namedParameters: ITradesOptionsV2 = {}
Returns Promise<ITradeV2[]>
- Defined in src/public-v2.ts:725

getVASPs

getVASPs(): Promise<IVASPs>
List of Virtual Asset Service Providers supported by Bitfinex.

Returns Promise<IVASPs>
- Defined in src/public-v2.ts:863

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,
    body?: Record<string, unknown>,
): Promise<T>
Type Parameters
- T = unknown
Parameters
- path: string = ""
- init: IFetchOptions = {}
- body: Record<string, unknown> = {}
Returns Promise<T>
Overrides Fetch.post
- Defined in src/public-v2.ts:673

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