@bluvo/sdk-ts

# .WalletsApi All URIs are relative to *https://api-bluvo.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**connectWallet**](WalletsApi.md#connectWallet) | **POST** /v0/cex/connect/{exchange} | Connect Wallet [**deleteWallet**](WalletsApi.md#deleteWallet) | **DELETE** /v0/cex/wallet/{walletId} | Delete Wallet [**getWallet**](WalletsApi.md#getWallet) | **GET** /v0/cex/wallet/{walletId} | Get Wallet [**listWallets**](WalletsApi.md#listWallets) | **GET** /v0/cex/wallets | List Wallets # **connectWallet** > ConnectWallet200Response connectWallet(connectWalletRequest) Connect an external cryptocurrency exchange account to your Bluvo project. This endpoint requires authentication via a valid Bluvo API Key, which must be included in the request headers. The connection is established using the exchange API credentials provided in the request body. It returns a unique workflow run ID that can be used to track the connection process. ### Example ```typescript import { createConfiguration, WalletsApi } from ''; import type { WalletsApiConnectWalletRequest } from ''; const configuration = createConfiguration(); const apiInstance = new WalletsApi(configuration); const request: WalletsApiConnectWalletRequest = { // The identifier of the exchange to connect (e.g. \'binance\', \'kraken\'). exchange: "ace", connectWalletRequest: { apiKey: "apiKey_example", apiSecret: "apiSecret_example", apiPassphrase: "apiPassphrase_example", apiUid: "apiUid_example", ips: [ "ips_example", ], }, }; const data = await apiInstance.connectWallet(request); console.log('API called successfully. Returned data:', data); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **connectWalletRequest** | **ConnectWalletRequest**| | **exchange** | [**'ace' | 'ascendex' | 'bequant' | 'bigone' | 'binance' | 'coinbase' | 'binanceus' | 'bingx' | 'bit2c' | 'bitbank' | 'bitbns' | 'bitcoincom' | 'bitfinex' | 'bitflyer' | 'bitget' | 'bithumb' | 'bitmart' | 'bitmex' | 'bitopro' | 'bitpanda' | 'bitrue' | 'bitso' | 'bitstamp' | 'bitteam' | 'bitvavo' | 'bl3p' | 'blockchaincom' | 'blofin' | 'btcalpha' | 'btcbox' | 'btcmarkets' | 'btcturk' | 'cex' | 'coincheck' | 'coinex' | 'coinlist' | 'coinmate' | 'coinmetro' | 'coinone' | 'coinsph' | 'coinspot' | 'cryptocom' | 'delta' | 'deribit' | 'digifinex' | 'exmo' | 'fmfwio' | 'gate' | 'gateio' | 'gemini' | 'hashkey' | 'hitbtc' | 'hollaex' | 'htx' | 'huobi' | 'huobijp' | 'hyperliquid' | 'independentreserve' | 'indodax' | 'kraken' | 'krakenfutures' | 'kucoin' | 'kucoinfutures' | 'latoken' | 'lbank' | 'luno' | 'mercado' | 'mexc' | 'ndax' | 'novadax' | 'oceanex' | 'okcoin' | 'okx' | 'onetrading' | 'oxfun' | 'p2b' | 'paradex' | 'paymium' | 'phemex' | 'poloniex' | 'poloniexfutures' | 'probit' | 'timex' | 'tradeogre' | 'upbit' | 'vertex' | 'wavesexchange' | 'whitebit' | 'woo' | 'woofipro' | 'xt' | 'yobit' | 'zaif' | 'zonda'**]**Array<'ace' | 'ascendex' | 'bequant' | 'bigone' | 'binance' | 'coinbase' | 'binanceus' | 'bingx' | 'bit2c' | 'bitbank' | 'bitbns' | 'bitcoincom' | 'bitfinex' | 'bitflyer' | 'bitget' | 'bithumb' | 'bitmart' | 'bitmex' | 'bitopro' | 'bitpanda' | 'bitrue' | 'bitso' | 'bitstamp' | 'bitteam' | 'bitvavo' | 'bl3p' | 'blockchaincom' | 'blofin' | 'btcalpha' | 'btcbox' | 'btcmarkets' | 'btcturk' | 'cex' | 'coincheck' | 'coinex' | 'coinlist' | 'coinmate' | 'coinmetro' | 'coinone' | 'coinsph' | 'coinspot' | 'cryptocom' | 'delta' | 'deribit' | 'digifinex' | 'exmo' | 'fmfwio' | 'gate' | 'gateio' | 'gemini' | 'hashkey' | 'hitbtc' | 'hollaex' | 'htx' | 'huobi' | 'huobijp' | 'hyperliquid' | 'independentreserve' | 'indodax' | 'kraken' | 'krakenfutures' | 'kucoin' | 'kucoinfutures' | 'latoken' | 'lbank' | 'luno' | 'mercado' | 'mexc' | 'ndax' | 'novadax' | 'oceanex' | 'okcoin' | 'okx' | 'onetrading' | 'oxfun' | 'p2b' | 'paradex' | 'paymium' | 'phemex' | 'poloniex' | 'poloniexfutures' | 'probit' | 'timex' | 'tradeogre' | 'upbit' | 'vertex' | 'wavesexchange' | 'whitebit' | 'woo' | 'woofipro' | 'xt' | 'yobit' | 'zaif' | 'zonda'>** | The identifier of the exchange to connect (e.g. \'binance\', \'kraken\'). | defaults to undefined ### Return type **ConnectWallet200Response** ### Authorization [bluvoOrgId](README.md#bluvoOrgId), [bluvoApiKey](README.md#bluvoApiKey), [bluvoProjectId](README.md#bluvoProjectId), [bluvoWalletId](README.md#bluvoWalletId) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **deleteWallet** > DeleteWallet200Response deleteWallet() Delete a connected exchange wallet. This endpoint requires authentication via a valid Bluvo API Key, which must be included in the request headers. ### Example ```typescript import { createConfiguration, WalletsApi } from ''; import type { WalletsApiDeleteWalletRequest } from ''; const configuration = createConfiguration(); const apiInstance = new WalletsApi(configuration); const request: WalletsApiDeleteWalletRequest = { walletId: "walletId_example", }; const data = await apiInstance.deleteWallet(request); console.log('API called successfully. Returned data:', data); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **walletId** | [**string**] | | defaults to undefined ### Return type **DeleteWallet200Response** ### Authorization [bluvoOrgId](README.md#bluvoOrgId), [bluvoApiKey](README.md#bluvoApiKey), [bluvoProjectId](README.md#bluvoProjectId), [bluvoWalletId](README.md#bluvoWalletId) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **getWallet** > GetWallet200Response getWallet() Retrieve basic information about a connected exchange wallet, including a simple dictionary of balances. This endpoint requires authentication via a valid Bluvo API Key, which must be included in the request headers. ### Example ```typescript import { createConfiguration, WalletsApi } from ''; import type { WalletsApiGetWalletRequest } from ''; const configuration = createConfiguration(); const apiInstance = new WalletsApi(configuration); const request: WalletsApiGetWalletRequest = { walletId: "walletId_example", }; const data = await apiInstance.getWallet(request); console.log('API called successfully. Returned data:', data); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **walletId** | [**string**] | | defaults to undefined ### Return type **GetWallet200Response** ### Authorization [bluvoOrgId](README.md#bluvoOrgId), [bluvoApiKey](README.md#bluvoApiKey), [bluvoProjectId](README.md#bluvoProjectId), [bluvoWalletId](README.md#bluvoWalletId) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) # **listWallets** > ListWallets200Response listWallets() Retrieve a paginated list of connected exchange wallets. This endpoint requires authentication via a valid Bluvo API Key, which must be included in the request headers. Supports pagination, filtering, and field selection. ### Example ```typescript import { createConfiguration, WalletsApi } from ''; import type { WalletsApiListWalletsRequest } from ''; const configuration = createConfiguration(); const apiInstance = new WalletsApi(configuration); const request: WalletsApiListWalletsRequest = { // Optional. Page number for pagination (0-indexed). Defaults to 0. (optional) page: 0, // Optional. Maximum number of wallets to return per page. Defaults to 10. Maximum value is 1000. (optional) limit: 1, // Optional. Filter wallets by exchange. (optional) exchange: "ace", // Optional. Filter wallets created on or after this date (ISO format). (optional) createdSince: "createdSince_example", // Optional. Filter wallets created before this date (ISO format). (optional) createdBefore: "createdBefore_example", // Optional. Filter wallets synchronized on or after this date (ISO format). (optional) lastSyncSince: "lastSyncSince_example", // Optional. Filter wallets synchronized before this date (ISO format). (optional) lastSyncBefore: "lastSyncBefore_example", // Optional. Filter wallets by API validity status. (optional) invalidApi: "true", // Optional. Comma-separated list of fields to include in the response. If not specified, all fields are included. (optional) fields: "fields_example", }; const data = await apiInstance.listWallets(request); console.log('API called successfully. Returned data:', data); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | [**number**] | Optional. Page number for pagination (0-indexed). Defaults to 0. | (optional) defaults to undefined **limit** | [**number**] | Optional. Maximum number of wallets to return per page. Defaults to 10. Maximum value is 1000. | (optional) defaults to undefined **exchange** | [**'ace' | 'ascendex' | 'bequant' | 'bigone' | 'binance' | 'coinbase' | 'binanceus' | 'bingx' | 'bit2c' | 'bitbank' | 'bitbns' | 'bitcoincom' | 'bitfinex' | 'bitflyer' | 'bitget' | 'bithumb' | 'bitmart' | 'bitmex' | 'bitopro' | 'bitpanda' | 'bitrue' | 'bitso' | 'bitstamp' | 'bitteam' | 'bitvavo' | 'bl3p' | 'blockchaincom' | 'blofin' | 'btcalpha' | 'btcbox' | 'btcmarkets' | 'btcturk' | 'cex' | 'coincheck' | 'coinex' | 'coinlist' | 'coinmate' | 'coinmetro' | 'coinone' | 'coinsph' | 'coinspot' | 'cryptocom' | 'delta' | 'deribit' | 'digifinex' | 'exmo' | 'fmfwio' | 'gate' | 'gateio' | 'gemini' | 'hashkey' | 'hitbtc' | 'hollaex' | 'htx' | 'huobi' | 'huobijp' | 'hyperliquid' | 'independentreserve' | 'indodax' | 'kraken' | 'krakenfutures' | 'kucoin' | 'kucoinfutures' | 'latoken' | 'lbank' | 'luno' | 'mercado' | 'mexc' | 'ndax' | 'novadax' | 'oceanex' | 'okcoin' | 'okx' | 'onetrading' | 'oxfun' | 'p2b' | 'paradex' | 'paymium' | 'phemex' | 'poloniex' | 'poloniexfutures' | 'probit' | 'timex' | 'tradeogre' | 'upbit' | 'vertex' | 'wavesexchange' | 'whitebit' | 'woo' | 'woofipro' | 'xt' | 'yobit' | 'zaif' | 'zonda'**]**Array<'ace' | 'ascendex' | 'bequant' | 'bigone' | 'binance' | 'coinbase' | 'binanceus' | 'bingx' | 'bit2c' | 'bitbank' | 'bitbns' | 'bitcoincom' | 'bitfinex' | 'bitflyer' | 'bitget' | 'bithumb' | 'bitmart' | 'bitmex' | 'bitopro' | 'bitpanda' | 'bitrue' | 'bitso' | 'bitstamp' | 'bitteam' | 'bitvavo' | 'bl3p' | 'blockchaincom' | 'blofin' | 'btcalpha' | 'btcbox' | 'btcmarkets' | 'btcturk' | 'cex' | 'coincheck' | 'coinex' | 'coinlist' | 'coinmate' | 'coinmetro' | 'coinone' | 'coinsph' | 'coinspot' | 'cryptocom' | 'delta' | 'deribit' | 'digifinex' | 'exmo' | 'fmfwio' | 'gate' | 'gateio' | 'gemini' | 'hashkey' | 'hitbtc' | 'hollaex' | 'htx' | 'huobi' | 'huobijp' | 'hyperliquid' | 'independentreserve' | 'indodax' | 'kraken' | 'krakenfutures' | 'kucoin' | 'kucoinfutures' | 'latoken' | 'lbank' | 'luno' | 'mercado' | 'mexc' | 'ndax' | 'novadax' | 'oceanex' | 'okcoin' | 'okx' | 'onetrading' | 'oxfun' | 'p2b' | 'paradex' | 'paymium' | 'phemex' | 'poloniex' | 'poloniexfutures' | 'probit' | 'timex' | 'tradeogre' | 'upbit' | 'vertex' | 'wavesexchange' | 'whitebit' | 'woo' | 'woofipro' | 'xt' | 'yobit' | 'zaif' | 'zonda'>** | Optional. Filter wallets by exchange. | (optional) defaults to undefined **createdSince** | [**string**] | Optional. Filter wallets created on or after this date (ISO format). | (optional) defaults to undefined **createdBefore** | [**string**] | Optional. Filter wallets created before this date (ISO format). | (optional) defaults to undefined **lastSyncSince** | [**string**] | Optional. Filter wallets synchronized on or after this date (ISO format). | (optional) defaults to undefined **lastSyncBefore** | [**string**] | Optional. Filter wallets synchronized before this date (ISO format). | (optional) defaults to undefined **invalidApi** | [**'true' | 'false'**]**Array<'true' | 'false'>** | Optional. Filter wallets by API validity status. | (optional) defaults to undefined **fields** | [**string**] | Optional. Comma-separated list of fields to include in the response. If not specified, all fields are included. | (optional) defaults to undefined ### Return type **ListWallets200Response** ### Authorization [bluvoOrgId](README.md#bluvoOrgId), [bluvoApiKey](README.md#bluvoApiKey), [bluvoProjectId](README.md#bluvoProjectId) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)