Class AuthenticatedClient

Hierarchy

PublicClient
- AuthenticatedClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AuthenticatedClient(__namedParameters: AuthenticatedClientOptions): AuthenticatedClient

Overrides PublicClient.constructor
- Defined in src/auth.ts:368
Parameters
- __namedParameters: AuthenticatedClientOptions
Returns AuthenticatedClient

Properties

Private Readonly #api_url

#api_url: URL

Private Readonly #key

#key: string

Private Readonly #passphrase

#passphrase: string

Private #private

#private: any

Private Readonly #product_id

#product_id: string

Private Readonly #secret

#secret: string

Accessors

apiUri

get apiUri(): URL

Inherited from PublicClient.apiUri
- Defined in src/public.ts:160
Returns URL

fetchOptions

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

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

product_id

get product_id(): string

Inherited from PublicClient.product_id
- Defined in src/public.ts:156
Returns string

Methods

cancelAll

cancelAll(qs?: ProductID): Promise<string[]>

- Defined in src/auth.ts:447
Parameters
- qs: ProductID = {}
Returns Promise<string[]>

cancelOrder

cancelOrder(params: CancelOrderParams): Promise<string>

- Defined in src/auth.ts:439
Parameters
- params: CancelOrderParams
Returns Promise<string>

convert

convert(params: ConvertParams): Promise<Conversion>

- Defined in src/auth.ts:513
Parameters
- params: ConvertParams
Returns Promise<Conversion>

createReport

createReport(params: ReportParams): Promise<BaseReportStatus>

- Defined in src/auth.ts:531
Parameters
- params: ReportParams
Returns Promise<BaseReportStatus>

delete

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

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

deposit

deposit(params: DepositParams): Promise<DepositInfo>

- Defined in src/auth.ts:476
Parameters
- params: DepositParams
Returns Promise<DepositInfo>

depositCoinbase

depositCoinbase(params: DepositCoinbaseParams): Promise<DepositInfo>

- Defined in src/auth.ts:482
Parameters
- params: DepositCoinbaseParams
Returns Promise<DepositInfo>

feeEstimate

feeEstimate(qs: FeeEstimateParams): Promise<EstimatedFee>

- Defined in src/auth.ts:507
Get the network fee estimate when sending to the given address.

Parameters
- qs: FeeEstimateParams
Returns Promise<EstimatedFee>

fetch

fetch(path: string, __namedParameters: { body?: string; method: string }): Promise<unknown>

Overrides PublicClient.fetch
- Defined in src/auth.ts:380
Parameters
- path: string
- __namedParameters: { body?: string; method: string }
  - Optional body?: string
  - method: string
Returns Promise<unknown>

get

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

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

get24hrStats

get24hrStats(__namedParameters?: ProductID): Promise<ProductStats>

Inherited from PublicClient.get24hrStats
- Defined in src/public.ts:229
Parameters
- __namedParameters: ProductID = {}
Returns Promise<ProductStats>

getAccount

getAccount(__namedParameters: AccountId): Promise<Account>

- Defined in src/auth.ts:406
Parameters
- __namedParameters: AccountId
Returns Promise<Account>

getAccountHistory

getAccountHistory(__namedParameters: AccountHistoryParams): Promise<AccountHistory[]>

- Defined in src/auth.ts:411
List account activity of the API key’s profile.

Parameters
- __namedParameters: AccountHistoryParams
Returns Promise<AccountHistory[]>

getAccounts

getAccounts(): Promise<Account[]>

- Defined in src/auth.ts:402
Get a list of trading accounts from the profile of the API key.

Returns Promise<Account[]>

getCoinbaseAccounts

getCoinbaseAccounts(): Promise<CoinbaseAccount[]>

- Defined in src/auth.ts:523
Returns Promise<CoinbaseAccount[]>

getCurrencies

getCurrencies(): Promise<CurrencyInfo[]>

Inherited from PublicClient.getCurrencies
- Defined in src/public.ts:235
Returns Promise<CurrencyInfo[]>

getCurrency

getCurrency(__namedParameters: { id: string }): Promise<CurrencyInfo>

Inherited from PublicClient.getCurrency
- Defined in src/public.ts:239
Parameters
- __namedParameters: { id: string }
  - id: string
Returns Promise<CurrencyInfo>

getFees

getFees(): Promise<Fees>

- Defined in src/auth.ts:527
Returns Promise<Fees>

getFills

getFills(qs?: GetFillsParams): Promise<Fill[]>

- Defined in src/auth.ts:467
Parameters
- qs: GetFillsParams = {}
Returns Promise<Fill[]>

getHistoricRates

getHistoricRates(__namedParameters: HistoricRatesArgs): Promise<Candle[]>

Inherited from PublicClient.getHistoricRates
- Defined in src/public.ts:220
Parameters
- __namedParameters: HistoricRatesArgs
Returns Promise<Candle[]>

getHolds

getHolds(__namedParameters: AccountHistoryParams): Promise<AccountHold[]>

- Defined in src/auth.ts:421
List holds of an account that belong to the same profile as the API key.

Parameters
- __namedParameters: AccountHistoryParams
Returns Promise<AccountHold[]>

getOrder

getOrder(params: CancelOrderParams): Promise<OrderInfo>

- Defined in src/auth.ts:459
Parameters
- params: CancelOrderParams
Returns Promise<OrderInfo>

getOrderBook

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

Inherited from PublicClient.getOrderBook
- Defined in src/public.ts:196
Parameters
- __namedParameters: OrderBookArgs = {}
Returns Promise<OrderBook>

getOrders

getOrders(qs?: GetOrdersParams): Promise<OrderInfo[]>

- Defined in src/auth.ts:453
Parameters
- qs: GetOrdersParams = {}
Returns Promise<OrderInfo[]>

getPaymentMethods

getPaymentMethods(): Promise<PaymentMethod[]>

- Defined in src/auth.ts:519
Returns Promise<PaymentMethod[]>

getProduct

getProduct(__namedParameters?: ProductID): Promise<ProductInfo>

Inherited from PublicClient.getProduct
- Defined in src/public.ts:190
Parameters
- __namedParameters: ProductID = {}
Returns Promise<ProductInfo>

getProducts

getProducts(): Promise<ProductInfo[]>

Inherited from PublicClient.getProducts
- Defined in src/public.ts:186
Returns Promise<ProductInfo[]>

getProfile

getProfile(__namedParameters: { id: string }): Promise<Profile>

- Defined in src/auth.ts:558
Get a single profile by profile id.

Parameters
- __namedParameters: { id: string }
  - id: string
Returns Promise<Profile>

getProfiles

getProfiles(): Promise<Profile[]>

- Defined in src/auth.ts:553
List your profiles.

Returns Promise<Profile[]>

getReport

getReport(__namedParameters: { id: string }): Promise<ReportStatus>

- Defined in src/auth.ts:548
Parameters
- __namedParameters: { id: string }
  - id: string
Returns Promise<ReportStatus>

getTicker

getTicker(__namedParameters?: ProductID): Promise<Ticker>

Inherited from PublicClient.getTicker
- Defined in src/public.ts:205
Parameters
- __namedParameters: ProductID = {}
Returns Promise<Ticker>

getTime

getTime(): Promise<Time>

Inherited from PublicClient.getTime
- Defined in src/public.ts:243
Returns Promise<Time>

getTrades

getTrades(__namedParameters?: PagProductID): Promise<Trade[]>

Inherited from PublicClient.getTrades
- Defined in src/public.ts:211
Parameters
- __namedParameters: PagProductID = {}
Returns Promise<Trade[]>

getTrailingVolume

getTrailingVolume(): Promise<TrailingVolume[]>

- Defined in src/auth.ts:570
Get your 30-day trailing volume for all products of the API key’s profile.

Returns Promise<TrailingVolume[]>

head

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

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

placeOrder

placeOrder(__namedParameters: OrderParams): Promise<OrderInfo>

- Defined in src/auth.ts:430
Parameters
- __namedParameters: OrderParams
Returns Promise<OrderInfo>

post

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

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

transfer

transfer(params: TransferParams): Promise<"OK">

- Defined in src/auth.ts:563
Transfer funds from API key’s profile to another user owned profile.

Parameters
- params: TransferParams
Returns Promise<"OK">

withdraw

withdraw(params: DepositParams): Promise<DepositInfo>

- Defined in src/auth.ts:488
Parameters
- params: DepositParams
Returns Promise<DepositInfo>

withdrawCoinbase

withdrawCoinbase(params: DepositCoinbaseParams): Promise<DepositInfo>

- Defined in src/auth.ts:494
Parameters
- params: DepositCoinbaseParams
Returns Promise<DepositInfo>

withdrawCrypto

withdrawCrypto(params: WithdrawCryptoParams): Promise<DepositInfo>

- Defined in src/auth.ts:500
Parameters
- params: WithdrawCryptoParams
Returns Promise<DepositInfo>