OBJECT

User

link GraphQL Schema definition

  • type User {
  • # User's first name
  • firstName: String
  • # User's last name
  • lastName: String
  • # User's email
  • email: String
  • # Organisation details
  • organisation: Organisation!
  • # Get the portfolio summary for the user - startDate, endDate (ISO 8601 UTC time)
  • #
  • # Arguments
  • # startDate:
  • # endDate:
  • # timePeriod:
  • portfolio(startDate: String, endDate: String, timePeriod: TimePeriod): PortfolioConnection!
  • # Get the portfolio summary broken down by assets for each subWallet a user has in
  • # csv string format - startDate / endDate is ISO 8601 UTC timestamp, currency
  • # defaults to GBP
  • # NOTE: currently only supports ONE_MONTH_DAILY timePeriod. Could fail to get the
  • # most recent time point if the endDate timestamp is within the first 30 minutes
  • # of the current hour
  • #
  • # Arguments
  • # endDate:
  • # timePeriod:
  • # currency:
  • csvPortfolio(
  • endDate: String!,
  • timePeriod: TimePeriod!,
  • currency: String
  • ): PortfolioCsv!
  • # ONLY the wallet details (name, address etc...) and Transactions is supported.
  • #
  • # Arguments
  • # walletId: Pick the wallet by walletId
  • wallet(walletId: String!): Wallet
  • # Fast query for a single subWallet
  • # ONLY the subWallet details (name, address etc...) and Transactions is supported.
  • #
  • # Arguments
  • # subWalletId:
  • subWallet(subWalletId: String!): SubWallet
  • # Get the users wallets with balance. A Wallet can be thought of as a BIP32 HD
  • # wallet
  • # NOTE: pagination is not implemented yet - limit and nextToken are currently
  • # ignored
  • # Has API key support
  • #
  • # Arguments
  • # walletId: Optional parameter to get the wallet for the given
  • # wallet id
  • # walletType: Optional parameter to get the wallets matching the
  • # given WalletType
  • # currency: Defaults to GBP
  • # searchName: Optional parameter to get the subWallets matching
  • # the given searchName
  • # limit: Pagination limit
  • # nextToken: Pagination next token
  • wallets(
  • walletId: String,
  • walletType: WalletType,
  • currency: String,
  • searchName: String,
  • limit: Int,
  • nextToken: String
  • ): WalletConnection!
  • # Arguments
  • # subWalletId: Optional parameter to get the subWallet for the
  • # given subWalletId
  • # walletType: Optional parameter to get the subWallets matching
  • # the given WalletType
  • # currency: Defaults to GBP
  • # searchName: Optional parameter to get the subWallets matching
  • # the given searchName
  • # limit: Pagination limit
  • # nextToken: Pagination next token
  • subWallets(
  • subWalletId: String,
  • walletType: WalletType,
  • currency: String,
  • searchName: String,
  • limit: Int,
  • nextToken: String
  • ): SubWalletConnection!
  • # Get Wallets along with associated subwallet summaries
  • # NOTE: pagination is not implemented yet - limit and nextToken are currently
  • # ignored
  • #
  • # Arguments
  • # includeDeleted: optional parameter to include deleted Wallets
  • # includePolicy: optional parameter to include each Wallet's
  • # policy
  • # limit: pagination limit
  • # nextToken: pagination next token
  • walletsInfo(
  • includeDeleted: Boolean,
  • includePolicy: Boolean,
  • limit: Int,
  • nextToken: String
  • ): WalletsInfoConnection!
  • # Users transactions in csv string, optionally can pass asset and walletId (see
  • # supported-assets docs for available assetSymbols)
  • #
  • # Arguments
  • # walletId:
  • # assetSymbols:
  • # toDate:
  • # fromDate:
  • # count:
  • getCsvTransactions(
  • walletId: String,
  • assetSymbols: [String],
  • toDate: String,
  • fromDate: String!,
  • count: Int
  • ): TransactionCsv @deprecated( reason: "use requestCsvTransactions mutation" )
  • # Users transactions in csv string, csv will be sent to a registered email,
  • # optionally can pass asset and subWalletId
  • #
  • # Arguments
  • # assetSymbols:
  • # toDate:
  • # fromDate:
  • # count:
  • requestCsvTransactions(
  • assetSymbols: [String],
  • toDate: String,
  • fromDate: String!,
  • count: Int
  • ): RequestTransactionsCsv @deprecated( reason: "use requestCsvTransactions mutation" )
  • # Users addressbook information
  • addressBook: AddressBookConnection
  • # Arguments
  • # limit: Optional parameter to set number of results per page,
  • # max 50
  • # nextToken: pagination next token
  • transactions(limit: Int, nextToken: String): GenericTransactionConnection!
  • # Arguments
  • # id:
  • transaction(id: String!): GenericTransaction
  • }

link Require by