Class CryptoFundingApi
java.lang.Object
markets.alpaca.client.openapi.trading.api.CryptoFundingApi
Generated client for CryptoFundingApi operations.
This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.
Operations
createCryptoTransferForAccount: Request a New WithdrawalcreateWhitelistedAddress: Request a new whitelisted addressdeleteWhitelistedAddress: Delete a whitelisted addressgetCryptoFundingTransfer: Retrieve a Crypto Funding TransfergetCryptoTransferEstimate: Returns the estimated gas fee for a proposed transaction.listCryptoFundingTransfers: Retrieve Crypto Funding TransferslistCryptoFundingWallets: Retrieve Crypto Funding WalletslistWhitelistedAddress: An array of whitelisted addresses
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateCryptoTransferForAccount(CreateCryptoTransferRequest createCryptoTransferRequest) Deprecated.okhttp3.CallcreateCryptoTransferForAccountAsync(CreateCryptoTransferRequest createCryptoTransferRequest, ApiCallback<CryptoTransfer> _callback) Deprecated.okhttp3.CallcreateCryptoTransferForAccountCall(CreateCryptoTransferRequest createCryptoTransferRequest, ApiCallback _callback) Deprecated.createCryptoTransferForAccountWithHttpInfo(CreateCryptoTransferRequest createCryptoTransferRequest) Deprecated.createWhitelistedAddress(CreateWhitelistedAddressRequest createWhitelistedAddressRequest) Request a new whitelisted address Submits a new whitelisted withdrawal address for your account.okhttp3.CallcreateWhitelistedAddressAsync(CreateWhitelistedAddressRequest createWhitelistedAddressRequest, ApiCallback<WhitelistedAddress> _callback) Request a new whitelisted address (asynchronously) Submits a new whitelisted withdrawal address for your account.okhttp3.CallcreateWhitelistedAddressCall(CreateWhitelistedAddressRequest createWhitelistedAddressRequest, ApiCallback _callback) Build call for createWhitelistedAddresscreateWhitelistedAddressWithHttpInfo(CreateWhitelistedAddressRequest createWhitelistedAddressRequest) Request a new whitelisted address Submits a new whitelisted withdrawal address for your account.voiddeleteWhitelistedAddress(String whitelistedAddressId) Delete a whitelisted address Deletes a whitelisted withdrawal address by ID.okhttp3.CalldeleteWhitelistedAddressAsync(String whitelistedAddressId, ApiCallback<Void> _callback) Delete a whitelisted address (asynchronously) Deletes a whitelisted withdrawal address by ID.okhttp3.CalldeleteWhitelistedAddressCall(String whitelistedAddressId, ApiCallback _callback) Build call for deleteWhitelistedAddressdeleteWhitelistedAddressWithHttpInfo(String whitelistedAddressId) Delete a whitelisted address Deletes a whitelisted withdrawal address by ID.getCryptoFundingTransfer(String transferId) Retrieve a Crypto Funding Transfer Returns a specific wallet transfer by passing into the query the transfer_id.okhttp3.CallgetCryptoFundingTransferAsync(String transferId, ApiCallback<CryptoTransfer> _callback) Retrieve a Crypto Funding Transfer (asynchronously) Returns a specific wallet transfer by passing into the query the transfer_id.okhttp3.CallgetCryptoFundingTransferCall(String transferId, ApiCallback _callback) Build call for getCryptoFundingTransfergetCryptoFundingTransferWithHttpInfo(String transferId) Retrieve a Crypto Funding Transfer Returns a specific wallet transfer by passing into the query the transfer_id.getCryptoTransferEstimate(String asset, String fromAddress, String toAddress, String amount) Returns the estimated gas fee for a proposed transaction.okhttp3.CallgetCryptoTransferEstimateAsync(String asset, String fromAddress, String toAddress, String amount, ApiCallback<WalletFeeEstimateResponse> _callback) Returns the estimated gas fee for a proposed transaction.okhttp3.CallgetCryptoTransferEstimateCall(String asset, String fromAddress, String toAddress, String amount, ApiCallback _callback) Build call for getCryptoTransferEstimategetCryptoTransferEstimateWithHttpInfo(String asset, String fromAddress, String toAddress, String amount) Returns the estimated gas fee for a proposed transaction.intRetrieve Crypto Funding Transfers Returns an array of all transfers associated with the given account across all wallets.okhttp3.CalllistCryptoFundingTransfersAsync(ApiCallback<CryptoTransfer> _callback) Retrieve Crypto Funding Transfers (asynchronously) Returns an array of all transfers associated with the given account across all wallets.okhttp3.CalllistCryptoFundingTransfersCall(ApiCallback _callback) Build call for listCryptoFundingTransfersRetrieve Crypto Funding Transfers Returns an array of all transfers associated with the given account across all wallets.listCryptoFundingWallets(String asset, CryptoChain chain, String network) Retrieve Crypto Funding Wallets Lists wallets for the account given in the path parameter.okhttp3.CalllistCryptoFundingWalletsAsync(String asset, CryptoChain chain, String network, ApiCallback<CryptoWallet> _callback) Retrieve Crypto Funding Wallets (asynchronously) Lists wallets for the account given in the path parameter.okhttp3.CalllistCryptoFundingWalletsCall(String asset, CryptoChain chain, String network, ApiCallback _callback) Build call for listCryptoFundingWalletslistCryptoFundingWalletsWithHttpInfo(String asset, CryptoChain chain, String network) Retrieve Crypto Funding Wallets Lists wallets for the account given in the path parameter.An array of whitelisted addresses Returns the list of whitelisted withdrawal addresses for your account.okhttp3.CalllistWhitelistedAddressAsync(ApiCallback<WhitelistedAddress> _callback) An array of whitelisted addresses (asynchronously) Returns the list of whitelisted withdrawal addresses for your account.okhttp3.CalllistWhitelistedAddressCall(ApiCallback _callback) Build call for listWhitelistedAddressAn array of whitelisted addresses Returns the list of whitelisted withdrawal addresses for your account.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
CryptoFundingApi
public CryptoFundingApi() -
CryptoFundingApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
createCryptoTransferForAccountCall
@Deprecated public okhttp3.Call createCryptoTransferForAccountCall(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest, ApiCallback _callback) throws ApiException Deprecated.Build call for createCryptoTransferForAccount- Parameters:
createCryptoTransferRequest- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a transfer. -
-
createCryptoTransferForAccount
@Deprecated public CryptoTransfer createCryptoTransferForAccount(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest) throws ApiException Deprecated.Request a New Withdrawal Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.- Parameters:
createCryptoTransferRequest- (required)- Returns:
- CryptoTransfer
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a transfer. -
-
createCryptoTransferForAccountWithHttpInfo
@Deprecated public ApiResponse<CryptoTransfer> createCryptoTransferForAccountWithHttpInfo(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest) throws ApiException Deprecated.Request a New Withdrawal Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.- Parameters:
createCryptoTransferRequest- (required)- Returns:
- ApiResponse<CryptoTransfer>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a transfer. -
-
createCryptoTransferForAccountAsync
@Deprecated public okhttp3.Call createCryptoTransferForAccountAsync(@Nonnull CreateCryptoTransferRequest createCryptoTransferRequest, ApiCallback<CryptoTransfer> _callback) throws ApiException Deprecated.Request a New Withdrawal (asynchronously) Creates a withdrawal request. Note that outgoing withdrawals must be sent to a whitelisted address and you must whitelist addresses at least 24 hours in advance. If you attempt to withdraw funds to a non-whitelisted address then the transfer will be rejected.- Parameters:
createCryptoTransferRequest- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a transfer. -
-
createWhitelistedAddressCall
public okhttp3.Call createWhitelistedAddressCall(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest, ApiCallback _callback) throws ApiException Build call for createWhitelistedAddress- Parameters:
createWhitelistedAddressRequest- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a whitelisted address -
-
createWhitelistedAddress
public WhitelistedAddress createWhitelistedAddress(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest) throws ApiException Request a new whitelisted address Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain. Where travel rule reporting applies to your account, address details are validated against the travel rule provider before being persisted. Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.- Parameters:
createWhitelistedAddressRequest- (required)- Returns:
- WhitelistedAddress
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a whitelisted address -
-
createWhitelistedAddressWithHttpInfo
public ApiResponse<WhitelistedAddress> createWhitelistedAddressWithHttpInfo(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest) throws ApiException Request a new whitelisted address Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain. Where travel rule reporting applies to your account, address details are validated against the travel rule provider before being persisted. Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.- Parameters:
createWhitelistedAddressRequest- (required)- Returns:
- ApiResponse<WhitelistedAddress>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a whitelisted address -
-
createWhitelistedAddressAsync
public okhttp3.Call createWhitelistedAddressAsync(@Nonnull CreateWhitelistedAddressRequest createWhitelistedAddressRequest, ApiCallback<WhitelistedAddress> _callback) throws ApiException Request a new whitelisted address (asynchronously) Submits a new whitelisted withdrawal address for your account. The chain is derived from the supplied asset symbol and address, and the same address cannot be whitelisted twice on the same chain. Where travel rule reporting applies to your account, address details are validated against the travel rule provider before being persisted. Note that whitelisted addresses must wait at least 24 hours before they can be used as a withdrawal destination.- Parameters:
createWhitelistedAddressRequest- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully requested a whitelisted address -
-
deleteWhitelistedAddressCall
public okhttp3.Call deleteWhitelistedAddressCall(@Nonnull String whitelistedAddressId, ApiCallback _callback) throws ApiException Build call for deleteWhitelistedAddress- Parameters:
whitelistedAddressId- The whitelisted address to delete (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully deleted a whitelisted address -
-
deleteWhitelistedAddress
Delete a whitelisted address Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.- Parameters:
whitelistedAddressId- The whitelisted address to delete (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully deleted a whitelisted address -
-
deleteWhitelistedAddressWithHttpInfo
public ApiResponse<Void> deleteWhitelistedAddressWithHttpInfo(@Nonnull String whitelistedAddressId) throws ApiException Delete a whitelisted address Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.- Parameters:
whitelistedAddressId- The whitelisted address to delete (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully deleted a whitelisted address -
-
deleteWhitelistedAddressAsync
public okhttp3.Call deleteWhitelistedAddressAsync(@Nonnull String whitelistedAddressId, ApiCallback<Void> _callback) throws ApiException Delete a whitelisted address (asynchronously) Deletes a whitelisted withdrawal address by ID. Subsequent withdrawals targeting the deleted address will be rejected.- Parameters:
whitelistedAddressId- The whitelisted address to delete (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Successfully deleted a whitelisted address -
-
getCryptoFundingTransferCall
public okhttp3.Call getCryptoFundingTransferCall(@Nonnull String transferId, ApiCallback _callback) throws ApiException Build call for getCryptoFundingTransfer- Parameters:
transferId- The crypto transfer to retrieve (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single crypto transfer object -
-
getCryptoFundingTransfer
Retrieve a Crypto Funding Transfer Returns a specific wallet transfer by passing into the query the transfer_id.- Parameters:
transferId- The crypto transfer to retrieve (required)- Returns:
- CryptoTransfer
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single crypto transfer object -
-
getCryptoFundingTransferWithHttpInfo
public ApiResponse<CryptoTransfer> getCryptoFundingTransferWithHttpInfo(@Nonnull String transferId) throws ApiException Retrieve a Crypto Funding Transfer Returns a specific wallet transfer by passing into the query the transfer_id.- Parameters:
transferId- The crypto transfer to retrieve (required)- Returns:
- ApiResponse<CryptoTransfer>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single crypto transfer object -
-
getCryptoFundingTransferAsync
public okhttp3.Call getCryptoFundingTransferAsync(@Nonnull String transferId, ApiCallback<CryptoTransfer> _callback) throws ApiException Retrieve a Crypto Funding Transfer (asynchronously) Returns a specific wallet transfer by passing into the query the transfer_id.- Parameters:
transferId- The crypto transfer to retrieve (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single crypto transfer object -
-
getCryptoTransferEstimateCall
public okhttp3.Call getCryptoTransferEstimateCall(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount, ApiCallback _callback) throws ApiException Build call for getCryptoTransferEstimate- Parameters:
asset- The asset for the proposed transaction (optional)fromAddress- The originating address of the proposed transaction (optional)toAddress- The destination address of the proposed transaction (optional)amount- The amount, denoted in the specified asset, of the proposed transaction (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 OK -
-
getCryptoTransferEstimate
public WalletFeeEstimateResponse getCryptoTransferEstimate(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount) throws ApiException Returns the estimated gas fee for a proposed transaction. Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.- Parameters:
asset- The asset for the proposed transaction (optional)fromAddress- The originating address of the proposed transaction (optional)toAddress- The destination address of the proposed transaction (optional)amount- The amount, denoted in the specified asset, of the proposed transaction (optional)- Returns:
- WalletFeeEstimateResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 OK -
-
getCryptoTransferEstimateWithHttpInfo
public ApiResponse<WalletFeeEstimateResponse> getCryptoTransferEstimateWithHttpInfo(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount) throws ApiException Returns the estimated gas fee for a proposed transaction. Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.- Parameters:
asset- The asset for the proposed transaction (optional)fromAddress- The originating address of the proposed transaction (optional)toAddress- The destination address of the proposed transaction (optional)amount- The amount, denoted in the specified asset, of the proposed transaction (optional)- Returns:
- ApiResponse<WalletFeeEstimateResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 OK -
-
getCryptoTransferEstimateAsync
public okhttp3.Call getCryptoTransferEstimateAsync(@Nullable String asset, @Nullable String fromAddress, @Nullable String toAddress, @Nullable String amount, ApiCallback<WalletFeeEstimateResponse> _callback) throws ApiException Returns the estimated gas fee for a proposed transaction. (asynchronously) Returns the estimated on-chain network (gas) fee for a proposed crypto withdrawal at current chain conditions. Pass the `asset`, `from_address`, `to_address`, and `amount` you intend to send; the response reports the network fee that would be charged for the corresponding transaction.- Parameters:
asset- The asset for the proposed transaction (optional)fromAddress- The originating address of the proposed transaction (optional)toAddress- The destination address of the proposed transaction (optional)amount- The amount, denoted in the specified asset, of the proposed transaction (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 OK -
-
listCryptoFundingTransfersCall
Build call for listCryptoFundingTransfers- Parameters:
_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of transfer objects -
-
listCryptoFundingTransfers
Retrieve Crypto Funding Transfers Returns an array of all transfers associated with the given account across all wallets.- Returns:
- CryptoTransfer
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of transfer objects -
-
listCryptoFundingTransfersWithHttpInfo
Retrieve Crypto Funding Transfers Returns an array of all transfers associated with the given account across all wallets.- Returns:
- ApiResponse<CryptoTransfer>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of transfer objects -
-
listCryptoFundingTransfersAsync
public okhttp3.Call listCryptoFundingTransfersAsync(ApiCallback<CryptoTransfer> _callback) throws ApiException Retrieve Crypto Funding Transfers (asynchronously) Returns an array of all transfers associated with the given account across all wallets.- Parameters:
_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of transfer objects -
-
listCryptoFundingWalletsCall
public okhttp3.Call listCryptoFundingWalletsCall(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network, ApiCallback _callback) throws ApiException Build call for listCryptoFundingWallets- Parameters:
asset- Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)chain- Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)network- Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -
-
listCryptoFundingWallets
public CryptoWallet listCryptoFundingWallets(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network) throws ApiException Retrieve Crypto Funding Wallets Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.- Parameters:
asset- Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)chain- Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)network- Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)- Returns:
- CryptoWallet
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -
-
listCryptoFundingWalletsWithHttpInfo
public ApiResponse<CryptoWallet> listCryptoFundingWalletsWithHttpInfo(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network) throws ApiException Retrieve Crypto Funding Wallets Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.- Parameters:
asset- Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)chain- Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)network- Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)- Returns:
- ApiResponse<CryptoWallet>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -
-
listCryptoFundingWalletsAsync
public okhttp3.Call listCryptoFundingWalletsAsync(@Nullable String asset, @Nullable CryptoChain chain, @Nullable String network, ApiCallback<CryptoWallet> _callback) throws ApiException Retrieve Crypto Funding Wallets (asynchronously) Lists wallets for the account given in the path parameter. If an asset is specified and no wallet for the account and asset pair exists one will be created. If no asset is specified only existing wallets will be listed for the account. An account may have at most one wallet per asset.- Parameters:
asset- Filter by crypto asset symbol, e.g. BTC, ETH, USDT. If specified and no wallet exists, one will be created. (optional)chain- Optional chain identifier. Use to request wallets for a specific chain when asset is a multi-chain crypto asset. If not specified, network is considered. (optional)network- Deprecated. Use chain instead. Optional network identifier which is used to request wallets for a specific network when asset is a multi-chain crypto asset. When both 'chain' and 'network' are specified, 'chain' will take precedence and 'network' will be ignored. If 'chain' and 'network' are not specified, the default 'network' (ethereum) will be used. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 A single wallet object if an asset is specified or an array of wallet objects if no asset is specified -
-
listWhitelistedAddressCall
Build call for listWhitelistedAddress- Parameters:
_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of whitelisted objects -
-
listWhitelistedAddress
An array of whitelisted addresses Returns the list of whitelisted withdrawal addresses for your account.- Returns:
- WhitelistedAddress
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of whitelisted objects -
-
listWhitelistedAddressWithHttpInfo
An array of whitelisted addresses Returns the list of whitelisted withdrawal addresses for your account.- Returns:
- ApiResponse<WhitelistedAddress>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of whitelisted objects -
-
listWhitelistedAddressAsync
public okhttp3.Call listWhitelistedAddressAsync(ApiCallback<WhitelistedAddress> _callback) throws ApiException An array of whitelisted addresses (asynchronously) Returns the list of whitelisted withdrawal addresses for your account.- Parameters:
_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 An array of whitelisted objects -
-