Link

Account models

Here you can get information about each field in our Account API

Account

field type additional info
accountId String unique account identifier
organizationId Optional<String> unique organization identifier that includes this account
reportingCurrency Currency currency code used for reports
accountName String account name
createdBy String account creator user ID
createdAt Long time of account creation
updatedAt Optional<Long> time of latest account update
updatedBy Optional<String> user ID that made last account update

Portfolio

field type additional info
portfolioId String unique portfolio identifier
accountId String unique account identifier
portfolioName String portfolio name
portfolioType PortfolioType portfolio type
createdBy String portfolio creator user ID
updatedBy Optional<String> user ID that made last portfolio update
createdAt Long time of portfolio creation
updatedAt Optional<Long> time of latest portfolio update
isActive Boolean Boolean flag shows active status for portfolio (archived or not)
organizationId Optional<String> unique organization identifier that includes this portfolio
extra PortfolioExtra additional portfolio data

PortfolioType

Enum with possible values (may be changed in future):

  • custody
  • trading
  • external

PortfolioExtra

field type additional info
exchange Optional<Exchange> external portfolio exchange
exchangeWalletType Optional<ExchangeWalletType> external portfolio exchange type
tradingKeys Optional<Map<String, ExternalTradingKey>> trading keys for external portfolio
viewKeys Optional<Map<String, ExternalViewKey>> view only keys for external portfolio
bitstampId Optional<String> for Bitstamp external account
parentPortfolioId Optional<String> if external account depends on other external account
deribitAccountId Optional<String> for Deribit external account
huobiAccountId Optional<String> for Huobi external account
usdWithdrawalLimit Optional<BigDecimal>  
baseCurrency Optional<Currency> for external account that use margin pair
quoteCurrency Optional<Currency> for external account that use margin pair
showWalletBalance Optional<BalanceType> what type of balance to show for external account
externalAccountId Optional<String> third-party identifier

Exchange

Enum with possible values (may be changed in future):

  • binance
  • bitfinex
  • bitmex
  • bitstamp
  • kraken
  • okex
  • huobi
  • bittrex
  • coinbase
  • coinbase-prime
  • deribit
  • hitbtc

ExchangeWalletType

Enum with possible values (may be changed in future):

  • exchange
  • margin
  • funding
  • spot
  • futures
  • account
  • subaccount
  • trading
  • swap
  • contract
  • subcontract

ExternalTradingKey

field type additional info
tradingKey String public part of trading key

ExternalViewKey

field type additional info
viewKey String public part of view only key

BalanceType

Enum with possible values (may be changed in future):

  • real
  • margin

Wallet

field type additional info
walletId String unique wallet identifier
portfolioId String unique portfolio identifier that includes this wallet
currency Currency wallet currency
mainCurrency Optional<Currency> for Vault: Currency of main blockchain (e.g. For USDT, it could be either ETH or BTC)
balance BigDecimal current total balance
reserve BigDecimal reserved balance
createdBy String wallet creator user ID
updatedBy Optional<String> user ID that made last wallet update
createdAt Long time of wallet creation
updatedAt Optional<Long> time of latest wallet update
extra WalletExtra additional wallet data
accountId String unique account identifier that includes this wallet
organizationId Optional<String> unique organization identifier that includes this wallet
_embedded Optional<WalletEmbedded> additional wallet info (deposit targets)

WalletExtra

field type additional info
extendedPublicKey Optional<String> vault extended public key
externalAccountId Optional<String> third-party identifier

WalletEmbedded

field type additional info
depositTargets List<DepositTarget>  

DepositTarget

field type additional info
targetType String may be crypto or bank-account
mainCurrency Optional<Currency> Currency of main blockchain (e.g. may be BTC or ETH for USDT currency)
address Optional<String> blockchain address
destinationTag Optional<Long> address destination tag
memo Optional<String> address memo
accountName Optional<String> bank account details
recipientAddress Optional<String> bank account details
iban Optional<String> bank account details
swiftCode Optional<String> bank account details
aba Optional<String> bank account details
bankName Optional<String> bank account details
bankAddress Optional<String> bank account details
accountNumber Optional<String> bank account details
referenceNumber Optional<String> bank account details
billingAddress Optional<String> bank account details
sortCode Optional<String> bank account details

BankAccounts

field type additional info
bankAccounts List<BankAccount>  

BankAccount

field type additional info
bankAccountId String unique bank account identifier
bankAccountType BankAccountType type
accountId String unique account identifier
organizationId Optional<String> unique organization identifier
bankAccountName Optional<String> bank account name
beneficiaryAccountName Optional<String> bank account details
beneficiaryAccountAddress Optional<String> bank account details
beneficiaryAccountPostalCode Optional<String> bank account details
beneficiaryAccountCity Optional<String> bank account details
beneficiaryAccountCountry Optional<String> bank account details
iban Optional<String> bank account details
swift Optional<String> bank account details
bankName Optional<String> bank account details
bankAddress Optional<String> bank account details
bankPostalCode Optional<String> bank account details
bankCity Optional<String> bank account details
bankCountry Optional<String> bank account details
lastUsedAt Optional<Long> time of last usage for bank account
createdBy String bank account creator user ID
updatedBy Optional<String> user ID that made last bank account update
createdAt Long time of bank account creation
updatedAt Optional<Long> time of latest bank account update
coinbasePaymentReference Optional<String> Coinbase bank account id for this bank account
senId Optional<String> Silvergate Network Id for this bank account
senDescription Optional<String> Silvergate Network description for this bank account
comment Optional<String> Additional comments for this bank account

BankAccountType

Enum with possible values (may be changed in future):

  • sepa
  • international

CryptoAddresses

field type additional info
cryptoAddresses List<CryptoAddress>  

CryptoAddress

field type additional info
cryptoAddressId String unique crypto address identifier
accountId String unique account identifier
organizationId Optional<String> unique organization identifier
currency Currency crypto address currency
mainCurrency Optional<Currency Currency of main blockchain (e.g. may be BTC or ETH for USDT currency)
name String crypto address name
address String  
destinationTag Optional<Long> destination tag for XRP address
memo Optional<String> additional identifier for address
lastUsedAt Optional<Long> time of last usage for crypto address
createdBy String crypto address creator user ID
updatedBy Optional<String> user ID that made last crypto address update
createdAt Long time of crypto address creation
updatedAt Optional<Long> time of latest crypto address update