bind_api (EXPERIMENTAL)

Description for BIND.

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 2.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://www.bind.com/

Requirements

• Dart 2.12.0 or later OR Flutter 1.26.0 or later
• Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
bind_api: 0.2.1

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
bind_api:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git#ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
bind_api:
path: /path/to/bind_api

Getting Started

Please follow the installation procedure and then run the following:

import'package:bind_api/bind_api.dart';
final api =BindApi().getAuthApi();
try {
final response =await api.whoAmI();
print(response);
} catchonDioError (e) {
print("Exception when calling AuthApi->whoAmI: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.thebind.uk/v1

Class	Method	HTTP request	Description
AuthApi	whoAmI	GET /auth/whoami/	Who am I
BeneficiariesApi	createBeneficiary	POST /beneficiaries/	Add new beneficiary
BeneficiariesApi	deleteBeneficiary	DELETE /beneficiaries/{beneficiary_id}/	Delete beneficiary
BeneficiariesApi	estimateFiatTransfer	POST /fiat/transfer/review/	Preview of fiat transfer
BeneficiariesApi	getBeneficiaries	GET /beneficiaries/	List of beneficiaries of current user
BeneficiariesApi	getBeneficiary	GET /beneficiaries/{beneficiary_id}/	Get beneficiary by id
BeneficiariesApi	performFiatTransfer	POST /fiat/transfer/	Send money to outer bank account
BeneficiariesApi	updateBeneficiary	PATCH /beneficiaries/{beneficiary_id}/	Update beneficiary data
ContactsApi	addContactByUser	POST /contacts/	add user to contact
ContactsApi	checkContact	GET /contacts/{user_id}/check	Check if user_id is in contacts
ContactsApi	createInnerFiatRequest	POST /fiat/request/	Request fiat inside BIND
ContactsApi	createInnerFiatTransfer	POST /fiat/send/	Send fiat inside BIND
ContactsApi	generateQRCodeToken	GET /users/send/qr_code/	Generate JWT token to share as QR code
ContactsApi	getContacts	GET /contacts/	List of contacts of current user
ContactsApi	getInnerFiatTransferFee	POST /fiat/send/fee/
ContactsApi	qRCodeGenerateView	GET /users/generate/qr_code/	Generate QRCode with JWT token and return QRCode image
ContactsApi	readJWTToken	POST /users/send/qr_code/	Check JWT validity and read user from it
ContactsApi	syncContacts	POST /contacts/sync/	Sync mobile phone contacts of current user with backend data
ContactsApi	updateContact	PATCH /contacts/{contact_id}/	Update contact data (add/remove contact from favorite)
CryptoApi	getCryptoChartCandles	GET /charts/crypto/candle/	List of candles for crypto price chart
CryptoApi	getCryptoChartLine	GET /charts/crypto/line/	List line ticks for crypto price chart
CryptoApi	getCryptoOverview	GET /crypto/overview/	Get crypto overview information
CryptoApi	getGlobalCryptoStats	GET /crypto/global/stats/	Get global crypto market information
CryptoApi	getInnerCryptoTransferFee	POST /crypto/send/fee/
CryptoApi	getTokenDetail	GET /crypto/detail/{assetID}/	Get detail for certain token
CryptoApi	getTokenStats	GET /crypto/stats/{assetID}/	Get stats for certain token
CryptoApi	listCryptoCurrencies	GET /currencies/crypto/	List of Crypto Currencies
CryptoApi	performInnerCryptoTransfer	POST /crypto/send/	Send crypto inside BIND
CryptoWalletApi	addCryptoFavorite	POST /crypto/favorites/	Add crypto asset to favorite
CryptoWalletApi	createWithdrawalAddress	POST /crypto/withdrawal/whitelisted_addresses/	Create new whitelisted withdrawal address
CryptoWalletApi	deleteCryptoFavorite	DELETE /crypto/favorites/{asset_id}/	Delete asset from favorites
CryptoWalletApi	deleteWithdrawalAddress	DELETE /crypto/withdrawal/whitelisted_addresses/{address_id}/	Delete withdrawal asset
CryptoWalletApi	estimateCryptoWithdrawalFee	POST /crypto/withdrawal/estimate_fee/	Estimate fee for withdrawal
CryptoWalletApi	getAssetsBreakdown	GET /crypto/breakdown/	Get crypto asset allocation/breakdown of current User
CryptoWalletApi	getChainImplementations	GET /crypto/assets/{asset_id}/chain_implementations/	Get chains for a crypto asset
CryptoWalletApi	getCryptoFavorites	GET /crypto/favorites/	Get user favorite crypto assets
CryptoWalletApi	getCryptoWallet	GET /crypto/wallet/	Get crypto wallet of current User - total balance and assets balances
CryptoWalletApi	getCryptoWalletLight	GET /crypto/wallet/light/	Get crypto assets of current user with balances and prices
CryptoWalletApi	getDepositAddresses	GET /crypto/assets/{asset_id}/deposit_addresses/	Get deposit addresses for a crypto asset
CryptoWalletApi	getProfitLoss	GET /crypto/wallet/profitloss/	Get profit loss
CryptoWalletApi	getProfitLossSummary	GET /crypto/wallet/profitloss/summary/	Get profit loss summary
CryptoWalletApi	getSingleCryptoBalance	GET /crypto/assets/{asset_id}/balance/	Get detailed balance of a crypto asset
CryptoWalletApi	getWithdrawalAddresses	GET /crypto/withdrawal/whitelisted_addresses/	Get whitelisted addresses for crypto withdrawal
CryptoWalletApi	performWithdrawalOfCrypto	POST /crypto/withdrawal/perform/	Register a withdrawal transaction
CurrencyApi	getCryptoAsset	GET /currencies/crypto/{crypto_currency_id}	Crypto currency information with flag favorite or not for user
CurrencyApi	listCryptoCurrencies	GET /currencies/crypto/	List of Crypto Currencies
CurrencyApi	listCurrencies	GET /currencies/	List of Currencies available at Bind
ExchangeApi	cancelLimitOrder	POST /crypto/exchange/limit_orders/{order_id}/cancel	Cancel given limit order
ExchangeApi	estimateCryptoExchange	POST /crypto/exchange/estimate/	Estimate exchange of assets. One of assets has to be a cryptocurrency
ExchangeApi	getCryptoExchangeRate	GET /crypto/exchange/rate/{from}/{to}/	Exchange rate between two given assets (at least one of them is crypto)
ExchangeApi	getExchangeRate	GET /fiat/exchange/rate/{from}/{to}/	Exchange rate between two given currencies
ExchangeApi	getFearGreed	GET /crypto/assets/{asset_id}/fear_greed/	Get fear and greed rates for given asset (results of votes if crypto asset will go up or down)
ExchangeApi	getLimitOrdersList	GET /crypto/exchange/limit_orders	Get list of limit orders for current user
ExchangeApi	performCryptoExchange	POST /crypto/exchange/	Perform exchange of assets. One of assets has to be a cryptocurrency
ExchangeApi	performExchange	POST /fiat/exchange/	Perform exchange operation
ExchangeApi	putLimitOrder	POST /crypto/exchange/limit_orders	Put limit order to the system. Order will be executed later
ExchangeApi	voteFearGreed	PATCH /crypto/assets/{asset_id}/fear_greed/	Vote if this crypto asset goes up or down today
FiatWalletApi	blockBankCard	POST /fiat/bankcards/{card_id}/block/	Block bank card and write reason
FiatWalletApi	changeDefaultWallet	POST /fiat/bankcards/{card_id}/change_wallet/	Change wallet attached to bank card
FiatWalletApi	createFiatWallet	POST /fiat/wallets/	Create an wallet in given currency
FiatWalletApi	getBankCard	GET /fiat/bankcards/{card_id}/	Get one exact Bank Card
FiatWalletApi	getBankCardAnalytics	GET /fiat/bankcards/{card_id}/analytics/	Get analytics for Bank Card
FiatWalletApi	getBankCardsList	GET /fiat/bankcards/	Get a list of Bank Cards issued for current User
FiatWalletApi	getFiatAccount	GET /fiat/account/	All fiat wallets of current user with total balance data
FiatWalletApi	getFiatCurrencies	GET /fiat/currencies/	List of currencies that are available for fiat account opening
FiatWalletApi	getFiatCurrenciesWithRates	GET /fiat/currencies/rate/	List of currencies that are available for fiat account opening with rates for given currency
FiatWalletApi	getFiatWalletDetails	GET /fiat/wallets/{wallet_id}/	Wallet's details
FiatWalletApi	getFiatWallets	GET /fiat/wallets/	All fiat wallets of current user
FiatWalletApi	getFiatWalletsWithUserPaymentCurrency	GET /fiat/wallets/detailed/	All fiat wallets of current user with user payment currency info
FiatWalletApi	lockBankCard	POST /fiat/bankcards/{card_id}/lock/	Lock or unlock a bank card
FiatWalletApi	reissueBankCard	POST /fiat/bankcards/{card_id}/reissue/	Reissue bank card and return new bank card
FiatWalletApi	shareDefaultFiatWallet	GET /fiat/wallets/share/	Get share information for user default wallet
FiatWalletApi	shareFiatWallet	GET /fiat/wallets/{wallet_id}/share/	Share specified wallet details
FiatWalletApi	updateBankCardSettings	PATCH /fiat/bankcards/{card_id}/	Update settings of a Bank Card
GeoApi	listCountries	GET /countries/	Countries list
StagingApi	adjustFiatWalletBalance	POST /staging/fiat/wallet/adjust/	Change balance of a fiat wallet
StagingApi	fillCryptoWallet	POST /staging/crypto/wallet/fill/	Put some testnet assets in a crypto wallet of a current user
StagingApi	fireblocksPoolBalances	GET /staging/fireblocks_pool/balances/	Get pool balances
StakingApi	getAdditionalStaking	GET /crypto/staking/additional_info	Get info of additional staking
StakingApi	getStaking	GET /crypto/staking	Get info of staking
StakingApi	getStakingBalance	GET /crypto/staking/balance	Get staking balance
StakingApi	getStakingPeriods	GET /crypto/staking/periods	Get staking periods
StakingApi	getStakingReleases	GET /crypto/staking/releases	Get staking releases
StakingApi	getStakingTimer	GET /crypto/staking/timer	Get datetime of end timer
StakingApi	stakingEstimateOperation	POST /crypto/staking/estimate	Estimate staking operation
StakingApi	stakingPerform	POST /crypto/staking/perform	Perform staking
TransactionsApi	exportTransactions	POST /transactions/export/	Export user transaction to csv
TransactionsApi	getExportHistory	GET /transactions/export/history/	Get export history
TransactionsApi	getTransactionDetails	GET /transactions/{transactionId}	Get list of user transactions
TransactionsApi	getTransactionsAssetsList	POST /transactions/assets/	Get list of assets of user transactions
TransactionsApi	getTransactionsFiltered	POST /transactions/	Get list of user transactions
UserApi	checkKYCDocumentStatus	POST /user/kyc/document_status/	Check KYC document status
UserApi	checkKYCFileStatus	POST /user/kyc/check_file/	Check KYC file status
UserApi	checkKYCRequestApproval	GET /users/kyc/requests/approval/	Get status of KYC Request approval
UserApi	checkKYCStatus	POST /user/kyc/check/	Send KYC to check
UserApi	checkPasscode	POST /users/check/passcode/	Check validity of user passcode
UserApi	createKYCFile	POST /user/kyc/file/	CreateKYCFile
UserApi	createKYCFile_0	GET /user/kyc/create_file/	Create KYC file
UserApi	createKYCRequest	POST /user/kyc/requests/	Create KYC Request
UserApi	getKYCDocumentUID	GET /user/kyc/document_uid/	Get KYC Document UID
UserApi	getKYCFile	GET /user/kyc/file/	GetKYCFile
UserApi	getUserPaymentCurrency	GET /users/payment_currency/	Get user payment currency
UserApi	moveKYCRequest	POST /users/kyc/requests/approval/	Move KYCRequest to approval
UserApi	qRCodeGenerateCustomString	POST /users/generate/custom_qr_code/	Generate QR code with custom string
UserApi	updateUser	PATCH /users/{userID}/	Update user
UserApi	updateUserPasscode	PATCH /users/change_passcode/{userID}/	Update user passcode
WalletApi	getMainWallet	GET /wallet/	Total balance and info about Users wallets in crypto, fiat and nft

Documentation For Models

• AddContactByUserRequest
• AdjustFiatWalletBalanceRequest
• AnalysisStatus
• BankCardAnalytics
• BankCardBaseData
• BankCardBlockingReason
• BankCardChangeWalletRequest
• BankCardDetail
• BankCardDetailAllOf
• BankCardLockRequest
• BankCardSettings
• BankCardStatus
• Beneficiary
• BeneficiaryDetail
• CancelLimitOrderRequest
• Candle
• ChainImplementation
• ChartTick
• CheckKYCDocumentStatus200Response
• CheckKYCFileStatus200Response
• CheckKYCStatusRequest
• CheckPasscodeRequest
• Contact
• Country
• CreateBeneficiaryRequest
• CreateFiatWalletRequest
• CreateInnerFiatRequestRequest
• CreateInnerFiatTransferRequest
• CreateKYCFile200Response
• CryptoAccount
• CryptoAccountAllOf
• CryptoAccountLight
• CryptoAccountWithShare
• CryptoAccountWithShareAllOf
• CryptoAsset
• CryptoAssetFavorite
• CryptoAssetFavoriteAllOf
• CryptoAssetSorting
• CryptoExchangeEstimationResult
• CryptoExchangeRequest
• CryptoMarketStats
• CryptoOverviewElement
• CryptoWallet
• CryptoWalletAllOf
• CryptoWalletBalance
• CryptoWalletWithShare
• CryptoWalletWithShareAllOf
• CryptoWithdrawalFeeEstimationRequest
• CryptoWithdrawalFeeEstimationResult
• CryptoWithdrawalRequest
• Currency
• CurrencyWithRate
• CurrencyWithRateAllOf
• DepositAddress
• Error
• ExportHistory
• FavoriteCryptoCreateRequest
• FearGreed
• FiatAccount
• FiatTransferEstimate
• FiatWallet
• FiatWalletAllOf
• FiatWalletLight
• FiatWalletRequisites
• FiatWalletTotalBalance
• FiatWalletWithPaymentCurrency
• FiatWalletWithPaymentCurrencyAllOf
• GetInnerCryptoTransferFeeRequest
• GetInnerFiatTransferFeeRequest
• GetKYCDocumentUID200Response
• GetStakingTimer200Response
• HumanTransactionTypes
• InnerCryptoTransferFeeResult
• InnerFiatTransferFeeResult
• JWTToken
• KYCDocumentStatus
• KYCDocumentStatusRequest
• KYCFieldStatus
• KYCFile
• KYCFileId
• KYCFileStatus
• KYCRequestMoveResult
• KYCRequestMoveResultRequestFieldsStatus
• KYCRequestStatus
• LimitOrder
• MainWalletItem
• MainWalletType
• PerformExchangeRequest
• PerformFiatTransferRequest
• PeriodInterval
• ProfitLoss
• ProfitLossSort
• ProfitLossSummary
• PutLimitOrderRequest
• QRCodeGenerateCustomStringRequest
• SingleCryptoBalance
• Staking
• StakingAdditionalInformation
• StakingBalance
• StakingEstimate
• StakingInformation
• StakingPerformRequest
• StakingPeriods
• StakingReleases
• SyncContactsRequest
• TokenDetail
• TokenStats
• Transaction
• TransactionAssetsFilter
• TransactionDescriptionFillingRuleSet
• TransactionDetail
• TransactionExportFilter
• TransactionFilter
• TransactionGroup
• TransactionGrouping
• TransactionStates
• TransactionTypes
• UpdateBeneficiaryRequest
• UpdateContactRequest
• UpdateUserPasscodeRequest
• User
• UserPaymentCurrency
• UserSharingData
• VoteFearGreedRequest
• WalletBalanceInfo
• WithdrawalAddress
• WithdrawalAddressCreationRequest

Documentation For Authorization

bearerAuth

• Type: HTTP basic authentication

Author

support@bind.com