Skip to main content

User

No description

type User {
securityTokens: UserSecureTokens
firstName: String
lastName: String
email: String
organisation: Organisation!
portfolio(
startDate: String
endDate: String
timePeriod: TimePeriod
): PortfolioConnection!
csvPortfolio(
endDate: String!
timePeriod: TimePeriod!
currency: String
): PortfolioCsv!
contractManagement: ContractManagementConnection
subWallet(
subWalletId: String!
): SubWallet
subWallets(
subWalletId: String
walletType: WalletType
currency: String
limit: Int
nextToken: String
searchName: String
): SubWalletConnection!
walletsInfo(
includeDeleted: Boolean
includePolicy: Boolean
limit: Int
nextToken: String
): WalletsInfoConnection!
addressBook: AddressBookConnection
transactions(
limit: Int
nextToken: String
): GenericTransactionConnection!
transaction(
id: String!
): GenericTransaction
}

Fields

User.securityTokens ● UserSecureTokens object

User's secure tokens

User.firstName ● String scalar

User's first name

User.lastName ● String scalar

User's last name

User.email ● String scalar

User's email

User.organisation ● Organisation! non-null object

Organisation details

User.portfolio ● PortfolioConnection! non-null object

Get the portfolio summary for the user - startDate / endDate is ISO 8601 UTC timestamp

User.portfolio.startDate ● String scalar
User.portfolio.endDate ● String scalar
User.portfolio.timePeriod ● TimePeriod enum

User.csvPortfolio ● PortfolioCsv! non-null object

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 and could fail to get the most recent time point if the endDate timestamp is within the last 30 minutes of the current hour

User.csvPortfolio.endDate ● String! non-null scalar
User.csvPortfolio.timePeriod ● TimePeriod! non-null enum
User.csvPortfolio.currency ● String scalar

User.contractManagement ● ContractManagementConnection object

ONLY the subWallet details (name, address etc...) and Transactions is supported.

User.subWallet ● SubWallet interface

User.subWallet.subWalletId ● String! non-null scalar

User.subWallets ● SubWalletConnection! non-null object

User.subWallets.subWalletId ● String scalar

optional parameter to get the subWallet for the given subWalletId

User.subWallets.walletType ● WalletType deprecated enum
DEPRECATED

new wallets are all type UNIVERSAL

optional parameter to get the wallets matching the given WalletType

User.subWallets.currency ● String scalar

defaults to GBP

User.subWallets.limit ● Int scalar

pagination limit

User.subWallets.nextToken ● String scalar

pagination next token

User.subWallets.searchName ● String scalar

optional parameter to get the wallets matching the given searchName

User.walletsInfo ● WalletsInfoConnection! non-null object

Get Wallets along with associated subwallet summaries NOTE: pagination is not implemented yet - limit and nextToken are currently ignored

User.walletsInfo.includeDeleted ● Boolean scalar

optional parameter to include deleted Wallets

User.walletsInfo.includePolicy ● Boolean scalar

optional parameter to include each Wallet's policy

User.walletsInfo.limit ● Int scalar

pagination limit

User.walletsInfo.nextToken ● String scalar

pagination next token

User.addressBook ● AddressBookConnection object

User.transactions ● GenericTransactionConnection! non-null object

User.transactions.limit ● Int scalar

Optional parameter to set number of results per page, max 50

User.transactions.nextToken ● String scalar

pagination next token

User.transaction ● GenericTransaction object

User.transaction.id ● String! non-null scalar

Returned By

user query