Class: CBExchangeClient
REST client for Coinbase's Institutional Exchange API: https://docs.cdp.coinbase.com/exchange/docs/welcome
Extends
BaseRestClient
Constructors
Constructor
new CBExchangeClient(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig): CBExchangeClient;Parameters
| Parameter | Type |
|---|---|
restClientOptions? | RestClientOptions |
requestOptions? | AxiosRequestConfig |
Returns
CBExchangeClient
Overrides
BaseRestClient.constructor
Methods
addAddresses()
addAddresses(params: GetCBExchAddressBookRequest): Promise<any>;Add addresses
Add new addresses to address book.
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchAddressBookRequest |
Returns
Promise<any>
cancelAllOrders()
cancelAllOrders(params?: object): Promise<any>;Cancel all orders
Attempt to cancel all open orders. Repeat the request if any open orders remain.
Parameters
| Parameter | Type |
|---|---|
params? | { product_id?: string; profile_id?: string; } |
params.product_id? | string |
params.profile_id? | string |
Returns
Promise<any>
cancelOrder()
cancelOrder(params: CancelCBExchOrderRequest): Promise<any>;Cancel an order
Cancel a single open order by id.
Parameters
| Parameter | Type |
|---|---|
params | CancelCBExchOrderRequest |
Returns
Promise<any>
convertCurrency()
convertCurrency(params: ConvertCBExchCurrencyRequest): Promise<any>;Convert currency
Converts funds from one currency to another. Funds are converted on the from account in the profile_id profile.
Parameters
| Parameter | Type |
|---|---|
params | ConvertCBExchCurrencyRequest |
Returns
Promise<any>
createNewCryptoAddress()
createNewCryptoAddress(params: CreateCBExchNewCryptoAddress): Promise<any>;Generate crypto address
Generates a one-time crypto address for depositing crypto.
Parameters
| Parameter | Type |
|---|---|
params | CreateCBExchNewCryptoAddress |
Returns
Promise<any>
createProfile()
createProfile(params: object): Promise<any>;Create a profile
Create a new profile. Will fail if no name is provided or if user already has max number of profiles.
Parameters
| Parameter | Type |
|---|---|
params | { name: string; } |
params.name | string |
Returns
Promise<any>
createReport()
createReport(params: CreateCBExchReport): Promise<any>;Create a report
Generates a report. You can create reports with historical data for all report types. Balance reports can be snapshots of historical or current data.
Parameters
| Parameter | Type |
|---|---|
params | CreateCBExchReport |
Returns
Promise<any>
createStakeWrap()
createStakeWrap(params: object): Promise<any>;Create a new stake-wrap
Stakes and wraps from_currency to to_currency. Funds are stake-wrapped in the profile associated with the API key.
Parameters
| Parameter | Type |
|---|---|
params | { amount: string; from_currency: string; to_currency: string; } |
params.amount | string |
params.from_currency | string |
params.to_currency | string |
Returns
Promise<any>
createTravelRuleEntry()
createTravelRuleEntry(params: object): Promise<any>;Create travel rule entry
Create travel rule entry for sending address.
Parameters
| Parameter | Type |
|---|---|
params | { address: string; originator_country: string; originator_name: string; } |
params.address | string |
params.originator_country | string |
params.originator_name | string |
Returns
Promise<any>
deleteAddress()
deleteAddress(params: object): Promise<any>;Delete address
Delete address from address book.
Parameters
| Parameter | Type |
|---|---|
params | { id: string; } |
params.id | string |
Returns
Promise<any>
deletePrivate()
deletePrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.deletePrivate
deleteProfile()
deleteProfile(params: object): Promise<any>;Delete a profile
Deletes the profile specified by profile_id and transfers all funds to the profile specified by to. Fails if there are any open orders on the profile to be deleted.
Parameters
| Parameter | Type |
|---|---|
params | { profile_id: string; to: string; } |
params.profile_id | string |
params.to | string |
Returns
Promise<any>
deleteTravelRuleEntry()
deleteTravelRuleEntry(params: object): Promise<any>;Delete existing travel rule entry
Delete existing travel rule entry.
Parameters
| Parameter | Type |
|---|---|
params | { id: string; } |
params.id | string |
Returns
Promise<any>
depositFromCoinbaseAccount()
depositFromCoinbaseAccount(params: CBExchDepositFromCoinbaseAccount): Promise<any>;Deposit from Coinbase account
Deposits funds from a www.coinbase.com wallet to the specified profile_id.
Parameters
| Parameter | Type |
|---|---|
params | CBExchDepositFromCoinbaseAccount |
Returns
Promise<any>
depositFromPaymentMethod()
depositFromPaymentMethod(params: CBExchDepositFromPaymentMethod): Promise<any>;Deposit from payment method
Deposits funds from a linked external payment method to the specified profile_id. See Get all payment methods. The SEPA payment method is not allowed for depositing funds because it is a push payment method.
Parameters
| Parameter | Type |
|---|---|
params | CBExchDepositFromPaymentMethod |
Returns
Promise<any>
generateNewOrderId()
generateNewOrderId(): string;Returns
string
Inherited from
BaseRestClient.generateNewOrderId
get()
get(endpoint: string, params?: object): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | object |
Returns
Promise<any>
Inherited from
BaseRestClient.get
getAccount()
getAccount(params: object): Promise<any>;Get a single account by id
Information for a single account. Use this endpoint when you know the account_id. API key must belong to the same profile as the account.
Parameters
| Parameter | Type |
|---|---|
params | { account_id: string; } |
params.account_id | string |
Returns
Promise<any>
getAccountHolds()
getAccountHolds(params: GetCBExchAccountHoldsRequest): Promise<any>;Get a single account's holds
List the holds of an account that belong to the same profile as the API key. Holds are placed on an account for any active orders or pending withdraw requests. As an order is filled, the hold amount is updated. If an order is canceled, any remaining hold is removed. For withdrawals, the hold is removed after it is completed.
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchAccountHoldsRequest |
Returns
Promise<any>
getAccountLedger()
getAccountLedger(params: GetCBExchAccountLedgerRequest): Promise<any>;Get a single account's ledger
Lists ledger activity for an account. This includes anything that would affect the account's balance - transfers, trades, fees, etc. If neither start_date nor end_date is set, the endpoint will return ledger activity for the past 1 day only. List account activity of the API key's profile. Account activity either increases or decreases your account balance.
Entry Types:
- transfer: Funds transferred between Coinbase and Coinbase Exchange
- match: Funds moved as a result of a trade
- fee: Fee as a result of a trade
- rebate: Fee rebate as per our fee schedule
- conversion: Funds converted between fiat currency and a stablecoin
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchAccountLedgerRequest |
Returns
Promise<any>
getAccounts()
getAccounts(): Promise<any>;Get all accounts for a profile
Get a list of trading accounts from the profile of the API key. Your trading accounts are separate from your Coinbase accounts. See Deposit from Coinbase account for documentation on how to deposit funds to begin trading.
Returns
Promise<any>
getAccountTransfers()
getAccountTransfers(params: GetCBExchAccountTransfersRequest): Promise<any>;Get a single account's transfers
Lists past withdrawals and deposits for an account.
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchAccountTransfersRequest |
Returns
Promise<any>
getAddressBook()
getAddressBook(): Promise<any>;Get address book
Get all addresses stored in the address book.
Returns
Promise<any>
getAllConversions()
getAllConversions(params: object): Promise<any>;Get all conversions
Get all conversions associated with the profile tied to the API key used to make the request.
Parameters
| Parameter | Type |
|---|---|
params | { after?: string; before?: string; limit?: number; profile_id: string; } |
params.after? | string |
params.before? | string |
params.limit? | number |
params.profile_id | string |
Returns
Promise<any>
getAllProductVolume()
getAllProductVolume(): Promise<any>;Get all product volume
Gets 30-day and 24-hour volume for all products and market types.
Returns
Promise<any>
getAllReports()
getAllReports(params?: GetAllCBExchReports): Promise<any>;Get all reports
Gets a list of all user-generated reports.
Parameters
| Parameter | Type |
|---|---|
params? | GetAllCBExchReports |
Returns
Promise<any>
getAllStakeWraps()
getAllStakeWraps(params?: GetCBExchAllStakeWraps): Promise<any>;Get all stake-wraps
Get details for all stake-wraps in the profile associated with the API key.
Parameters
| Parameter | Type |
|---|---|
params? | GetCBExchAllStakeWraps |
Returns
Promise<any>
getAllTradingPairs()
getAllTradingPairs(params?: object): Promise<any>;Get all known trading pairs
Gets a list of available currency pairs for trading.
Parameters
| Parameter | Type |
|---|---|
params? | { type?: string; } |
params.type? | string |
Returns
Promise<any>
getAllWrappedAssets()
getAllWrappedAssets(): Promise<any>;Get all wrapped assets
Returns a list of all supported wrapped assets details objects.
Returns
Promise<any>
getClientType()
getClientType(): RestClientType;Defines the client type (affecting how requests & signatures behave)
Returns
RestClientType
Overrides
BaseRestClient.getClientType
getCoinbaseWallets()
getCoinbaseWallets(): Promise<any>;Get all Coinbase wallets
Gets all the user's available Coinbase wallets. These are the wallets/accounts that are used for buying and selling on www.coinbase.com.
Returns
Promise<any>
getConversion()
getConversion(params: object): Promise<any>;Get a conversion
Gets a currency conversion by id (i.e. USD -> USDC).
Parameters
| Parameter | Type |
|---|---|
params | { conversion_id: string; profile_id?: string; } |
params.conversion_id | string |
params.profile_id? | string |
Returns
Promise<any>
getConversionFeeRates()
getConversionFeeRates(): Promise<any>;Get conversion fee rates
Gets a list of current conversion fee rates and trailing 30 day volume by currency pair.
Returns
Promise<any>
getCounterpartyAddressBook()
getCounterpartyAddressBook(): Promise<CBExchCounterpartyAddress[]>;Get counterparty address book
Get all counterparty addresses stored in the address book.
Returns
Promise<CBExchCounterpartyAddress[]>
getCryptoWithdrawalFeeEstimate()
getCryptoWithdrawalFeeEstimate(params: CBExchGetCryptoWithdrawalFeeEstimate): Promise<any>;Get fee estimate for crypto withdrawal
Gets the fee estimate for the crypto withdrawal to a crypto address.
Parameters
| Parameter | Type |
|---|---|
params | CBExchGetCryptoWithdrawalFeeEstimate |
Returns
Promise<any>
getCurrencies()
getCurrencies(): Promise<any>;Get all known currencies
Gets a list of all known currencies. Note: Not all currencies may be currently in use for trading.
Returns
Promise<any>
getCurrency()
getCurrency(currency_id: string): Promise<any>;Get a currency
Gets a single currency by id.
Parameters
| Parameter | Type |
|---|---|
currency_id | string |
Returns
Promise<any>
getFees()
getFees(): Promise<any>;Get fees
Get fee rates and 30 days trailing volume. This request returns your current maker & taker fee rates, as well as your 30-day trailing volume. Quoted rates are subject to change.
Returns
Promise<any>
getFills()
getFills(params?: GetCBExchFillsRequest): Promise<any>;Get all fills
Get a list of recent fills of the API key's profile. A fill is a partial or complete match on a specific order.
Parameters
| Parameter | Type |
|---|---|
params? | GetCBExchFillsRequest |
Returns
Promise<any>
getInterestCharges()
getInterestCharges(params: object): Promise<any>;List interest charges
List interest charges for a loan.
Parameters
| Parameter | Type |
|---|---|
params | { loan_id: string; } |
params.loan_id | string |
Returns
Promise<any>
getInterestRateHistory()
getInterestRateHistory(params: object): Promise<any>;List interest rate history
List interest rate history for a loan.
Parameters
| Parameter | Type |
|---|---|
params | { loan_id: string; } |
params.loan_id | string |
Returns
Promise<any>
getInterestSummaries()
getInterestSummaries(): Promise<any>;List interest summaries
List summaries of interest owed by asset.
Returns
Promise<any>
getLendingOverview()
getLendingOverview(): Promise<any>;Get lending overview
This API summarizes lending for a given client. It calculates the overall loan balance, collateral level, and amounts available to borrow. It also returns any withdrawal restrictions in force on the client.
Get lending overview returns all amounts in USD notional values, except available_per_asset mappings which are returned in both notional and native values.
Returns
Promise<any>
getLoanAssets()
getLoanAssets(): Promise<any>;List loan assets
Get a list of lendable assets, a map of assets we accept as collateral for loans, and the haircut weight.
Returns
Promise<any>
getLoans()
getLoans(params?: object): Promise<any>;List loans
Accepts zero or more loan IDs as input. If no loan IDs are specified, it returns all loans for the user. Otherwise, it returns only the loans matching the specified IDs.
Parameters
| Parameter | Type |
|---|---|
params? | { ids?: string; } |
params.ids? | string |
Returns
Promise<any>
getNewLoanOptions()
getNewLoanOptions(): Promise<any>;List new loan options
Get available currencies and interest rates for new loans. All amounts returned by this API are notional values (i.e., USD).
Returns
Promise<any>
getNewLoanPreview()
getNewLoanPreview(params: object): Promise<any>;Get new loan preview
This API is similar to lending-overview but is used to preview the results of opening a new loan. The values returned in the preview response take the existing loans, collateral and the potential change being previewed into account. Note the preview request accepts native currency amounts as input.
Parameters
| Parameter | Type |
|---|---|
params | { currency: string; native_amount: string; } |
params.currency | string |
params.native_amount | string |
Returns
Promise<any>
getOrder()
getOrder(params: object): Promise<any>;Get single order
Get a single order by id.
Parameters
| Parameter | Type |
|---|---|
params | { market_type?: string; order_id: string; } |
params.market_type? | string |
params.order_id | string |
Returns
Promise<any>
getOrders()
getOrders(params?: GetCBExchOrdersRequest): Promise<any>;Get all orders
List your current open orders. Only open or un-settled orders are returned by default. As soon as an order is no longer open and settled, it will no longer appear in the default request. Open orders may change state between the request and the response depending on market conditions.
Parameters
| Parameter | Type |
|---|---|
params? | GetCBExchOrdersRequest |
Returns
Promise<any>
getPaymentMethods()
getPaymentMethods(): Promise<any>;Get all payment methods
Gets a list of the user's linked payment methods.
Returns
Promise<any>
getPrincipalRepaymentPreview()
getPrincipalRepaymentPreview(params: GetCBExchPrincipalRepaymentPreview): Promise<any>;Get principal repayment preview
Preview the results of a loan principal repayment. Like the Get lending overview API, all values are notional except available_per_asset which returns both notional and native values per currency.
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchPrincipalRepaymentPreview |
Returns
Promise<any>
getPrivate()
getPrivate(endpoint: string, params?: object): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | object |
Returns
Promise<any>
Inherited from
BaseRestClient.getPrivate
getProduct()
getProduct(params: object): Promise<any>;Get single product
Get information on a single product.
Parameters
| Parameter | Type |
|---|---|
params | { product_id: string; } |
params.product_id | string |
Returns
Promise<any>
getProductBook()
getProductBook(params: object): Promise<any>;Get product book
Get a list of open orders for a product. The amount of detail shown can be customized with the level parameter. By default, only the inside (i.e., the best) bid and ask are returned. This is equivalent to a book depth of 1 level. To see a larger order book, specify the level query parameter.
Parameters
| Parameter | Type |
|---|---|
params | { level?: number; product_id: string; } |
params.level? | number |
params.product_id | string |
Returns
Promise<any>
getProductCandles()
getProductCandles(params: GetCBExchProductCandles): Promise<any>;Get product candles
Historic rates for a product. Rates are returned in grouped buckets. Each candle is [timestamp, price_low, price_high, price_open, price_close, volume].
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchProductCandles |
Returns
Promise<any>
getProductStats()
getProductStats(params: object): Promise<any>;Get product stats
Gets 30-day and 24-hour stats for a product.
Parameters
| Parameter | Type |
|---|---|
params | { product_id: string; } |
params.product_id | string |
Returns
Promise<any>
getProductTicker()
getProductTicker(params: object): Promise<any>;Get product ticker
Gets snapshot information about the last trade (tick), best bid/ask, and 24h volume.
Parameters
| Parameter | Type |
|---|---|
params | { product_id: string; } |
params.product_id | string |
Returns
Promise<any>
getProductTrades()
getProductTrades(params: GetCBExchProductTrades): Promise<any>;Get product trades
Gets a list of the latest trades for a product.
Parameters
| Parameter | Type |
|---|---|
params | GetCBExchProductTrades |
Returns
Promise<any>
getProfileById()
getProfileById(params: object): Promise<any>;Get profile by id
Information for a single profile. Use this endpoint when you know the profile_id.
Parameters
| Parameter | Type |
|---|---|
params | { active?: boolean; profile_id: string; } |
params.active? | boolean |
params.profile_id | string |
Returns
Promise<any>
getProfiles()
getProfiles(params?: object): Promise<any>;Get profiles
Gets a list of all of the current user's profiles.
Parameters
| Parameter | Type |
|---|---|
params? | { active?: boolean; } |
params.active? | boolean |
Returns
Promise<any>
getReport()
getReport(params: object): Promise<any>;Get a report
Get a specific report by report_id.
Parameters
| Parameter | Type |
|---|---|
params | { report_id: string; } |
params.report_id | string |
Returns
Promise<any>
getSignedPrices()
getSignedPrices(): Promise<any>;SDK wrapper for authenticated GET /oracle. The response is typed as any; confirm the endpoint and returned payload meet your on-chain integration’s requirements before use.
Returns
Promise<any>
getSignTimestampMs()
getSignTimestampMs(): number;Timestamp used to sign the request. Override this method to implement your own timestamp/sync mechanism
Returns
number
Inherited from
BaseRestClient.getSignTimestampMs
getStakeWrap()
getStakeWrap(params: object): Promise<any>;Get a single stake-wrap
Get details for a specific stake-wrap in the profile associated with the API key.
Parameters
| Parameter | Type |
|---|---|
params | { stake_wrap_id: string; } |
params.stake_wrap_id | string |
Returns
Promise<any>
getTransfer()
getTransfer(params: object): Promise<any>;Get a single transfer
Get information on a single transfer.
Parameters
| Parameter | Type |
|---|---|
params | { transfer_id: string; } |
params.transfer_id | string |
Returns
Promise<any>
getTransfers()
getTransfers(params?: CBExchGetTransfersRequest): Promise<any>;Get all transfers
Gets a list of in-progress and completed transfers of funds in/out of any of the user's accounts.
Parameters
| Parameter | Type |
|---|---|
params? | CBExchGetTransfersRequest |
Returns
Promise<any>
getTravelRuleInformation()
getTravelRuleInformation(params?: GetCBExchTravelRuleInformation): Promise<any>;Get all travel rule information
Return a list of all stored travel rule information.
Parameters
| Parameter | Type |
|---|---|
params? | GetCBExchTravelRuleInformation |
Returns
Promise<any>
getUserExchangeLimits()
getUserExchangeLimits(params: object): Promise<any>;Get user exchange limits
Gets exchange limits information for a single user.
Parameters
| Parameter | Type |
|---|---|
params | { user_id: string; } |
params.user_id | string |
Returns
Promise<any>
getUserTradingVolume()
getUserTradingVolume(params: object): Promise<any>;Get user trading volume
Gets aggregated and individual trading volumes for users.
Parameters
| Parameter | Type |
|---|---|
params | { user_id: string; } |
params.user_id | string |
Returns
Promise<any>
getWrappedAssetConversionRate()
getWrappedAssetConversionRate(params: object): Promise<any>;Get wrapped asset conversion rate
Returns the conversion rate of a wrapped asset.
Parameters
| Parameter | Type |
|---|---|
params | { wrapped_asset_id: string; } |
params.wrapped_asset_id | string |
Returns
Promise<any>
getWrappedAssetDetails()
getWrappedAssetDetails(params: object): Promise<any>;Get wrapped asset details
Returns the circulating and total supply of a wrapped asset, and its conversion rate.
Parameters
| Parameter | Type |
|---|---|
params | { wrapped_asset_id: string; } |
params.wrapped_asset_id | string |
Returns
Promise<any>
patchPrivate()
patchPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.patchPrivate
post()
post(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.post
postPrivate()
postPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.postPrivate
putPrivate()
putPrivate(endpoint: string, params?: ParamsInRequest): Promise<any>;Parameters
| Parameter | Type |
|---|---|
endpoint | string |
params? | ParamsInRequest |
Returns
Promise<any>
Inherited from
BaseRestClient.putPrivate
renameProfile()
renameProfile(params: object): Promise<any>;Rename a profile
Rename a profile. Names 'default' and 'margin' are reserved.
Parameters
| Parameter | Type |
|---|---|
params | { name: string; profile_id: string; } |
params.name | string |
params.profile_id | string |
Returns
Promise<any>
repayLoanInterest()
repayLoanInterest(params: RepayCBExchLoanInterest): Promise<any>;Repay loan interest
Submit an interest repayment for a loan.
Parameters
| Parameter | Type |
|---|---|
params | RepayCBExchLoanInterest |
Returns
Promise<any>
repayLoanPrincipal()
repayLoanPrincipal(params: RepayCBExchLoanPrincipal): Promise<any>;Repay loan principal
Submit a principal repayment for a loan.
Parameters
| Parameter | Type |
|---|---|
params | RepayCBExchLoanPrincipal |
Returns
Promise<any>
submitNewLoan()
submitNewLoan(params: SubmitCBExchNewLoan): Promise<any>;Open new loan
This API triggers a loan open request. Funding is not necessarily instantaneous and there is no SLA. You are notified when funds have settled in your Exchange account. Loan open requests, once initiated, cannot be canceled.
Parameters
| Parameter | Type |
|---|---|
params | SubmitCBExchNewLoan |
Returns
Promise<any>
submitOrder()
submitOrder(params: SubmitCBExchOrderRequest): Promise<any>;Create a new order
Create an order. You can place two types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your account funds will be put on hold for the duration of the order.
Parameters
| Parameter | Type |
|---|---|
params | SubmitCBExchOrderRequest |
Returns
Promise<any>
submitTravelInformation()
submitTravelInformation(params: SubmitCBExchTravelInformation): Promise<any>;Submit travel information for a transfer
Submit travel information for a transfer.
Parameters
| Parameter | Type |
|---|---|
params | SubmitCBExchTravelInformation |
Returns
Promise<any>
transferFundsBetweenProfiles()
transferFundsBetweenProfiles(params: TransferCBExchFundsBetweenProfiles): Promise<any>;Transfer funds between profiles
Transfer an amount of currency from one profile to another.
Parameters
| Parameter | Type |
|---|---|
params | TransferCBExchFundsBetweenProfiles |
Returns
Promise<any>
updateAddressBookEntry()
updateAddressBookEntry(params: UpdateCBExchAddressBookEntryRequest): Promise<any>;Update address book entry
Edit an existing address book entry. Useful for travel rule jurisdictions.
Parameters
| Parameter | Type |
|---|---|
params | UpdateCBExchAddressBookEntryRequest |
Returns
Promise<any>
updateSettlementPreference()
updateSettlementPreference(params: object): Promise<any>;Update settlement preference
Updates the settlement preference to hold funds in either USDC or USD.
Parameters
| Parameter | Type |
|---|---|
params | { settlement_preference: string; user_id: string; } |
params.settlement_preference | string |
params.user_id | string |
Returns
Promise<any>
withdrawToCoinbaseAccount()
withdrawToCoinbaseAccount(params: CBExchWithdrawToCBAccount): Promise<any>;Withdraw to Coinbase account
Withdraws funds from the specified profile_id to a www.coinbase.com wallet. You can move funds between your Coinbase accounts and your Coinbase Exchange trading accounts within your daily limits. Moving funds between Coinbase and Coinbase Exchange is instant and free. See the Coinbase Accounts section for retrieving your Coinbase accounts.
Parameters
| Parameter | Type |
|---|---|
params | CBExchWithdrawToCBAccount |
Returns
Promise<any>
withdrawToCryptoAddress()
withdrawToCryptoAddress(params: CBExchWithdrawToCryptoAddress): Promise<any>;Withdraw to crypto address
Withdraws funds from the specified profile_id to an external crypto address.
Parameters
| Parameter | Type |
|---|---|
params | CBExchWithdrawToCryptoAddress |
Returns
Promise<any>
withdrawToPaymentMethod()
withdrawToPaymentMethod(params: CBExchWithdrawToPaymentMethod): Promise<any>;Withdraw to payment method
Withdraws funds from the specified profile_id to a linked external payment method. See the Payment Methods section for retrieving your payment methods.
Parameters
| Parameter | Type |
|---|---|
params | CBExchWithdrawToPaymentMethod |
Returns
Promise<any>