eccuity API Reference

Full GraphQL API reference for eccuity, generated from the live schema: every operation, argument, and return type. Secured with OAuth 2.0, see eccuity.com/developers for authentication, scopes, and getting started.

API Endpoints
https://api.<your-eccuity-domain>/graphql

Queries

fetchAccountAgreements

Description

Requires scope: funding.read.

Response

Returns [AccountAgreementInfo!]!

Arguments
Name Description
params - FetchAccountAgreementsInput!

Example

Query
query fetchAccountAgreements($params: FetchAccountAgreementsInput!) {
  fetchAccountAgreements(params: $params) {
    agreement
    revision
    signedAt
  }
}
Variables
{"params": FetchAccountAgreementsInput}
Response
{
  "data": {
    "fetchAccountAgreements": [
      {
        "agreement": "abc123",
        "revision": "abc123",
        "signedAt": "abc123"
      }
    ]
  }
}
Queries

fetchActiveStrategy

Description

Requires scope: portfolio.read.

Response

Returns an ActiveStrategy!

Arguments
Name Description
id - ID!

Example

Query
query fetchActiveStrategy($id: ID!) {
  fetchActiveStrategy(id: $id) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "fetchActiveStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": 4,
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": true,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "xyz789",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "xyz789",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Queries

fetchAllActiveStrategies

Description

Requires scope: portfolio.read.

Response

Returns [ActiveStrategy!]!

Arguments
Name Description
params - FetchActiveStrategyInput!

Example

Query
query fetchAllActiveStrategies($params: FetchActiveStrategyInput!) {
  fetchAllActiveStrategies(params: $params) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"params": FetchActiveStrategyInput}
Response
{
  "data": {
    "fetchAllActiveStrategies": [
      {
        "assets": [ActiveStrategyAsset],
        "brokerAccountId": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "dailyPL": Decimal,
        "dailyPLPercentage": Decimal,
        "history": [ActiveStrategyHistory],
        "id": 4,
        "initialInvestmentAmount": Decimal,
        "initialInvestmentOrders": [Order],
        "initialInvestmentPortionType": "AMOUNT",
        "isRebalanceOn": true,
        "isScheduledContributionOn": false,
        "manualContributions": [ManualContribution],
        "name": "xyz789",
        "performance": [StrategyPerformance],
        "rebalanceFrequency": "ANNUALLY",
        "rebalances": [Rebalance],
        "scheduledContributionAmount": Decimal,
        "scheduledContributionFrequency": "FORTNIGHT_START",
        "scheduledContributionPortionType": "AMOUNT",
        "scheduledContributions": [ScheduledContribution],
        "sourceStrategyId": "abc123",
        "status": "ACTIVE",
        "subscribedStrategyHistory": StrategyHistory,
        "subscribedStrategyHistoryId": "abc123",
        "totalInvestment": Decimal,
        "totalPL": Decimal,
        "totalPLPercentage": Decimal,
        "totalValue": Decimal
      }
    ]
  }
}
Queries

fetchAnnouncement

Description

Requires scope: public.

Response

Returns a String

Example

Query
query fetchAnnouncement {
  fetchAnnouncement
}
Response
{"data": {"fetchAnnouncement": "xyz789"}}
Queries

fetchAssetByAssetId

Description

Requires scope: public.

Response

Returns an Asset

Arguments
Name Description
params - FetchAssetByAssetIdInput!

Example

Query
query fetchAssetByAssetId($params: FetchAssetByAssetIdInput!) {
  fetchAssetByAssetId(params: $params) {
    ... on Crypto {
      ...CryptoFragment
    }
    ... on ETF {
      ...ETFFragment
    }
    ... on Stock {
      ...StockFragment
    }
  }
}
Variables
{"params": FetchAssetByAssetIdInput}
Response
{"data": {"fetchAssetByAssetId": Crypto}}
Queries

fetchAssetByTicker

Description

Requires scope: public.

Response

Returns an Asset

Arguments
Name Description
ticker - String!

Example

Query
query fetchAssetByTicker($ticker: String!) {
  fetchAssetByTicker(ticker: $ticker) {
    ... on Crypto {
      ...CryptoFragment
    }
    ... on ETF {
      ...ETFFragment
    }
    ... on Stock {
      ...StockFragment
    }
  }
}
Variables
{"ticker": "xyz789"}
Response
{"data": {"fetchAssetByTicker": Crypto}}
Queries

fetchAssetPerformance

Description

Requires scope: public.

Response

Returns [StrategyPerformance!]!

Arguments
Name Description
assetId - ID!

Example

Query
query fetchAssetPerformance($assetId: ID!) {
  fetchAssetPerformance(assetId: $assetId) {
    date
    value
  }
}
Variables
{"assetId": "4"}
Response
{
  "data": {
    "fetchAssetPerformance": [
      {
        "date": "2007-12-03T10:15:30Z",
        "value": Decimal
      }
    ]
  }
}
Queries

fetchAssetsByAssetIds

Description

Requires scope: public.

Response

Returns [Asset!]!

Arguments
Name Description
params - FetchAssetsByAssetIdsInput!

Example

Query
query fetchAssetsByAssetIds($params: FetchAssetsByAssetIdsInput!) {
  fetchAssetsByAssetIds(params: $params) {
    ... on Crypto {
      ...CryptoFragment
    }
    ... on ETF {
      ...ETFFragment
    }
    ... on Stock {
      ...StockFragment
    }
  }
}
Variables
{"params": FetchAssetsByAssetIdsInput}
Response
{"data": {"fetchAssetsByAssetIds": [Crypto]}}
Queries

fetchAssetsByTickers

Description

Requires scope: public.

Response

Returns [Asset!]!

Arguments
Name Description
params - FetchAssetsByTickersInput!

Example

Query
query fetchAssetsByTickers($params: FetchAssetsByTickersInput!) {
  fetchAssetsByTickers(params: $params) {
    ... on Crypto {
      ...CryptoFragment
    }
    ... on ETF {
      ...ETFFragment
    }
    ... on Stock {
      ...StockFragment
    }
  }
}
Variables
{"params": FetchAssetsByTickersInput}
Response
{"data": {"fetchAssetsByTickers": [Crypto]}}
Queries

fetchAssistantThreadById

Description

Requires scope: profile.read.

Response

Returns an AssistantThread!

Arguments
Name Description
params - FetchAssistantThreadByIdInput!

Example

Query
query fetchAssistantThreadById($params: FetchAssistantThreadByIdInput!) {
  fetchAssistantThreadById(params: $params) {
    author {
      ...AuthorFragment
    }
    createdAt
    id
    messages {
      ...AssistantMessageFragment
    }
    name
    privacy
  }
}
Variables
{"params": FetchAssistantThreadByIdInput}
Response
{
  "data": {
    "fetchAssistantThreadById": {
      "author": Author,
      "createdAt": GemDate,
      "id": 4,
      "messages": [AssistantMessage],
      "name": "abc123",
      "privacy": "PRIVATE"
    }
  }
}
Queries

fetchAvailableRates

Description

Requires scope: public.

Response

Returns [AprTiers!]!

Arguments
Name Description
params - InterestRatesInput!

Example

Query
query fetchAvailableRates($params: InterestRatesInput!) {
  fetchAvailableRates(params: $params) {
    account_rate_bps
    name
  }
}
Variables
{"params": InterestRatesInput}
Response
{
  "data": {
    "fetchAvailableRates": [
      {
        "account_rate_bps": Decimal,
        "name": "xyz789"
      }
    ]
  }
}
Queries

fetchCryptoCurrencyTransfers

Description

Requires scope: funding.read.

Response

Returns [CryptoTransfer!]!

Arguments
Name Description
params - FetchCryptoTransfersInput!

Example

Query
query fetchCryptoCurrencyTransfers($params: FetchCryptoTransfersInput!) {
  fetchCryptoCurrencyTransfers(params: $params) {
    amount
    asset
    chain
    created_at
    direction
    fees
    from_address
    id
    network_fee
    status
    to_address
    tx_hash
    usd_value
  }
}
Variables
{"params": FetchCryptoTransfersInput}
Response
{
  "data": {
    "fetchCryptoCurrencyTransfers": [
      {
        "amount": "xyz789",
        "asset": "abc123",
        "chain": "abc123",
        "created_at": "abc123",
        "direction": "abc123",
        "fees": "xyz789",
        "from_address": "abc123",
        "id": "xyz789",
        "network_fee": "abc123",
        "status": "xyz789",
        "to_address": "xyz789",
        "tx_hash": "abc123",
        "usd_value": "abc123"
      }
    ]
  }
}
Queries

fetchCryptoCurrencyWallets

Description

Requires scope: funding.read.

Response

Returns [CryptoWallet!]

Arguments
Name Description
params - FetchCryptoWalletsInput!

Example

Query
query fetchCryptoCurrencyWallets($params: FetchCryptoWalletsInput!) {
  fetchCryptoCurrencyWallets(params: $params) {
    address
    amount
    assetName
    pendingWithdrawalAmount
    value
  }
}
Variables
{"params": FetchCryptoWalletsInput}
Response
{
  "data": {
    "fetchCryptoCurrencyWallets": [
      {
        "address": "abc123",
        "amount": Decimal,
        "assetName": "abc123",
        "pendingWithdrawalAmount": Decimal,
        "value": Decimal
      }
    ]
  }
}
Queries

fetchCryptoWalletAddress

Description

Requires scope: funding.read.

Response

Returns a CryptoWalletAddress!

Arguments
Name Description
params - FetchCryptoWalletAddressInput!

Example

Query
query fetchCryptoWalletAddress($params: FetchCryptoWalletAddressInput!) {
  fetchCryptoWalletAddress(params: $params) {
    address
    assetName
    network
  }
}
Variables
{"params": FetchCryptoWalletAddressInput}
Response
{
  "data": {
    "fetchCryptoWalletAddress": {
      "address": "xyz789",
      "assetName": "xyz789",
      "network": "abc123"
    }
  }
}
Queries

fetchCurrentRates

Description

Requires scope: funding.read.

Response

Returns [CashInterests!]!

Arguments
Name Description
params - CurrentRateInput!

Example

Query
query fetchCurrentRates($params: CurrentRateInput!) {
  fetchCurrentRates(params: $params) {
    apr_tier_name
    currency
    status
    userId
  }
}
Variables
{"params": CurrentRateInput}
Response
{
  "data": {
    "fetchCurrentRates": [
      {
        "apr_tier_name": "xyz789",
        "currency": "abc123",
        "status": "abc123",
        "userId": "abc123"
      }
    ]
  }
}
Queries

fetchCurrentUser

Description

Requires scope: identity.

Response

Returns a User

Example

Query
query fetchCurrentUser {
  fetchCurrentUser {
    antiPhishingCode
    chartStartAtZero
    country
    createdAt
    cryptoSpreadFee
    depositWithdrawalFee
    eccuityInvestStatus
    email
    featureFlags
    firstName
    freeTradeCredit
    id
    interestRate
    interestRateStatus
    lastName
    maxActiveStrategies
    maxMonthlyAIMessages
    maxMonthlyAIThreads
    maxMonthlyStrategyCreation
    maxMonthlyStrategyViews
    maxStrategySubscriptions
    maxTradingFees
    mfaEnabled
    mfaQrCodeEnabled
    name
    netWorthAsHomePage
    oAuthLinks {
      ...OAuthLinkFragment
    }
    phoneNumber
    strategySubscriptions
    tradingFees
    usedActiveStrategies
    usedMonthlyAIMessages
    usedMonthlyAIThreads
    usedMonthlyStrategyCreation
    usedMonthlyStrategyViews
    usedStrategySubscriptions
    username
  }
}
Response
{
  "data": {
    "fetchCurrentUser": {
      "antiPhishingCode": "abc123",
      "chartStartAtZero": true,
      "country": "abc123",
      "createdAt": GemDate,
      "cryptoSpreadFee": Decimal,
      "depositWithdrawalFee": Decimal,
      "eccuityInvestStatus": "ACCOUNT_CLOSED",
      "email": "xyz789",
      "featureFlags": ["ADMIN"],
      "firstName": "xyz789",
      "freeTradeCredit": Decimal,
      "id": 4,
      "interestRate": Decimal,
      "interestRateStatus": "xyz789",
      "lastName": "xyz789",
      "maxActiveStrategies": 987,
      "maxMonthlyAIMessages": 987,
      "maxMonthlyAIThreads": 123,
      "maxMonthlyStrategyCreation": 123,
      "maxMonthlyStrategyViews": 987,
      "maxStrategySubscriptions": 123,
      "maxTradingFees": Decimal,
      "mfaEnabled": false,
      "mfaQrCodeEnabled": false,
      "name": "abc123",
      "netWorthAsHomePage": false,
      "oAuthLinks": [OAuthLink],
      "phoneNumber": "abc123",
      "strategySubscriptions": ["abc123"],
      "tradingFees": Decimal,
      "usedActiveStrategies": 123,
      "usedMonthlyAIMessages": 123,
      "usedMonthlyAIThreads": 987,
      "usedMonthlyStrategyCreation": 123,
      "usedMonthlyStrategyViews": 123,
      "usedStrategySubscriptions": 123,
      "username": "abc123"
    }
  }
}
Queries

fetchDefaultPaymentProvider

Description

Requires scope: funding.read.

Response

Returns a PaymentProviderGQL!

Example

Query
query fetchDefaultPaymentProvider {
  fetchDefaultPaymentProvider
}
Response
{"data": {"fetchDefaultPaymentProvider": "EBURY"}}
Queries

fetchDiscoverLists

Description

Requires scope: portfolio.read.

Response

Returns [DiscoverList!]!

Example

Query
query fetchDiscoverLists {
  fetchDiscoverLists {
    createdAt
    description
    hexColor
    id
    imageUrl
    link
    title
    updatedAt
  }
}
Response
{
  "data": {
    "fetchDiscoverLists": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "description": "xyz789",
        "hexColor": "xyz789",
        "id": 4,
        "imageUrl": "abc123",
        "link": "xyz789",
        "title": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

fetchEccuityInvestAccountActivities

Description

Requires scope: profile.read.

Response

Returns [AccountActivity]!

Arguments
Name Description
params - AccountActivitiesInput!

Example

Query
query fetchEccuityInvestAccountActivities($params: AccountActivitiesInput!) {
  fetchEccuityInvestAccountActivities(params: $params) {
    ... on AccountNonTradeActivity {
      ...AccountNonTradeActivityFragment
    }
    ... on AccountTradeActivity {
      ...AccountTradeActivityFragment
    }
  }
}
Variables
{"params": AccountActivitiesInput}
Response
{
  "data": {
    "fetchEccuityInvestAccountActivities": [
      AccountNonTradeActivity
    ]
  }
}
Queries

fetchEccuityInvestAccountBalances

Description

Requires scope: portfolio.read.

Response

Returns an AccountBalances!

Arguments
Name Description
params - AccountTradingConfigurationFetchInput!

Example

Query
query fetchEccuityInvestAccountBalances($params: AccountTradingConfigurationFetchInput!) {
  fetchEccuityInvestAccountBalances(params: $params) {
    cash
    cryptoPositionValue
    dayTradeCount
    dayTradingBuyingPower
    effectiveBuyingPower
    equitiesPositionValue
    equity
    excessMargin
    initialMargin
    lastCash
    lastDayTradeCount
    lastDayTradingBuyingPower
    lastEffectiveBuyingPower
    lastEquity
    lastExcessMargin
    lastInitialMargin
    lastLongMarketValue
    lastMaintenanceMargin
    lastNonMarginableBuyingPower
    lastRegtBuyingPower
    lastShortMarketValue
    longMarketValue
    maintenanceMargin
    nonMarginableBuyingPower
    regtBuyingPower
    shortMarketValue
  }
}
Variables
{"params": AccountTradingConfigurationFetchInput}
Response
{
  "data": {
    "fetchEccuityInvestAccountBalances": {
      "cash": Decimal,
      "cryptoPositionValue": Decimal,
      "dayTradeCount": 123,
      "dayTradingBuyingPower": Decimal,
      "effectiveBuyingPower": Decimal,
      "equitiesPositionValue": Decimal,
      "equity": Decimal,
      "excessMargin": Decimal,
      "initialMargin": Decimal,
      "lastCash": Decimal,
      "lastDayTradeCount": 987,
      "lastDayTradingBuyingPower": Decimal,
      "lastEffectiveBuyingPower": Decimal,
      "lastEquity": Decimal,
      "lastExcessMargin": Decimal,
      "lastInitialMargin": Decimal,
      "lastLongMarketValue": Decimal,
      "lastMaintenanceMargin": Decimal,
      "lastNonMarginableBuyingPower": Decimal,
      "lastRegtBuyingPower": Decimal,
      "lastShortMarketValue": Decimal,
      "longMarketValue": Decimal,
      "maintenanceMargin": Decimal,
      "nonMarginableBuyingPower": Decimal,
      "regtBuyingPower": Decimal,
      "shortMarketValue": Decimal
    }
  }
}
Queries

fetchEccuityInvestAccountConfig

Description

Requires scope: profile.read.

Response

Returns an AccountTradingConfiguration!

Arguments
Name Description
params - AccountTradingConfigurationFetchInput!

Example

Query
query fetchEccuityInvestAccountConfig($params: AccountTradingConfigurationFetchInput!) {
  fetchEccuityInvestAccountConfig(params: $params) {
    autoReinvestDividends
    dtbpCheck
    fractionalTrading
    maxMarginMultiplier
    noShorting
    pdtCheck
    tradeConfirmEmail
    tradeSuspendedByUser
  }
}
Variables
{"params": AccountTradingConfigurationFetchInput}
Response
{
  "data": {
    "fetchEccuityInvestAccountConfig": {
      "autoReinvestDividends": false,
      "dtbpCheck": "xyz789",
      "fractionalTrading": true,
      "maxMarginMultiplier": 123,
      "noShorting": false,
      "pdtCheck": "xyz789",
      "tradeConfirmEmail": false,
      "tradeSuspendedByUser": false
    }
  }
}
Queries

fetchEccuityInvestAccountDocumentById

Description

Requires scope: profile.read.

Response

Returns a String!

Arguments
Name Description
params - AccountDocumentByIdInput!

Example

Query
query fetchEccuityInvestAccountDocumentById($params: AccountDocumentByIdInput!) {
  fetchEccuityInvestAccountDocumentById(params: $params)
}
Variables
{"params": AccountDocumentByIdInput}
Response
{
  "data": {
    "fetchEccuityInvestAccountDocumentById": "xyz789"
  }
}
Queries

fetchEccuityInvestAccountDocuments

Description

Requires scope: profile.read.

Response

Returns [AccountDocument]!

Arguments
Name Description
params - AccountTradingConfigurationFetchInput!

Example

Query
query fetchEccuityInvestAccountDocuments($params: AccountTradingConfigurationFetchInput!) {
  fetchEccuityInvestAccountDocuments(params: $params) {
    date
    id
    name
    sub_type
    type
  }
}
Variables
{"params": AccountTradingConfigurationFetchInput}
Response
{
  "data": {
    "fetchEccuityInvestAccountDocuments": [
      {
        "date": "abc123",
        "id": "4",
        "name": "abc123",
        "sub_type": "xyz789",
        "type": "xyz789"
      }
    ]
  }
}
Queries

fetchExperts

Description

Requires scope: public.

Response

Returns [ExpertObject!]!

Example

Query
query fetchExperts {
  fetchExperts {
    bio
    categories
    id
    imageAlt
    imageUrl
    isDraft
    lastUpdated
    meetingLink
    name
    slug
    title
  }
}
Response
{
  "data": {
    "fetchExperts": [
      {
        "bio": "xyz789",
        "categories": ["abc123"],
        "id": "4",
        "imageAlt": "abc123",
        "imageUrl": "abc123",
        "isDraft": false,
        "lastUpdated": "abc123",
        "meetingLink": "abc123",
        "name": "xyz789",
        "slug": "xyz789",
        "title": "abc123"
      }
    ]
  }
}
Queries

fetchInvestorPreferences

Description

Requires scope: profile.read.

Response

Returns an InvestorPreferences

Example

Query
query fetchInvestorPreferences {
  fetchInvestorPreferences {
    assetClasses
    assistantContactFrequency
    createdAt
    generatedAssetLists {
      ...GeneratedAssetListFragment
    }
    id
    investingObjectives
    investingStyle
    likeableAssets {
      ...LikeableAssetFragment
    }
    user {
      ...UserFragment
    }
  }
}
Response
{
  "data": {
    "fetchInvestorPreferences": {
      "assetClasses": ["xyz789"],
      "assistantContactFrequency": "DAILY",
      "createdAt": GemDate,
      "generatedAssetLists": [GeneratedAssetList],
      "id": "4",
      "investingObjectives": ["xyz789"],
      "investingStyle": "xyz789",
      "likeableAssets": [LikeableAsset],
      "user": User
    }
  }
}
Queries

fetchKYC

Description

Requires scope: profile.read.

Response

Returns a KYC

Example

Query
query fetchKYC {
  fetchKYC {
    companySetup {
      ...CompanySetupFragment
    }
    createdAt
    eccuityInvestStatus
    id
    kycAgreements {
      ...UserKYCAgreementFragment
    }
    kycContact {
      ...UserKYCContactInformationFragment
    }
    kycDisclosures {
      ...UserKYCDisclosuresFragment
    }
    kycFileUploads {
      ... on UserKYCUploadedFileDocument {
        ...UserKYCUploadedFileDocumentFragment
      }
      ... on UserKYCUploadedW8BENFormDocument {
        ...UserKYCUploadedW8BENFormDocumentFragment
      }
    }
    kycIdentity {
      ...UserKYCIdentityInformationFragment
    }
    kycRequirements {
      ...UserKYCRequirementsFragment
    }
    kycTrustedContact {
      ...UserKYCTrustedContactFragment
    }
    kycW8BENForm {
      ...UserKYCUploadedW8BENFormDocumentFragment
    }
    onfidoStatus
  }
}
Response
{
  "data": {
    "fetchKYC": {
      "companySetup": CompanySetup,
      "createdAt": GemDate,
      "eccuityInvestStatus": "ACCOUNT_CLOSED",
      "id": "4",
      "kycAgreements": [UserKYCAgreement],
      "kycContact": UserKYCContactInformation,
      "kycDisclosures": UserKYCDisclosures,
      "kycFileUploads": [UserKYCUploadedFileDocument],
      "kycIdentity": UserKYCIdentityInformation,
      "kycRequirements": UserKYCRequirements,
      "kycTrustedContact": UserKYCTrustedContact,
      "kycW8BENForm": UserKYCUploadedW8BENFormDocument,
      "onfidoStatus": "xyz789"
    }
  }
}
Queries

fetchMarketHours

Description

Requires scope: public.

Response

Returns a MarketHours

Arguments
Name Description
exchangeCode - String

Example

Query
query fetchMarketHours($exchangeCode: String) {
  fetchMarketHours(exchangeCode: $exchangeCode) {
    currentStatus
    currentStatusLabel
    exchangeCode
    exchangeName
    id
    nextPreMarketTime
    remainingTime
    sessions {
      ...MarketSessionFragment
    }
    timezone
    tradingWindows {
      ...ExchangeTradingWindowFragment
    }
    upcomingHolidays {
      ...ExchangeHolidayFragment
    }
  }
}
Variables
{"exchangeCode": "xyz789"}
Response
{
  "data": {
    "fetchMarketHours": {
      "currentStatus": "AFTER_HOURS",
      "currentStatusLabel": "xyz789",
      "exchangeCode": "xyz789",
      "exchangeName": "abc123",
      "id": "4",
      "nextPreMarketTime": "2007-12-03T10:15:30Z",
      "remainingTime": "abc123",
      "sessions": [MarketSession],
      "timezone": "xyz789",
      "tradingWindows": [ExchangeTradingWindow],
      "upcomingHolidays": [ExchangeHoliday]
    }
  }
}
Queries

fetchMyAssistantThreads

Description

Fetch all assistant threads owned by the current user. Requires scope: profile.read.

Response

Returns [AssistantThread!]!

Example

Query
query fetchMyAssistantThreads {
  fetchMyAssistantThreads {
    author {
      ...AuthorFragment
    }
    createdAt
    id
    messages {
      ...AssistantMessageFragment
    }
    name
    privacy
  }
}
Response
{
  "data": {
    "fetchMyAssistantThreads": [
      {
        "author": Author,
        "createdAt": GemDate,
        "id": "4",
        "messages": [AssistantMessage],
        "name": "abc123",
        "privacy": "PRIVATE"
      }
    ]
  }
}
Queries

fetchMyDeviceTokens

Description

Requires scope: profile.read.

Response

Returns [DeviceToken!]!

Example

Query
query fetchMyDeviceTokens {
  fetchMyDeviceTokens {
    createdAt
    id
    lastUsedAt
    platform
    userAgent
  }
}
Response
{
  "data": {
    "fetchMyDeviceTokens": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "id": "4",
        "lastUsedAt": "2007-12-03T10:15:30Z",
        "platform": "ANDROID_FCM",
        "userAgent": "xyz789"
      }
    ]
  }
}
Queries

fetchMyPasskeys

Description

Requires scope: profile.read.

Response

Returns [Passkey!]!

Example

Query
query fetchMyPasskeys {
  fetchMyPasskeys {
    backedUp
    createdAt
    deviceType
    id
    lastUsedAt
    name
  }
}
Response
{
  "data": {
    "fetchMyPasskeys": [
      {
        "backedUp": false,
        "createdAt": "2007-12-03T10:15:30Z",
        "deviceType": "xyz789",
        "id": "4",
        "lastUsedAt": "2007-12-03T10:15:30Z",
        "name": "abc123"
      }
    ]
  }
}
Queries

fetchNewsByAssetIds

Description

Requires scope: public.

Response

Returns a NewsResponse!

Arguments
Name Description
params - FetchNewsByAssetIdsInput!

Example

Query
query fetchNewsByAssetIds($params: FetchNewsByAssetIdsInput!) {
  fetchNewsByAssetIds(params: $params) {
    articles {
      ...NewsArticleFragment
    }
    totalCount
  }
}
Variables
{"params": FetchNewsByAssetIdsInput}
Response
{
  "data": {
    "fetchNewsByAssetIds": {
      "articles": [NewsArticle],
      "totalCount": 987
    }
  }
}
Queries

fetchPendingUserTransactions

Description

Requires scope: funding.read.

Response

Returns [PendingUserTransaction!]!

Example

Query
query fetchPendingUserTransactions {
  fetchPendingUserTransactions {
    amountDeposited
    createdAt
    currency
    estimatedExchangeRate
    id
    reference
    transactionType
    user {
      ...UserFragment
    }
  }
}
Response
{
  "data": {
    "fetchPendingUserTransactions": [
      {
        "amountDeposited": Decimal,
        "createdAt": GemDate,
        "currency": "AUD",
        "estimatedExchangeRate": Decimal,
        "id": "4",
        "reference": "xyz789",
        "transactionType": "DEPOSIT",
        "user": User
      }
    ]
  }
}
Queries

fetchSavedBankAccount

Description

Requires scope: funding.read.

Response

Returns a WiseRecipient

Example

Query
query fetchSavedBankAccount {
  fetchSavedBankAccount {
    createdAt
    currency
    id
    user {
      ...UserFragment
    }
    userProvidedName
    wiseRecipientId
  }
}
Response
{
  "data": {
    "fetchSavedBankAccount": {
      "createdAt": GemDate,
      "currency": "AUD",
      "id": 4,
      "user": User,
      "userProvidedName": "abc123",
      "wiseRecipientId": "abc123"
    }
  }
}
Queries

fetchSavedPayoutAccount

Description

Requires scope: funding.read.

Response

Returns a PayoutRecipient

Arguments
Name Description
provider - PaymentProviderSelection

Example

Query
query fetchSavedPayoutAccount($provider: PaymentProviderSelection) {
  fetchSavedPayoutAccount(provider: $provider) {
    currency
    externalRecipientId
    id
    lastError
    migrationStatus
    provider
    providerAccountId
    userProvidedName
  }
}
Variables
{"provider": "EBURY"}
Response
{
  "data": {
    "fetchSavedPayoutAccount": {
      "currency": "AUD",
      "externalRecipientId": "xyz789",
      "id": "abc123",
      "lastError": "abc123",
      "migrationStatus": "xyz789",
      "provider": "EBURY",
      "providerAccountId": "xyz789",
      "userProvidedName": "abc123"
    }
  }
}
Queries

fetchStrategies

Description

Requires scope: public.

Response

Returns a StrategyWithTotal!

Arguments
Name Description
params - FetchStrategyInput!

Example

Query
query fetchStrategies($params: FetchStrategyInput!) {
  fetchStrategies(params: $params) {
    strategies {
      ...StrategyFragment
    }
    total
  }
}
Variables
{"params": FetchStrategyInput}
Response
{
  "data": {
    "fetchStrategies": {
      "strategies": [Strategy],
      "total": 123
    }
  }
}
Queries

fetchStrategy

Description

Requires scope: public.

Response

Returns a Strategy!

Arguments
Name Description
id - ID!

Example

Query
query fetchStrategy($id: ID!) {
  fetchStrategy(id: $id) {
    author {
      ...AuthorFragment
    }
    calculatedDays
    calculatedIRR
    calculatedReturn
    category
    createdAt
    description
    expectedYield
    history {
      ...StrategyHistoryFragment
    }
    historyCount
    id
    imageURL
    isVotingEnabled
    latestPerformance
    logoURL
    name
    oneMonthReturn
    performance {
      ...StrategyPerformanceFragment
    }
    periodReturns {
      ...StrategyPeriodReturnFragment
    }
    privacy
    subscriberCount
    targetWeights {
      ...StrategyAssetWeightFragment
    }
    topHolding {
      ...StrategyAssetWeightFragment
    }
    type
    videoLink
    votes {
      ...StrategyAssetVoteFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "fetchStrategy": {
      "author": Author,
      "calculatedDays": 987,
      "calculatedIRR": Decimal,
      "calculatedReturn": Decimal,
      "category": "ACTIVIST",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "expectedYield": Decimal,
      "history": [StrategyHistory],
      "historyCount": 987,
      "id": 4,
      "imageURL": "xyz789",
      "isVotingEnabled": false,
      "latestPerformance": Decimal,
      "logoURL": "abc123",
      "name": "xyz789",
      "oneMonthReturn": Decimal,
      "performance": [StrategyPerformance],
      "periodReturns": [StrategyPeriodReturn],
      "privacy": "PRIVATE",
      "subscriberCount": 987,
      "targetWeights": [StrategyAssetWeight],
      "topHolding": StrategyAssetWeight,
      "type": "COMMUNITY",
      "videoLink": "xyz789",
      "votes": [StrategyAssetVote]
    }
  }
}
Queries

fetchUserAppointments

Description

Requires scope: profile.read.

Response

Returns [AppointmentObject!]!

Example

Query
query fetchUserAppointments {
  fetchUserAppointments {
    address
    contactEmail
    contactName
    contactPhone
    endTime
    id
    notes
    startTime
    status
    title
  }
}
Response
{
  "data": {
    "fetchUserAppointments": [
      {
        "address": "abc123",
        "contactEmail": "xyz789",
        "contactName": "abc123",
        "contactPhone": "xyz789",
        "endTime": "abc123",
        "id": 4,
        "notes": "xyz789",
        "startTime": "xyz789",
        "status": "xyz789",
        "title": "abc123"
      }
    ]
  }
}
Queries

fetchUserDeposits

Description

Requires scope: funding.read.

Response

Returns [Deposit!]!

Example

Query
query fetchUserDeposits {
  fetchUserDeposits {
    NZDAmount
    NZDEburyFee
    NZDEccuityFee
    NZDFinalAmount
    NZDWiseFee
    USDAmount
    USDEburyFee
    USDEccuityFee
    USDFinalAmount
    USDWiseFee
    alpacaJournalCompletedAt
    alpacaJournalId
    alpacaJournalInitiatedAt
    createdAt
    cryptoAutoSweepId
    date
    hasSweepBuyOrder
    id
    lastViewedAt
    reference
    senderAccount
    senderName
    status
    updatedAt
    userEmail
    userName
    wiseReceivedAt
  }
}
Response
{
  "data": {
    "fetchUserDeposits": [
      {
        "NZDAmount": Decimal,
        "NZDEburyFee": Decimal,
        "NZDEccuityFee": Decimal,
        "NZDFinalAmount": Decimal,
        "NZDWiseFee": Decimal,
        "USDAmount": Decimal,
        "USDEburyFee": Decimal,
        "USDEccuityFee": Decimal,
        "USDFinalAmount": Decimal,
        "USDWiseFee": Decimal,
        "alpacaJournalCompletedAt": "2007-12-03T10:15:30Z",
        "alpacaJournalId": "xyz789",
        "alpacaJournalInitiatedAt": "2007-12-03T10:15:30Z",
        "createdAt": "2007-12-03T10:15:30Z",
        "cryptoAutoSweepId": "abc123",
        "date": "2007-12-03T10:15:30Z",
        "hasSweepBuyOrder": true,
        "id": "4",
        "lastViewedAt": "2007-12-03T10:15:30Z",
        "reference": "xyz789",
        "senderAccount": "abc123",
        "senderName": "abc123",
        "status": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "userEmail": "abc123",
        "userName": "abc123",
        "wiseReceivedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

fetchUserLikes

Description

Requires scope: profile.read.

Response

Returns [Like!]!

Example

Query
query fetchUserLikes {
  fetchUserLikes {
    ... on AssetLike {
      ...AssetLikeFragment
    }
    ... on AssistantThreadLike {
      ...AssistantThreadLikeFragment
    }
  }
}
Response
{"data": {"fetchUserLikes": [AssetLike]}}
Queries

fetchWhitelistedWallets

Description

Requires scope: funding.read.

Response

Returns [WhitelistedWallet!]!

Arguments
Name Description
params - FetchWhitelistedWalletsInput!

Example

Query
query fetchWhitelistedWallets($params: FetchWhitelistedWalletsInput!) {
  fetchWhitelistedWallets(params: $params) {
    address
    alias
    asset
    chain
    id
    status
    travelRuleInfo {
      ...WhitelistedWalletTravelRuleInfoFragment
    }
  }
}
Variables
{"params": FetchWhitelistedWalletsInput}
Response
{
  "data": {
    "fetchWhitelistedWallets": [
      {
        "address": "xyz789",
        "alias": "abc123",
        "asset": "abc123",
        "chain": "abc123",
        "id": "abc123",
        "status": "xyz789",
        "travelRuleInfo": WhitelistedWalletTravelRuleInfo
      }
    ]
  }
}
Queries

getAllTradeIdeas

Description

Requires scope: portfolio.read.

Response

Returns [TradeIdea!]!

Example

Query
query getAllTradeIdeas {
  getAllTradeIdeas {
    actualCloseDate
    actualOpenDate
    content
    convictionLevel
    createdAt
    daysToClose
    daysToOpen
    description
    direction
    displayOrder
    estimatedCloseDate
    estimatedOpenDate
    hasOpenTrades
    id
    isProfitable
    returnPercentage
    title
    totalProfitLoss
    tradesClosed
    updatedAt
  }
}
Response
{
  "data": {
    "getAllTradeIdeas": [
      {
        "actualCloseDate": "2007-12-03T10:15:30Z",
        "actualOpenDate": "2007-12-03T10:15:30Z",
        "content": "abc123",
        "convictionLevel": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "daysToClose": 987,
        "daysToOpen": 123,
        "description": "abc123",
        "direction": "abc123",
        "displayOrder": 987,
        "estimatedCloseDate": "2007-12-03T10:15:30Z",
        "estimatedOpenDate": "2007-12-03T10:15:30Z",
        "hasOpenTrades": true,
        "id": "abc123",
        "isProfitable": false,
        "returnPercentage": Decimal,
        "title": "xyz789",
        "totalProfitLoss": Decimal,
        "tradesClosed": false,
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

getAvailableBrokerIntegrations

Description

Requires scope: public.

Response

Returns [BrokerIntegration!]!

Example

Query
query getAvailableBrokerIntegrations {
  getAvailableBrokerIntegrations {
    description
    firstParty
    name
    oauthUrl
    type
  }
}
Response
{
  "data": {
    "getAvailableBrokerIntegrations": [
      {
        "description": "abc123",
        "firstParty": true,
        "name": "xyz789",
        "oauthUrl": "xyz789",
        "type": "xyz789"
      }
    ]
  }
}
Queries

getAvailableCountries

Description

Requires scope: public.

Response

Returns [AvailableCountry!]!

Example

Query
query getAvailableCountries {
  getAvailableCountries {
    alpha2code
    alpha3code
    name
  }
}
Response
{
  "data": {
    "getAvailableCountries": [
      {
        "alpha2code": "abc123",
        "alpha3code": "xyz789",
        "name": "xyz789"
      }
    ]
  }
}
Queries

getAvailableSharesToAttach

Description

Requires scope: portfolio.read.

Response

Returns an AvailableSharesToAttach!

Arguments
Name Description
activeStrategyId - ID!
assetId - ID!

Example

Query
query getAvailableSharesToAttach(
  $activeStrategyId: ID!,
  $assetId: ID!
) {
  getAvailableSharesToAttach(
    activeStrategyId: $activeStrategyId,
    assetId: $assetId
  ) {
    availableShares
    totalAttachedShares
    totalBrokerShares
  }
}
Variables
{"activeStrategyId": 4, "assetId": 4}
Response
{
  "data": {
    "getAvailableSharesToAttach": {
      "availableShares": Decimal,
      "totalAttachedShares": Decimal,
      "totalBrokerShares": Decimal
    }
  }
}
Queries

getBankDetail

Description

Requires scope: funding.read.

Response

Returns a WiseBankAccountDetail!

Arguments
Name Description
currency - Currency!
provider - PaymentProviderGQL

Example

Query
query getBankDetail(
  $currency: Currency!,
  $provider: PaymentProviderGQL
) {
  getBankDetail(
    currency: $currency,
    provider: $provider
  ) {
    active
    currencyCode
    currencyName
    details {
      ...WiseBankAccountDetailListFragment
    }
    id
  }
}
Variables
{"currency": "AUD", "provider": "EBURY"}
Response
{
  "data": {
    "getBankDetail": {
      "active": true,
      "currencyCode": "AUD",
      "currencyName": "abc123",
      "details": [WiseBankAccountDetailList],
      "id": 123
    }
  }
}
Queries

getBrokerAccounts

Description

Requires scope: portfolio.read.

Response

Returns a BrokerAccountList!

Arguments
Name Description
params - BrokerAccountInput!

Example

Query
query getBrokerAccounts($params: BrokerAccountInput!) {
  getBrokerAccounts(params: $params) {
    brokers {
      ...BrokerCredentialWithAccountFragment
    }
    buyingPower
    cash {
      ...MoneyFragment
    }
    eccuityInvestRequiresAttention
    equity
    nonMarginableBuyingPower
  }
}
Variables
{"params": BrokerAccountInput}
Response
{
  "data": {
    "getBrokerAccounts": {
      "brokers": [BrokerCredentialWithAccount],
      "buyingPower": Decimal,
      "cash": [Money],
      "eccuityInvestRequiresAttention": "abc123",
      "equity": Decimal,
      "nonMarginableBuyingPower": Decimal
    }
  }
}
Queries

getClosedTradeIdeas

Description

Requires scope: portfolio.read.

Response

Returns [TradeIdea!]!

Example

Query
query getClosedTradeIdeas {
  getClosedTradeIdeas {
    actualCloseDate
    actualOpenDate
    content
    convictionLevel
    createdAt
    daysToClose
    daysToOpen
    description
    direction
    displayOrder
    estimatedCloseDate
    estimatedOpenDate
    hasOpenTrades
    id
    isProfitable
    returnPercentage
    title
    totalProfitLoss
    tradesClosed
    updatedAt
  }
}
Response
{
  "data": {
    "getClosedTradeIdeas": [
      {
        "actualCloseDate": "2007-12-03T10:15:30Z",
        "actualOpenDate": "2007-12-03T10:15:30Z",
        "content": "abc123",
        "convictionLevel": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "daysToClose": 987,
        "daysToOpen": 123,
        "description": "xyz789",
        "direction": "abc123",
        "displayOrder": 987,
        "estimatedCloseDate": "2007-12-03T10:15:30Z",
        "estimatedOpenDate": "2007-12-03T10:15:30Z",
        "hasOpenTrades": true,
        "id": "xyz789",
        "isProfitable": false,
        "returnPercentage": Decimal,
        "title": "abc123",
        "totalProfitLoss": Decimal,
        "tradesClosed": true,
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

getCryptoAutoSweeps

Description

Requires scope: funding.read.

Response

Returns [CryptoAutoSweepResponse!]!

Arguments
Name Description
asset - String

Example

Query
query getCryptoAutoSweeps($asset: String) {
  getCryptoAutoSweeps(asset: $asset) {
    asset
    id
    reference
    status
    whitelistedWalletId
  }
}
Variables
{"asset": "abc123"}
Response
{
  "data": {
    "getCryptoAutoSweeps": [
      {
        "asset": "xyz789",
        "id": 4,
        "reference": "xyz789",
        "status": "xyz789",
        "whitelistedWalletId": "xyz789"
      }
    ]
  }
}
Queries

getCurrentStockPrice

Description

Requires scope: public.

Response

Returns a Decimal

Arguments
Name Description
root - String!

Example

Query
query getCurrentStockPrice($root: String!) {
  getCurrentStockPrice(root: $root)
}
Variables
{"root": "abc123"}
Response
{"data": {"getCurrentStockPrice": Decimal}}
Queries

getDefaultLiabilityPortfolio

Description

Requires scope: portfolio.read.

Response

Returns a Portfolio!

Example

Query
query getDefaultLiabilityPortfolio {
  getDefaultLiabilityPortfolio {
    code
    metaData {
      ...PortfolioMetaDataFragment
    }
    name
    parentPortfolioCode
  }
}
Response
{
  "data": {
    "getDefaultLiabilityPortfolio": {
      "code": "abc123",
      "metaData": [PortfolioMetaData],
      "name": "xyz789",
      "parentPortfolioCode": "abc123"
    }
  }
}
Queries

getDefaultPortfolio

Description

Requires scope: portfolio.read.

Response

Returns a Portfolio!

Example

Query
query getDefaultPortfolio {
  getDefaultPortfolio {
    code
    metaData {
      ...PortfolioMetaDataFragment
    }
    name
    parentPortfolioCode
  }
}
Response
{
  "data": {
    "getDefaultPortfolio": {
      "code": "xyz789",
      "metaData": [PortfolioMetaData],
      "name": "abc123",
      "parentPortfolioCode": "abc123"
    }
  }
}
Queries

getDepositsAndWithdrawalsChart

Description

Requires scope: portfolio.read.

Response

Returns a CashflowChartData!

Arguments
Name Description
params - GetDepositsAndWithdrawalsInput!

Example

Query
query getDepositsAndWithdrawalsChart($params: GetDepositsAndWithdrawalsInput!) {
  getDepositsAndWithdrawalsChart(params: $params) {
    deposits {
      ...CashflowChartRecordFragment
    }
    withdrawals {
      ...CashflowChartRecordFragment
    }
  }
}
Variables
{"params": GetDepositsAndWithdrawalsInput}
Response
{
  "data": {
    "getDepositsAndWithdrawalsChart": {
      "deposits": [CashflowChartRecord],
      "withdrawals": [CashflowChartRecord]
    }
  }
}
Queries

getExpirationDates

Description

Requires scope: public.

Response

Returns [String!]!

Arguments
Name Description
root - String!

Example

Query
query getExpirationDates($root: String!) {
  getExpirationDates(root: $root)
}
Variables
{"root": "xyz789"}
Response
{"data": {"getExpirationDates": ["xyz789"]}}
Queries

getInstrumentPrices

Description

Requires scope: portfolio.read.

Response

Returns [WealthrelayInstrumentPrice!]!

Arguments
Name Description
symbol - String!

Example

Query
query getInstrumentPrices($symbol: String!) {
  getInstrumentPrices(symbol: $symbol) {
    close
    currency
    date
    high
    low
    open
  }
}
Variables
{"symbol": "abc123"}
Response
{
  "data": {
    "getInstrumentPrices": [
      {
        "close": Decimal,
        "currency": "xyz789",
        "date": "xyz789",
        "high": Decimal,
        "low": Decimal,
        "open": Decimal
      }
    ]
  }
}
Queries

getMyForexFeeRate

Description

Returns the FX fee rate you'd pay on a deposit or withdrawal (0.005 = 0.5%). Requires scope: funding.read.

Response

Returns a Decimal!

Example

Query
query getMyForexFeeRate {
  getMyForexFeeRate
}
Response
{"data": {"getMyForexFeeRate": Decimal}}
Queries

getNewsletterStatus

Description

Requires scope: profile.read.

Response

Returns a Boolean!

Example

Query
query getNewsletterStatus {
  getNewsletterStatus
}
Response
{"data": {"getNewsletterStatus": false}}
Queries

getOnfidoToken

Description

Requires scope: profile.read.

Response

Returns a String!

Example

Query
query getOnfidoToken {
  getOnfidoToken
}
Response
{"data": {"getOnfidoToken": "abc123"}}
Queries

getOptionChain

Description

Requires scope: public.

Response

Returns [OptionContract!]!

Arguments
Name Description
params - OptionChainInput!

Example

Query
query getOptionChain($params: OptionChainInput!) {
  getOptionChain(params: $params) {
    contractSymbol
    expiration
    right
    root
    strike
  }
}
Variables
{"params": OptionChainInput}
Response
{
  "data": {
    "getOptionChain": [
      {
        "contractSymbol": "abc123",
        "expiration": "xyz789",
        "right": "abc123",
        "root": "abc123",
        "strike": Decimal
      }
    ]
  }
}
Queries

getOptionHistoricalData

Description

Requires scope: public.

Response

Returns [OptionHistoricalDataPoint!]!

Arguments
Name Description
params - OptionHistoricalDataInput!

Example

Query
query getOptionHistoricalData($params: OptionHistoricalDataInput!) {
  getOptionHistoricalData(params: $params) {
    askPrice
    bidPrice
    close
    date
    high
    low
    open
    volume
  }
}
Variables
{"params": OptionHistoricalDataInput}
Response
{
  "data": {
    "getOptionHistoricalData": [
      {
        "askPrice": Decimal,
        "bidPrice": Decimal,
        "close": Decimal,
        "date": {},
        "high": Decimal,
        "low": Decimal,
        "open": Decimal,
        "volume": {}
      }
    ]
  }
}
Queries

getOrders

Description

Requires scope: portfolio.read.

Response

Returns [BrokerOrderOutput!]!

Arguments
Name Description
params - BrokerOrdersInput!

Example

Query
query getOrders($params: BrokerOrdersInput!) {
  getOrders(params: $params) {
    averageFilledPrice
    brokerCredentialId
    brokerType
    createdAt
    expiredAt
    fee
    filledAt
    id
    limitPrice
    notional
    premarket
    quantity
    quantityFilled
    side
    status
    stopPrice
    symbol
    timeInForce
    type
  }
}
Variables
{"params": BrokerOrdersInput}
Response
{
  "data": {
    "getOrders": [
      {
        "averageFilledPrice": Decimal,
        "brokerCredentialId": "xyz789",
        "brokerType": "abc123",
        "createdAt": "abc123",
        "expiredAt": "xyz789",
        "fee": Decimal,
        "filledAt": "xyz789",
        "id": "abc123",
        "limitPrice": Decimal,
        "notional": Decimal,
        "premarket": false,
        "quantity": Decimal,
        "quantityFilled": Decimal,
        "side": "BUY",
        "status": "ACCEPTED",
        "stopPrice": Decimal,
        "symbol": "xyz789",
        "timeInForce": "CLS",
        "type": "LIMIT"
      }
    ]
  }
}
Queries

getPortfolioEmails

Description

Requires scope: portfolio.read.

Response

Returns a PortfolioEmailInfo!

Arguments
Name Description
portfolioCode - String!

Example

Query
query getPortfolioEmails($portfolioCode: String!) {
  getPortfolioEmails(portfolioCode: $portfolioCode) {
    code
    email
    emailEnabled
    name
    tradeEmails {
      ...TradeEmailFragment
    }
  }
}
Variables
{"portfolioCode": "xyz789"}
Response
{
  "data": {
    "getPortfolioEmails": {
      "code": "abc123",
      "email": "xyz789",
      "emailEnabled": false,
      "name": "abc123",
      "tradeEmails": [TradeEmail]
    }
  }
}
Queries

getPortfolioHistory

Description

Requires scope: portfolio.read.

Response

Returns a BrokerFetchPortfolioHistoryOutput!

Arguments
Name Description
params - BrokerFetchPortfolioHistoryInput!

Example

Query
query getPortfolioHistory($params: BrokerFetchPortfolioHistoryInput!) {
  getPortfolioHistory(params: $params) {
    baseValue
    profitLoss
    profitLossPercent
    timeframe
    timestamps
    values
  }
}
Variables
{"params": BrokerFetchPortfolioHistoryInput}
Response
{
  "data": {
    "getPortfolioHistory": {
      "baseValue": Decimal,
      "profitLoss": [Decimal],
      "profitLossPercent": [Decimal],
      "timeframe": "xyz789",
      "timestamps": ["xyz789"],
      "values": [Decimal]
    }
  }
}
Queries

getPortfolios

Description

Requires scope: portfolio.read.

Response

Returns a PagedOutputOfPortfolio!

Arguments
Name Description
params - PagingInput!

Example

Query
query getPortfolios($params: PagingInput!) {
  getPortfolios(params: $params) {
    items {
      ...PortfolioFragment
    }
    size
    total
  }
}
Variables
{"params": PagingInput}
Response
{
  "data": {
    "getPortfolios": {
      "items": [Portfolio],
      "size": 123,
      "total": 987
    }
  }
}
Queries

getPositions

Description

Requires scope: portfolio.read.

Response

Returns [BrokerPosition!]!

Arguments
Name Description
params - BrokerPositionsInput!

Example

Query
query getPositions($params: BrokerPositionsInput!) {
  getPositions(params: $params) {
    assetClass
    averageEntryPrice
    brokerCredentialId
    brokerType
    changeToday
    costBasis
    currentPrice
    exchange
    lastDayPrice
    marketValue
    quantity
    quantityAvailable
    side
    symbol
    unrealizedProfitLoss
    unrealizedProfitLossIntraday
    unrealizedProfitLossPercent
    unrealizedProfitLossPercentIntraday
  }
}
Variables
{"params": BrokerPositionsInput}
Response
{
  "data": {
    "getPositions": [
      {
        "assetClass": "xyz789",
        "averageEntryPrice": Decimal,
        "brokerCredentialId": "abc123",
        "brokerType": "ALPACA",
        "changeToday": Decimal,
        "costBasis": Decimal,
        "currentPrice": Decimal,
        "exchange": "abc123",
        "lastDayPrice": Decimal,
        "marketValue": Decimal,
        "quantity": Decimal,
        "quantityAvailable": Decimal,
        "side": "abc123",
        "symbol": "xyz789",
        "unrealizedProfitLoss": Decimal,
        "unrealizedProfitLossIntraday": Decimal,
        "unrealizedProfitLossPercent": Decimal,
        "unrealizedProfitLossPercentIntraday": Decimal
      }
    ]
  }
}
Queries

getRebalancePreview

Description

Requires scope: portfolio.read.

Response

Returns a RebalancePreview!

Arguments
Name Description
id - ID!

Example

Query
query getRebalancePreview($id: ID!) {
  getRebalancePreview(id: $id) {
    totalBuys
    totalSells
    trades {
      ...RebalancePreviewTradeFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getRebalancePreview": {
      "totalBuys": Decimal,
      "totalSells": Decimal,
      "trades": [RebalancePreviewTrade]
    }
  }
}
Queries

getStockHistoricalData

Description

Requires scope: public.

Response

Returns [StockHistoricalDataPoint!]!

Arguments
Name Description
params - StockHistoricalDataInput!

Example

Query
query getStockHistoricalData($params: StockHistoricalDataInput!) {
  getStockHistoricalData(params: $params) {
    close
    date
    high
    low
    open
    volume
  }
}
Variables
{"params": StockHistoricalDataInput}
Response
{
  "data": {
    "getStockHistoricalData": [
      {
        "close": Decimal,
        "date": {},
        "high": Decimal,
        "low": Decimal,
        "open": Decimal,
        "volume": {}
      }
    ]
  }
}
Queries

getStrikes

Description

Requires scope: public.

Response

Returns [Decimal!]!

Arguments
Name Description
expiration - String!
root - String!

Example

Query
query getStrikes(
  $expiration: String!,
  $root: String!
) {
  getStrikes(
    expiration: $expiration,
    root: $root
  )
}
Variables
{
  "expiration": "abc123",
  "root": "xyz789"
}
Response
{"data": {"getStrikes": [Decimal]}}
Queries

getTemporaryQuote

Description

Requires scope: funding.read.

Response

Returns a WiseQuote!

Arguments
Name Description
params - WiseQuoteInput!

Example

Query
query getTemporaryQuote($params: WiseQuoteInput!) {
  getTemporaryQuote(params: $params) {
    fxFee
    gembotFee
    gembotFeeRate
    marketsClosed
    rate
    sourceAmount
    sourceCurrency
    targetAmount
    targetCurrency
  }
}
Variables
{"params": WiseQuoteInput}
Response
{
  "data": {
    "getTemporaryQuote": {
      "fxFee": Decimal,
      "gembotFee": Decimal,
      "gembotFeeRate": Decimal,
      "marketsClosed": true,
      "rate": Decimal,
      "sourceAmount": Decimal,
      "sourceCurrency": "AUD",
      "targetAmount": Decimal,
      "targetCurrency": "AUD"
    }
  }
}
Queries

getTradableAssets

Description

Requires scope: public.

Response

Returns [BrokerTradableAsset!]!

Arguments
Name Description
params - BrokerTradableAssetsInput!

Example

Query
query getTradableAssets($params: BrokerTradableAssetsInput!) {
  getTradableAssets(params: $params) {
    name
    symbol
  }
}
Variables
{"params": BrokerTradableAssetsInput}
Response
{
  "data": {
    "getTradableAssets": [
      {
        "name": "xyz789",
        "symbol": "abc123"
      }
    ]
  }
}
Queries

getTradeIdea

Description

Requires scope: portfolio.read.

Response

Returns a TradeIdea

Arguments
Name Description
id - ID!

Example

Query
query getTradeIdea($id: ID!) {
  getTradeIdea(id: $id) {
    actualCloseDate
    actualOpenDate
    content
    convictionLevel
    createdAt
    daysToClose
    daysToOpen
    description
    direction
    displayOrder
    estimatedCloseDate
    estimatedOpenDate
    hasOpenTrades
    id
    isProfitable
    returnPercentage
    title
    totalProfitLoss
    tradesClosed
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getTradeIdea": {
      "actualCloseDate": "2007-12-03T10:15:30Z",
      "actualOpenDate": "2007-12-03T10:15:30Z",
      "content": "xyz789",
      "convictionLevel": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "daysToClose": 987,
      "daysToOpen": 987,
      "description": "xyz789",
      "direction": "xyz789",
      "displayOrder": 987,
      "estimatedCloseDate": "2007-12-03T10:15:30Z",
      "estimatedOpenDate": "2007-12-03T10:15:30Z",
      "hasOpenTrades": true,
      "id": "abc123",
      "isProfitable": false,
      "returnPercentage": Decimal,
      "title": "abc123",
      "totalProfitLoss": Decimal,
      "tradesClosed": false,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Queries

getTradeIdeas

Description

Requires scope: portfolio.read.

Response

Returns [TradeIdea!]!

Example

Query
query getTradeIdeas {
  getTradeIdeas {
    actualCloseDate
    actualOpenDate
    content
    convictionLevel
    createdAt
    daysToClose
    daysToOpen
    description
    direction
    displayOrder
    estimatedCloseDate
    estimatedOpenDate
    hasOpenTrades
    id
    isProfitable
    returnPercentage
    title
    totalProfitLoss
    tradesClosed
    updatedAt
  }
}
Response
{
  "data": {
    "getTradeIdeas": [
      {
        "actualCloseDate": "2007-12-03T10:15:30Z",
        "actualOpenDate": "2007-12-03T10:15:30Z",
        "content": "abc123",
        "convictionLevel": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "daysToClose": 987,
        "daysToOpen": 987,
        "description": "abc123",
        "direction": "abc123",
        "displayOrder": 123,
        "estimatedCloseDate": "2007-12-03T10:15:30Z",
        "estimatedOpenDate": "2007-12-03T10:15:30Z",
        "hasOpenTrades": false,
        "id": "abc123",
        "isProfitable": false,
        "returnPercentage": Decimal,
        "title": "xyz789",
        "totalProfitLoss": Decimal,
        "tradesClosed": false,
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

getUSDBankingDetails

Description

Requires scope: funding.read.

Response

Returns an USDBankingDetails!

Example

Query
query getUSDBankingDetails {
  getUSDBankingDetails {
    accountName
    accountNumber
    alpacaAddress
    bankAddress
    bankName
    correspondenceCode
    routingNumber
    swiftCode
    userAccountNumber
    wireFee
  }
}
Response
{
  "data": {
    "getUSDBankingDetails": {
      "accountName": "xyz789",
      "accountNumber": "xyz789",
      "alpacaAddress": "abc123",
      "bankAddress": "xyz789",
      "bankName": "xyz789",
      "correspondenceCode": "xyz789",
      "routingNumber": "abc123",
      "swiftCode": "xyz789",
      "userAccountNumber": "abc123",
      "wireFee": "abc123"
    }
  }
}
Queries

getWalletWatches

Description

Requires scope: portfolio.read.

Response

Returns a PagedOutputOfWalletWatch!

Arguments
Name Description
portfolioCode - String!

Example

Query
query getWalletWatches($portfolioCode: String!) {
  getWalletWatches(portfolioCode: $portfolioCode) {
    hasNextPage
    items {
      ...WalletWatchFragment
    }
  }
}
Variables
{"portfolioCode": "xyz789"}
Response
{
  "data": {
    "getWalletWatches": {
      "hasNextPage": false,
      "items": [WalletWatch]
    }
  }
}
Queries

getWealthRelayTrades

Description

Requires scope: portfolio.read.

Response

Returns [Trade!]!

Arguments
Name Description
portfolioCode - String
symbol - String

Example

Query
query getWealthRelayTrades(
  $portfolioCode: String,
  $symbol: String
) {
  getWealthRelayTrades(
    portfolioCode: $portfolioCode,
    symbol: $symbol
  ) {
    brokerage
    comment
    market
    price
    quantity
    symbol
    thirdPartyId
    tradeCode
    tradeDate
    type
    value
  }
}
Variables
{
  "portfolioCode": "abc123",
  "symbol": "abc123"
}
Response
{
  "data": {
    "getWealthRelayTrades": [
      {
        "brokerage": Decimal,
        "comment": "abc123",
        "market": "xyz789",
        "price": Decimal,
        "quantity": Decimal,
        "symbol": "xyz789",
        "thirdPartyId": "xyz789",
        "tradeCode": "xyz789",
        "tradeDate": GemDate,
        "type": "xyz789",
        "value": Decimal
      }
    ]
  }
}
Queries

healthCheck

Description

Requires scope: public.

Response

Returns a Boolean!

Example

Query
query healthCheck {
  healthCheck
}
Response
{"data": {"healthCheck": true}}
Queries

listCards

Description

Requires scope: funding.read.

Response

Returns a CardList!

Example

Query
query listCards {
  listCards {
    cards {
      ...CardFragment
    }
  }
}
Response
{"data": {"listCards": {"cards": [Card]}}}
Queries

listSubscriptions

Description

Requires scope: public.

Response

Returns a SubscriptionList!

Example

Query
query listSubscriptions {
  listSubscriptions {
    subscriptions {
      ...SubscriptionPlanFragment
    }
  }
}
Response
{
  "data": {
    "listSubscriptions": {
      "subscriptions": [SubscriptionPlan]
    }
  }
}
Queries

listUserSubscriptions

Description

Requires scope: funding.read.

Response

Returns a UserSubscriptionList!

Example

Query
query listUserSubscriptions {
  listUserSubscriptions {
    subscriptions {
      ...UserSubscriptionFragment
    }
  }
}
Response
{
  "data": {
    "listUserSubscriptions": {
      "subscriptions": [UserSubscription]
    }
  }
}
Queries

myExportJobs

Description

Requires scope: funding.read.

Response

Returns [ExportJobGql!]!

Example

Query
query myExportJobs {
  myExportJobs {
    createdAt
    downloadUrl
    expiresAt
    id
    lastViewedAt
    name
    status
  }
}
Response
{
  "data": {
    "myExportJobs": [
      {
        "createdAt": "abc123",
        "downloadUrl": "xyz789",
        "expiresAt": "xyz789",
        "id": "abc123",
        "lastViewedAt": "abc123",
        "name": "abc123",
        "status": "abc123"
      }
    ]
  }
}
Queries

netWorthAllPortfolioFiles

Description

Files across the assets portfolio and all of its sub-portfolios, newest first. Requires scope: portfolio.read.

Response

Returns [NetWorthPortfolioFile!]!

Example

Query
query netWorthAllPortfolioFiles {
  netWorthAllPortfolioFiles {
    code
    contentType
    createdAt
    downloadUrl
    extractedData
    extractionError
    extractionStatus
    fileName
    fileSize
    portfolioCode
    portfolioName
    source
  }
}
Response
{
  "data": {
    "netWorthAllPortfolioFiles": [
      {
        "code": "abc123",
        "contentType": "xyz789",
        "createdAt": "abc123",
        "downloadUrl": "xyz789",
        "extractedData": "xyz789",
        "extractionError": "xyz789",
        "extractionStatus": "abc123",
        "fileName": "xyz789",
        "fileSize": 987,
        "portfolioCode": "xyz789",
        "portfolioName": "abc123",
        "source": "xyz789"
      }
    ]
  }
}
Queries

netWorthAssetDividends

Description

Received dividends for a single instrument (symbol) in your portfolio. Requires scope: portfolio.read.

Response

Returns [NetWorthAssetDividend!]!

Arguments
Name Description
market - String
portfolioCode - String
symbol - String!

Example

Query
query netWorthAssetDividends(
  $market: String,
  $portfolioCode: String,
  $symbol: String!
) {
  netWorthAssetDividends(
    market: $market,
    portfolioCode: $portfolioCode,
    symbol: $symbol
  ) {
    amount
    amountPerShare
    code
    currency
    executionDate
    paidDate
    pending
  }
}
Variables
{
  "market": "xyz789",
  "portfolioCode": "abc123",
  "symbol": "xyz789"
}
Response
{
  "data": {
    "netWorthAssetDividends": [
      {
        "amount": 123.45,
        "amountPerShare": 123.45,
        "code": "xyz789",
        "currency": "abc123",
        "executionDate": "abc123",
        "paidDate": "abc123",
        "pending": true
      }
    ]
  }
}
Queries

netWorthAssetHistory

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthAssetHistory!]!

Arguments
Name Description
assetId - ID!
market - String
portfolioCode - String

Example

Query
query netWorthAssetHistory(
  $assetId: ID!,
  $market: String,
  $portfolioCode: String
) {
  netWorthAssetHistory(
    assetId: $assetId,
    market: $market,
    portfolioCode: $portfolioCode
  ) {
    assetId
    changeReason
    contributionPercentage
    createdAt
    currency
    currentValue
    description
    estimatedReturn
    householdId
    id
    includeInCalculations
    purchaseDate
    purchasePrice
    tradeData {
      ...WealthRelayTradeDataFragment
    }
    type
    updatedAt
    validFrom
    validTo
  }
}
Variables
{
  "assetId": 4,
  "market": "xyz789",
  "portfolioCode": "abc123"
}
Response
{
  "data": {
    "netWorthAssetHistory": [
      {
        "assetId": "xyz789",
        "changeReason": "xyz789",
        "contributionPercentage": Decimal,
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "currentValue": Decimal,
        "description": "abc123",
        "estimatedReturn": Decimal,
        "householdId": "xyz789",
        "id": "xyz789",
        "includeInCalculations": true,
        "purchaseDate": "2007-12-03T10:15:30Z",
        "purchasePrice": Decimal,
        "tradeData": WealthRelayTradeData,
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "validFrom": "2007-12-03T10:15:30Z",
        "validTo": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

netWorthAssets

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthAsset!]!

Arguments
Name Description
includeSubPortfolios - Boolean
portfolioCode - String

Example

Query
query netWorthAssets(
  $includeSubPortfolios: Boolean,
  $portfolioCode: String
) {
  netWorthAssets(
    includeSubPortfolios: $includeSubPortfolios,
    portfolioCode: $portfolioCode
  ) {
    contributionPercentage
    convertedValue
    createdAt
    currency
    currencyGain
    currentValue
    description
    estimatedReturn
    fxRate
    growth
    growthPercent
    householdId
    id
    includeInCalculations
    initialValue
    logoUrl
    market
    portfolioCode
    portfolioName
    purchaseDate
    purchasePrice
    quantity
    ticker
    type
    unitPrice
    updatedAt
  }
}
Variables
{
  "includeSubPortfolios": true,
  "portfolioCode": "abc123"
}
Response
{
  "data": {
    "netWorthAssets": [
      {
        "contributionPercentage": Decimal,
        "convertedValue": Decimal,
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "currencyGain": Decimal,
        "currentValue": Decimal,
        "description": "xyz789",
        "estimatedReturn": Decimal,
        "fxRate": Decimal,
        "growth": Decimal,
        "growthPercent": Decimal,
        "householdId": "abc123",
        "id": "abc123",
        "includeInCalculations": false,
        "initialValue": Decimal,
        "logoUrl": "xyz789",
        "market": "abc123",
        "portfolioCode": "xyz789",
        "portfolioName": "abc123",
        "purchaseDate": "2007-12-03T10:15:30Z",
        "purchasePrice": Decimal,
        "quantity": Decimal,
        "ticker": "abc123",
        "type": "abc123",
        "unitPrice": Decimal,
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

netWorthDashboard

Description

Requires scope: portfolio.read.

Response

Returns a NetWorthDashboard!

Arguments
Name Description
from - String
portfolioCode - String
to - String

Example

Query
query netWorthDashboard(
  $from: String,
  $portfolioCode: String,
  $to: String
) {
  netWorthDashboard(
    from: $from,
    portfolioCode: $portfolioCode,
    to: $to
  ) {
    assets {
      ...NetWorthAssetFragment
    }
    currentPortfolio {
      ...NetWorthPortfolioFragment
    }
    expenses {
      ...NetWorthExpenseFragment
    }
    goals {
      ...NetWorthGoalFragment
    }
    household {
      ...NetWorthHouseholdFragment
    }
    incomes {
      ...NetWorthIncomeFragment
    }
    liabilities {
      ...NetWorthLiabilityFragment
    }
    portfolios {
      ...NetWorthPortfolioFragment
    }
    snapshots {
      ...NetWorthSnapshotFragment
    }
    totals {
      ...NetWorthTotalsFragment
    }
    valueHistory {
      ...NetWorthValueSeriesFragment
    }
  }
}
Variables
{
  "from": "abc123",
  "portfolioCode": "abc123",
  "to": "abc123"
}
Response
{
  "data": {
    "netWorthDashboard": {
      "assets": [NetWorthAsset],
      "currentPortfolio": NetWorthPortfolio,
      "expenses": [NetWorthExpense],
      "goals": [NetWorthGoal],
      "household": NetWorthHousehold,
      "incomes": [NetWorthIncome],
      "liabilities": [NetWorthLiability],
      "portfolios": [NetWorthPortfolio],
      "snapshots": [NetWorthSnapshot],
      "totals": NetWorthTotals,
      "valueHistory": [NetWorthValueSeries]
    }
  }
}
Queries

netWorthDisplayCurrency

Description

Requires scope: portfolio.read.

Response

Returns a String!

Example

Query
query netWorthDisplayCurrency {
  netWorthDisplayCurrency
}
Response
{
  "data": {
    "netWorthDisplayCurrency": "xyz789"
  }
}
Queries

netWorthDocuments

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthDocument!]!

Example

Query
query netWorthDocuments {
  netWorthDocuments {
    category
    contentType
    createdAt
    downloadUrl
    fileName
    id
    sizeBytes
    status
  }
}
Response
{
  "data": {
    "netWorthDocuments": [
      {
        "category": "abc123",
        "contentType": "xyz789",
        "createdAt": "xyz789",
        "downloadUrl": "xyz789",
        "fileName": "abc123",
        "id": "abc123",
        "sizeBytes": 987,
        "status": "abc123"
      }
    ]
  }
}
Queries

netWorthExpenseHistory

Description

Requires scope: portfolio.read.

Response

Returns [String!]!

Arguments
Name Description
expenseId - ID!

Example

Query
query netWorthExpenseHistory($expenseId: ID!) {
  netWorthExpenseHistory(expenseId: $expenseId)
}
Variables
{"expenseId": "4"}
Response
{
  "data": {
    "netWorthExpenseHistory": ["abc123"]
  }
}
Queries

netWorthExpenses

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthExpense!]!

Example

Query
query netWorthExpenses {
  netWorthExpenses {
    category
    createdAt
    description
    householdId
    id
    monthlyAmount
    updatedAt
  }
}
Response
{
  "data": {
    "netWorthExpenses": [
      {
        "category": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "description": "abc123",
        "householdId": "abc123",
        "id": "abc123",
        "monthlyAmount": Decimal,
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

netWorthGoals

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthGoal!]!

Example

Query
query netWorthGoals {
  netWorthGoals {
    attachedAssetIds
    attachedLiabilityIds
    createdAt
    currentAmount
    description
    householdId
    id
    isFinancial
    name
    priority
    status
    targetAmount
    targetDate
    updatedAt
  }
}
Response
{
  "data": {
    "netWorthGoals": [
      {
        "attachedAssetIds": ["xyz789"],
        "attachedLiabilityIds": ["xyz789"],
        "createdAt": "2007-12-03T10:15:30Z",
        "currentAmount": Decimal,
        "description": "abc123",
        "householdId": "xyz789",
        "id": "abc123",
        "isFinancial": true,
        "name": "abc123",
        "priority": "xyz789",
        "status": "xyz789",
        "targetAmount": Decimal,
        "targetDate": "2007-12-03T10:15:30Z",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

netWorthHousehold

Description

Requires scope: portfolio.read.

Response

Returns a NetWorthHousehold

Example

Query
query netWorthHousehold {
  netWorthHousehold {
    coachNotes
    createdAt
    familySize
    id
    name
    status
    updatedAt
    userId
  }
}
Response
{
  "data": {
    "netWorthHousehold": {
      "coachNotes": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "familySize": 987,
      "id": "abc123",
      "name": "xyz789",
      "status": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "userId": "abc123"
    }
  }
}
Queries

netWorthIncomeHistory

Description

Requires scope: portfolio.read.

Response

Returns [String!]!

Arguments
Name Description
incomeId - ID!

Example

Query
query netWorthIncomeHistory($incomeId: ID!) {
  netWorthIncomeHistory(incomeId: $incomeId)
}
Variables
{"incomeId": 4}
Response
{
  "data": {
    "netWorthIncomeHistory": ["abc123"]
  }
}
Queries

netWorthIncomes

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthIncome!]!

Example

Query
query netWorthIncomes {
  netWorthIncomes {
    annualAmount
    createdAt
    description
    householdId
    id
    isAfterTax
    source
    updatedAt
  }
}
Response
{
  "data": {
    "netWorthIncomes": [
      {
        "annualAmount": Decimal,
        "createdAt": "2007-12-03T10:15:30Z",
        "description": "xyz789",
        "householdId": "abc123",
        "id": "xyz789",
        "isAfterTax": false,
        "source": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

netWorthLiabilities

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthLiability!]!

Example

Query
query netWorthLiabilities {
  netWorthLiabilities {
    createdAt
    currentBalance
    description
    householdId
    id
    interestRate
    monthlyPayment
    originalAmount
    remainingTerm
    type
    updatedAt
  }
}
Response
{
  "data": {
    "netWorthLiabilities": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "currentBalance": Decimal,
        "description": "abc123",
        "householdId": "abc123",
        "id": "abc123",
        "interestRate": Decimal,
        "monthlyPayment": Decimal,
        "originalAmount": Decimal,
        "remainingTerm": "abc123",
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

netWorthLiabilityHistory

Description

Requires scope: portfolio.read.

Response

Returns [String!]!

Arguments
Name Description
liabilityId - ID!

Example

Query
query netWorthLiabilityHistory($liabilityId: ID!) {
  netWorthLiabilityHistory(liabilityId: $liabilityId)
}
Variables
{"liabilityId": 4}
Response
{
  "data": {
    "netWorthLiabilityHistory": ["xyz789"]
  }
}
Queries

netWorthPortfolioFiles

Description

Requires scope: portfolio.read.

Response

Returns [NetWorthPortfolioFile!]!

Arguments
Name Description
portfolioCode - String!

Example

Query
query netWorthPortfolioFiles($portfolioCode: String!) {
  netWorthPortfolioFiles(portfolioCode: $portfolioCode) {
    code
    contentType
    createdAt
    downloadUrl
    extractedData
    extractionError
    extractionStatus
    fileName
    fileSize
    portfolioCode
    portfolioName
    source
  }
}
Variables
{"portfolioCode": "abc123"}
Response
{
  "data": {
    "netWorthPortfolioFiles": [
      {
        "code": "xyz789",
        "contentType": "abc123",
        "createdAt": "xyz789",
        "downloadUrl": "xyz789",
        "extractedData": "abc123",
        "extractionError": "xyz789",
        "extractionStatus": "abc123",
        "fileName": "xyz789",
        "fileSize": 987,
        "portfolioCode": "xyz789",
        "portfolioName": "abc123",
        "source": "xyz789"
      }
    ]
  }
}
Queries

searchInstruments

Description

Requires scope: portfolio.read.

Response

Returns [InstrumentSearchResult!]!

Arguments
Name Description
input - InstrumentSearchInput!

Example

Query
query searchInstruments($input: InstrumentSearchInput!) {
  searchInstruments(input: $input) {
    currency
    isCustom
    isDelisted
    logoUrl
    market
    name
    symbol
    type
  }
}
Variables
{"input": InstrumentSearchInput}
Response
{
  "data": {
    "searchInstruments": [
      {
        "currency": "abc123",
        "isCustom": true,
        "isDelisted": true,
        "logoUrl": "xyz789",
        "market": "abc123",
        "name": "abc123",
        "symbol": "xyz789",
        "type": "abc123"
      }
    ]
  }
}
Queries

searchVASPs

Description

Requires scope: funding.read.

Response

Returns [VASP!]!

Arguments
Name Description
params - SearchVASPsInput!

Example

Query
query searchVASPs($params: SearchVASPsInput!) {
  searchVASPs(params: $params) {
    id
    name
  }
}
Variables
{"params": SearchVASPsInput}
Response
{
  "data": {
    "searchVASPs": [
      {
        "id": "xyz789",
        "name": "abc123"
      }
    ]
  }
}
Queries

sharedNetWorthAssetHistory

Description

Requires scope: public.

Response

Returns [NetWorthAssetHistory!]!

Arguments
Name Description
assetId - ID!
market - String
password - String
portfolioCode - String
token - String!

Example

Query
query sharedNetWorthAssetHistory(
  $assetId: ID!,
  $market: String,
  $password: String,
  $portfolioCode: String,
  $token: String!
) {
  sharedNetWorthAssetHistory(
    assetId: $assetId,
    market: $market,
    password: $password,
    portfolioCode: $portfolioCode,
    token: $token
  ) {
    assetId
    changeReason
    contributionPercentage
    createdAt
    currency
    currentValue
    description
    estimatedReturn
    householdId
    id
    includeInCalculations
    purchaseDate
    purchasePrice
    tradeData {
      ...WealthRelayTradeDataFragment
    }
    type
    updatedAt
    validFrom
    validTo
  }
}
Variables
{
  "assetId": "4",
  "market": "abc123",
  "password": "abc123",
  "portfolioCode": "xyz789",
  "token": "xyz789"
}
Response
{
  "data": {
    "sharedNetWorthAssetHistory": [
      {
        "assetId": "abc123",
        "changeReason": "abc123",
        "contributionPercentage": Decimal,
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "currentValue": Decimal,
        "description": "xyz789",
        "estimatedReturn": Decimal,
        "householdId": "abc123",
        "id": "abc123",
        "includeInCalculations": false,
        "purchaseDate": "2007-12-03T10:15:30Z",
        "purchasePrice": Decimal,
        "tradeData": WealthRelayTradeData,
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "validFrom": "2007-12-03T10:15:30Z",
        "validTo": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

sharedNetWorthDashboard

Description

Requires scope: public.

Response

Returns a NetWorthDashboard

Arguments
Name Description
from - String
password - String
portfolioCode - String
to - String
token - String!

Example

Query
query sharedNetWorthDashboard(
  $from: String,
  $password: String,
  $portfolioCode: String,
  $to: String,
  $token: String!
) {
  sharedNetWorthDashboard(
    from: $from,
    password: $password,
    portfolioCode: $portfolioCode,
    to: $to,
    token: $token
  ) {
    assets {
      ...NetWorthAssetFragment
    }
    currentPortfolio {
      ...NetWorthPortfolioFragment
    }
    expenses {
      ...NetWorthExpenseFragment
    }
    goals {
      ...NetWorthGoalFragment
    }
    household {
      ...NetWorthHouseholdFragment
    }
    incomes {
      ...NetWorthIncomeFragment
    }
    liabilities {
      ...NetWorthLiabilityFragment
    }
    portfolios {
      ...NetWorthPortfolioFragment
    }
    snapshots {
      ...NetWorthSnapshotFragment
    }
    totals {
      ...NetWorthTotalsFragment
    }
    valueHistory {
      ...NetWorthValueSeriesFragment
    }
  }
}
Variables
{
  "from": "xyz789",
  "password": "xyz789",
  "portfolioCode": "abc123",
  "to": "xyz789",
  "token": "abc123"
}
Response
{
  "data": {
    "sharedNetWorthDashboard": {
      "assets": [NetWorthAsset],
      "currentPortfolio": NetWorthPortfolio,
      "expenses": [NetWorthExpense],
      "goals": [NetWorthGoal],
      "household": NetWorthHousehold,
      "incomes": [NetWorthIncome],
      "liabilities": [NetWorthLiability],
      "portfolios": [NetWorthPortfolio],
      "snapshots": [NetWorthSnapshot],
      "totals": NetWorthTotals,
      "valueHistory": [NetWorthValueSeries]
    }
  }
}

Mutations

addInstrumentPrice

Description

Requires scope: portfolio.write.

Response

Returns a WealthrelayInstrumentPrice!

Arguments
Name Description
input - AddInstrumentPriceInput!

Example

Query
mutation addInstrumentPrice($input: AddInstrumentPriceInput!) {
  addInstrumentPrice(input: $input) {
    close
    currency
    date
    high
    low
    open
  }
}
Variables
{"input": AddInstrumentPriceInput}
Response
{
  "data": {
    "addInstrumentPrice": {
      "close": Decimal,
      "currency": "abc123",
      "date": "xyz789",
      "high": Decimal,
      "low": Decimal,
      "open": Decimal
    }
  }
}
Mutations

addWalletWatch

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
input - AddWalletWatchInput!

Example

Query
mutation addWalletWatch($input: AddWalletWatchInput!) {
  addWalletWatch(input: $input)
}
Variables
{"input": AddWalletWatchInput}
Response
{"data": {"addWalletWatch": false}}
Mutations

cancelOrder

Description

Requires scope: trade.

Response

Returns a Boolean!

Arguments
Name Description
params - BrokerCancelOrderInput!

Example

Query
mutation cancelOrder($params: BrokerCancelOrderInput!) {
  cancelOrder(params: $params)
}
Variables
{"params": BrokerCancelOrderInput}
Response
{"data": {"cancelOrder": true}}
Mutations

cancelSubscription

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - CancelSubscriptionInput!

Example

Query
mutation cancelSubscription($params: CancelSubscriptionInput!) {
  cancelSubscription(params: $params)
}
Variables
{"params": CancelSubscriptionInput}
Response
{"data": {"cancelSubscription": true}}
Mutations

confirmNetWorthDividend

Description

Confirm a single auto-imported, still-pending received dividend. Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
dividendCode - String!

Example

Query
mutation confirmNetWorthDividend($dividendCode: String!) {
  confirmNetWorthDividend(dividendCode: $dividendCode)
}
Variables
{"dividendCode": "xyz789"}
Response
{"data": {"confirmNetWorthDividend": false}}
Mutations

confirmNetWorthTrade

Description

Confirm a single auto-imported, still-pending split or consolidation trade. Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
tradeCode - String!

Example

Query
mutation confirmNetWorthTrade($tradeCode: String!) {
  confirmNetWorthTrade(tradeCode: $tradeCode)
}
Variables
{"tradeCode": "xyz789"}
Response
{"data": {"confirmNetWorthTrade": false}}
Mutations

contributeToActiveStrategy

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
params - ContributeToActiveStrategyInput!

Example

Query
mutation contributeToActiveStrategy($params: ContributeToActiveStrategyInput!) {
  contributeToActiveStrategy(params: $params) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"params": ContributeToActiveStrategyInput}
Response
{
  "data": {
    "contributeToActiveStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": "4",
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": false,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "abc123",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "xyz789",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

createActiveStrategy

Description

Requires scope: trade.

Response

Returns an ActiveStrategy

Arguments
Name Description
params - CreateActiveStrategyInput!

Example

Query
mutation createActiveStrategy($params: CreateActiveStrategyInput!) {
  createActiveStrategy(params: $params) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"params": CreateActiveStrategyInput}
Response
{
  "data": {
    "createActiveStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": "4",
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": true,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "xyz789",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "abc123",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "abc123",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

createCryptoAutoSweep

Description

Requires scope: funding.write.

Response

Returns a CryptoAutoSweepResponse!

Arguments
Name Description
input - CreateCryptoAutoSweepInput!

Example

Query
mutation createCryptoAutoSweep($input: CreateCryptoAutoSweepInput!) {
  createCryptoAutoSweep(input: $input) {
    asset
    id
    reference
    status
    whitelistedWalletId
  }
}
Variables
{"input": CreateCryptoAutoSweepInput}
Response
{
  "data": {
    "createCryptoAutoSweep": {
      "asset": "abc123",
      "id": "4",
      "reference": "abc123",
      "status": "xyz789",
      "whitelistedWalletId": "xyz789"
    }
  }
}
Mutations

createCryptoCurrencyWallets

Description

Requires scope: funding.write.

Response

Returns [CryptoWallet!]!

Arguments
Name Description
params - CreateCryptoWalletsInput!

Example

Query
mutation createCryptoCurrencyWallets($params: CreateCryptoWalletsInput!) {
  createCryptoCurrencyWallets(params: $params) {
    address
    amount
    assetName
    pendingWithdrawalAmount
    value
  }
}
Variables
{"params": CreateCryptoWalletsInput}
Response
{
  "data": {
    "createCryptoCurrencyWallets": [
      {
        "address": "xyz789",
        "amount": Decimal,
        "assetName": "xyz789",
        "pendingWithdrawalAmount": Decimal,
        "value": Decimal
      }
    ]
  }
}
Mutations

createCryptoWallet

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
params - CreateWalletInput!

Example

Query
mutation createCryptoWallet($params: CreateWalletInput!) {
  createCryptoWallet(params: $params)
}
Variables
{"params": CreateWalletInput}
Response
{"data": {"createCryptoWallet": false}}
Mutations

createCustomInstrument

Description

Requires scope: portfolio.write.

Response

Returns a CustomInstrument!

Arguments
Name Description
input - CreateCustomInstrumentInput!

Example

Query
mutation createCustomInstrument($input: CreateCustomInstrumentInput!) {
  createCustomInstrument(input: $input) {
    createdAt
    currency
    delisted
    instrumentType
    logoUrl
    metaData {
      ...CustomInstrumentMetaDataFragment
    }
    name
    symbol
    unit
    updatedAt
  }
}
Variables
{"input": CreateCustomInstrumentInput}
Response
{
  "data": {
    "createCustomInstrument": {
      "createdAt": "abc123",
      "currency": "xyz789",
      "delisted": true,
      "instrumentType": "abc123",
      "logoUrl": "abc123",
      "metaData": [CustomInstrumentMetaData],
      "name": "xyz789",
      "symbol": "xyz789",
      "unit": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}
Mutations

createCustomInstrumentWithDetails

Description

Requires scope: portfolio.write.

Response

Returns a CustomInstrument!

Arguments
Name Description
input - CreateCustomInstrumentWithDetailsInput!

Example

Query
mutation createCustomInstrumentWithDetails($input: CreateCustomInstrumentWithDetailsInput!) {
  createCustomInstrumentWithDetails(input: $input) {
    createdAt
    currency
    delisted
    instrumentType
    logoUrl
    metaData {
      ...CustomInstrumentMetaDataFragment
    }
    name
    symbol
    unit
    updatedAt
  }
}
Variables
{"input": CreateCustomInstrumentWithDetailsInput}
Response
{
  "data": {
    "createCustomInstrumentWithDetails": {
      "createdAt": "xyz789",
      "currency": "xyz789",
      "delisted": true,
      "instrumentType": "abc123",
      "logoUrl": "xyz789",
      "metaData": [CustomInstrumentMetaData],
      "name": "xyz789",
      "symbol": "abc123",
      "unit": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}
Mutations

createGembrokerPaperAccount

Description

Requires scope: trade.

Response

Returns a Boolean!

Example

Query
mutation createGembrokerPaperAccount {
  createGembrokerPaperAccount
}
Response
{"data": {"createGembrokerPaperAccount": true}}
Mutations

createNetWorthDividend

Description

Record a dividend received for an asset, for custom instruments the automated importer doesn't cover. Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
input - CreateNetWorthDividendInput!

Example

Query
mutation createNetWorthDividend($input: CreateNetWorthDividendInput!) {
  createNetWorthDividend(input: $input)
}
Variables
{"input": CreateNetWorthDividendInput}
Response
{"data": {"createNetWorthDividend": true}}
Mutations

createNetWorthDocumentUpload

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthDocumentUpload!

Arguments
Name Description
input - CreateNetWorthDocumentUploadInput!

Example

Query
mutation createNetWorthDocumentUpload($input: CreateNetWorthDocumentUploadInput!) {
  createNetWorthDocumentUpload(input: $input) {
    document {
      ...NetWorthDocumentFragment
    }
    uploadUrl
  }
}
Variables
{"input": CreateNetWorthDocumentUploadInput}
Response
{
  "data": {
    "createNetWorthDocumentUpload": {
      "document": NetWorthDocument,
      "uploadUrl": "xyz789"
    }
  }
}
Mutations

createNetWorthExpense

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthExpense!

Arguments
Name Description
input - CreateNetWorthExpenseInput!

Example

Query
mutation createNetWorthExpense($input: CreateNetWorthExpenseInput!) {
  createNetWorthExpense(input: $input) {
    category
    createdAt
    description
    householdId
    id
    monthlyAmount
    updatedAt
  }
}
Variables
{"input": CreateNetWorthExpenseInput}
Response
{
  "data": {
    "createNetWorthExpense": {
      "category": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "householdId": "abc123",
      "id": "abc123",
      "monthlyAmount": Decimal,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createNetWorthGoal

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthGoal!

Arguments
Name Description
input - CreateNetWorthGoalInput!

Example

Query
mutation createNetWorthGoal($input: CreateNetWorthGoalInput!) {
  createNetWorthGoal(input: $input) {
    attachedAssetIds
    attachedLiabilityIds
    createdAt
    currentAmount
    description
    householdId
    id
    isFinancial
    name
    priority
    status
    targetAmount
    targetDate
    updatedAt
  }
}
Variables
{"input": CreateNetWorthGoalInput}
Response
{
  "data": {
    "createNetWorthGoal": {
      "attachedAssetIds": ["abc123"],
      "attachedLiabilityIds": ["abc123"],
      "createdAt": "2007-12-03T10:15:30Z",
      "currentAmount": Decimal,
      "description": "abc123",
      "householdId": "abc123",
      "id": "xyz789",
      "isFinancial": true,
      "name": "abc123",
      "priority": "abc123",
      "status": "abc123",
      "targetAmount": Decimal,
      "targetDate": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createNetWorthIncome

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthIncome!

Arguments
Name Description
input - CreateNetWorthIncomeInput!

Example

Query
mutation createNetWorthIncome($input: CreateNetWorthIncomeInput!) {
  createNetWorthIncome(input: $input) {
    annualAmount
    createdAt
    description
    householdId
    id
    isAfterTax
    source
    updatedAt
  }
}
Variables
{"input": CreateNetWorthIncomeInput}
Response
{
  "data": {
    "createNetWorthIncome": {
      "annualAmount": Decimal,
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "xyz789",
      "householdId": "abc123",
      "id": "abc123",
      "isAfterTax": false,
      "source": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createNetWorthLiability

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthLiability!

Arguments
Name Description
input - CreateNetWorthLiabilityInput!

Example

Query
mutation createNetWorthLiability($input: CreateNetWorthLiabilityInput!) {
  createNetWorthLiability(input: $input) {
    createdAt
    currentBalance
    description
    householdId
    id
    interestRate
    monthlyPayment
    originalAmount
    remainingTerm
    type
    updatedAt
  }
}
Variables
{"input": CreateNetWorthLiabilityInput}
Response
{
  "data": {
    "createNetWorthLiability": {
      "createdAt": "2007-12-03T10:15:30Z",
      "currentBalance": Decimal,
      "description": "xyz789",
      "householdId": "xyz789",
      "id": "abc123",
      "interestRate": Decimal,
      "monthlyPayment": Decimal,
      "originalAmount": Decimal,
      "remainingTerm": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createNetWorthLiabilityTrade

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthLiability!

Arguments
Name Description
input - CreateNetWorthLiabilityTradeInput!

Example

Query
mutation createNetWorthLiabilityTrade($input: CreateNetWorthLiabilityTradeInput!) {
  createNetWorthLiabilityTrade(input: $input) {
    createdAt
    currentBalance
    description
    householdId
    id
    interestRate
    monthlyPayment
    originalAmount
    remainingTerm
    type
    updatedAt
  }
}
Variables
{"input": CreateNetWorthLiabilityTradeInput}
Response
{
  "data": {
    "createNetWorthLiabilityTrade": {
      "createdAt": "2007-12-03T10:15:30Z",
      "currentBalance": Decimal,
      "description": "abc123",
      "householdId": "xyz789",
      "id": "abc123",
      "interestRate": Decimal,
      "monthlyPayment": Decimal,
      "originalAmount": Decimal,
      "remainingTerm": "xyz789",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

createNetworthPortfolio

Description

Requires scope: portfolio.write.

Response

Returns a Portfolio!

Arguments
Name Description
input - CreateNetworthPortfolioInput!

Example

Query
mutation createNetworthPortfolio($input: CreateNetworthPortfolioInput!) {
  createNetworthPortfolio(input: $input) {
    code
    metaData {
      ...PortfolioMetaDataFragment
    }
    name
    parentPortfolioCode
  }
}
Variables
{"input": CreateNetworthPortfolioInput}
Response
{
  "data": {
    "createNetworthPortfolio": {
      "code": "abc123",
      "metaData": [PortfolioMetaData],
      "name": "xyz789",
      "parentPortfolioCode": "abc123"
    }
  }
}
Mutations

createPendingUserTransaction

Description

Requires scope: funding.write.

Response

Returns a PendingUserTransaction!

Arguments
Name Description
params - CreatePendingUserTransactionInput!

Example

Query
mutation createPendingUserTransaction($params: CreatePendingUserTransactionInput!) {
  createPendingUserTransaction(params: $params) {
    amountDeposited
    createdAt
    currency
    estimatedExchangeRate
    id
    reference
    transactionType
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": CreatePendingUserTransactionInput}
Response
{
  "data": {
    "createPendingUserTransaction": {
      "amountDeposited": Decimal,
      "createdAt": GemDate,
      "currency": "AUD",
      "estimatedExchangeRate": Decimal,
      "id": 4,
      "reference": "abc123",
      "transactionType": "DEPOSIT",
      "user": User
    }
  }
}
Mutations

createStrategy

Description

Requires scope: portfolio.write.

Response

Returns a Strategy!

Arguments
Name Description
params - CreateStrategyInput!

Example

Query
mutation createStrategy($params: CreateStrategyInput!) {
  createStrategy(params: $params) {
    author {
      ...AuthorFragment
    }
    calculatedDays
    calculatedIRR
    calculatedReturn
    category
    createdAt
    description
    expectedYield
    history {
      ...StrategyHistoryFragment
    }
    historyCount
    id
    imageURL
    isVotingEnabled
    latestPerformance
    logoURL
    name
    oneMonthReturn
    performance {
      ...StrategyPerformanceFragment
    }
    periodReturns {
      ...StrategyPeriodReturnFragment
    }
    privacy
    subscriberCount
    targetWeights {
      ...StrategyAssetWeightFragment
    }
    topHolding {
      ...StrategyAssetWeightFragment
    }
    type
    videoLink
    votes {
      ...StrategyAssetVoteFragment
    }
  }
}
Variables
{"params": CreateStrategyInput}
Response
{
  "data": {
    "createStrategy": {
      "author": Author,
      "calculatedDays": 987,
      "calculatedIRR": Decimal,
      "calculatedReturn": Decimal,
      "category": "ACTIVIST",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "expectedYield": Decimal,
      "history": [StrategyHistory],
      "historyCount": 987,
      "id": 4,
      "imageURL": "xyz789",
      "isVotingEnabled": true,
      "latestPerformance": Decimal,
      "logoURL": "abc123",
      "name": "xyz789",
      "oneMonthReturn": Decimal,
      "performance": [StrategyPerformance],
      "periodReturns": [StrategyPeriodReturn],
      "privacy": "PRIVATE",
      "subscriberCount": 987,
      "targetWeights": [StrategyAssetWeight],
      "topHolding": StrategyAssetWeight,
      "type": "COMMUNITY",
      "videoLink": "xyz789",
      "votes": [StrategyAssetVote]
    }
  }
}
Mutations

createStrategyAssetVotes

Description

Requires scope: profile.write.

Response

Returns [StrategyAssetVote!]!

Arguments
Name Description
params - [CreateStrategyAssetVoteInput!]!

Example

Query
mutation createStrategyAssetVotes($params: [CreateStrategyAssetVoteInput!]!) {
  createStrategyAssetVotes(params: $params) {
    assetId
    authorId
    direction
  }
}
Variables
{"params": [CreateStrategyAssetVoteInput]}
Response
{
  "data": {
    "createStrategyAssetVotes": [
      {
        "assetId": "abc123",
        "authorId": "abc123",
        "direction": "LONG"
      }
    ]
  }
}
Mutations

createTrade

Description

Requires scope: trade.

Response

Returns a Trade!

Arguments
Name Description
params - CreateTradeInput!

Example

Query
mutation createTrade($params: CreateTradeInput!) {
  createTrade(params: $params) {
    brokerage
    comment
    market
    price
    quantity
    symbol
    thirdPartyId
    tradeCode
    tradeDate
    type
    value
  }
}
Variables
{"params": CreateTradeInput}
Response
{
  "data": {
    "createTrade": {
      "brokerage": Decimal,
      "comment": "abc123",
      "market": "abc123",
      "price": Decimal,
      "quantity": Decimal,
      "symbol": "xyz789",
      "thirdPartyId": "xyz789",
      "tradeCode": "abc123",
      "tradeDate": GemDate,
      "type": "xyz789",
      "value": Decimal
    }
  }
}
Mutations

createTradeForAsset

Description

Requires scope: trade.

Response

Returns a Trade!

Arguments
Name Description
input - CreateTradeForAssetInput!

Example

Query
mutation createTradeForAsset($input: CreateTradeForAssetInput!) {
  createTradeForAsset(input: $input) {
    brokerage
    comment
    market
    price
    quantity
    symbol
    thirdPartyId
    tradeCode
    tradeDate
    type
    value
  }
}
Variables
{"input": CreateTradeForAssetInput}
Response
{
  "data": {
    "createTradeForAsset": {
      "brokerage": Decimal,
      "comment": "abc123",
      "market": "abc123",
      "price": Decimal,
      "quantity": Decimal,
      "symbol": "abc123",
      "thirdPartyId": "xyz789",
      "tradeCode": "xyz789",
      "tradeDate": GemDate,
      "type": "xyz789",
      "value": Decimal
    }
  }
}
Mutations

createWealthRelayTrade

Description

Requires scope: trade.

Response

Returns a Trade!

Arguments
Name Description
input - CreateTradeInput!

Example

Query
mutation createWealthRelayTrade($input: CreateTradeInput!) {
  createWealthRelayTrade(input: $input) {
    brokerage
    comment
    market
    price
    quantity
    symbol
    thirdPartyId
    tradeCode
    tradeDate
    type
    value
  }
}
Variables
{"input": CreateTradeInput}
Response
{
  "data": {
    "createWealthRelayTrade": {
      "brokerage": Decimal,
      "comment": "xyz789",
      "market": "abc123",
      "price": Decimal,
      "quantity": Decimal,
      "symbol": "abc123",
      "thirdPartyId": "xyz789",
      "tradeCode": "abc123",
      "tradeDate": GemDate,
      "type": "xyz789",
      "value": Decimal
    }
  }
}
Mutations

createWithdrawalRequest

Description

Requires scope: funding.write.

Response

Returns a UserWithdrawalRequest!

Arguments
Name Description
params - CreateUserWithdrawalRequestInput!

Example

Query
mutation createWithdrawalRequest($params: CreateUserWithdrawalRequestInput!) {
  createWithdrawalRequest(params: $params) {
    alpacaJournalId
    alpacaOutgoingTransfer {
      ...AlpacaOutgoingTransferFragment
    }
    amount
    createdAt
    gembrokerAccount {
      ...GemBrokerAccountFragment
    }
    id
    targetCurrency
    user {
      ...UserFragment
    }
    userProvidedReference
    wiseIncomingTransfer {
      ...WiseIncomingTransferFragment
    }
    wiseOutgoingTransfer {
      ...WiseOutgoingTransferFragment
    }
  }
}
Variables
{"params": CreateUserWithdrawalRequestInput}
Response
{
  "data": {
    "createWithdrawalRequest": {
      "alpacaJournalId": "xyz789",
      "alpacaOutgoingTransfer": AlpacaOutgoingTransfer,
      "amount": Decimal,
      "createdAt": GemDate,
      "gembrokerAccount": GemBrokerAccount,
      "id": "4",
      "targetCurrency": "AUD",
      "user": User,
      "userProvidedReference": "xyz789",
      "wiseIncomingTransfer": WiseIncomingTransfer,
      "wiseOutgoingTransfer": WiseOutgoingTransfer
    }
  }
}
Mutations

deleteAssistantThread

Description

Delete an assistant thread. Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - DeleteAssistantThreadByAssistantThreadIdInput!

Example

Query
mutation deleteAssistantThread($params: DeleteAssistantThreadByAssistantThreadIdInput!) {
  deleteAssistantThread(params: $params)
}
Variables
{"params": DeleteAssistantThreadByAssistantThreadIdInput}
Response
{"data": {"deleteAssistantThread": true}}
Mutations

deleteBrokerCredential

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - BrokerCredentialDeleteInput!

Example

Query
mutation deleteBrokerCredential($params: BrokerCredentialDeleteInput!) {
  deleteBrokerCredential(params: $params)
}
Variables
{"params": BrokerCredentialDeleteInput}
Response
{"data": {"deleteBrokerCredential": false}}
Mutations

deleteCard

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - DeleteCardInput!

Example

Query
mutation deleteCard($params: DeleteCardInput!) {
  deleteCard(params: $params)
}
Variables
{"params": DeleteCardInput}
Response
{"data": {"deleteCard": true}}
Mutations

deleteCryptoAutoSweep

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteCryptoAutoSweep($id: ID!) {
  deleteCryptoAutoSweep(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteCryptoAutoSweep": false}}
Mutations

deleteCustomInstrument

Description

Requires scope: portfolio.write.

Response

Returns a CustomInstrument!

Arguments
Name Description
symbol - String!

Example

Query
mutation deleteCustomInstrument($symbol: String!) {
  deleteCustomInstrument(symbol: $symbol) {
    createdAt
    currency
    delisted
    instrumentType
    logoUrl
    metaData {
      ...CustomInstrumentMetaDataFragment
    }
    name
    symbol
    unit
    updatedAt
  }
}
Variables
{"symbol": "xyz789"}
Response
{
  "data": {
    "deleteCustomInstrument": {
      "createdAt": "xyz789",
      "currency": "abc123",
      "delisted": false,
      "instrumentType": "abc123",
      "logoUrl": "abc123",
      "metaData": [CustomInstrumentMetaData],
      "name": "abc123",
      "symbol": "xyz789",
      "unit": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}
Mutations

deleteExpiredPendingUserTransactions

Description

Requires scope: funding.write.

Response

Returns a PendingUserTransaction!

Arguments
Name Description
params - DeletePendingUserTransactionInput!

Example

Query
mutation deleteExpiredPendingUserTransactions($params: DeletePendingUserTransactionInput!) {
  deleteExpiredPendingUserTransactions(params: $params) {
    amountDeposited
    createdAt
    currency
    estimatedExchangeRate
    id
    reference
    transactionType
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": DeletePendingUserTransactionInput}
Response
{
  "data": {
    "deleteExpiredPendingUserTransactions": {
      "amountDeposited": Decimal,
      "createdAt": GemDate,
      "currency": "AUD",
      "estimatedExchangeRate": Decimal,
      "id": "4",
      "reference": "xyz789",
      "transactionType": "DEPOSIT",
      "user": User
    }
  }
}
Mutations

deleteInstrumentFromPortfolio

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
input - DeleteInstrumentFromPortfolioInput!

Example

Query
mutation deleteInstrumentFromPortfolio($input: DeleteInstrumentFromPortfolioInput!) {
  deleteInstrumentFromPortfolio(input: $input)
}
Variables
{"input": DeleteInstrumentFromPortfolioInput}
Response
{"data": {"deleteInstrumentFromPortfolio": false}}
Mutations

deleteInstrumentPrice

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
input - DeleteInstrumentPriceInput!

Example

Query
mutation deleteInstrumentPrice($input: DeleteInstrumentPriceInput!) {
  deleteInstrumentPrice(input: $input)
}
Variables
{"input": DeleteInstrumentPriceInput}
Response
{"data": {"deleteInstrumentPrice": false}}
Mutations

deleteNetWorthDocument

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteNetWorthDocument($id: ID!) {
  deleteNetWorthDocument(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"deleteNetWorthDocument": false}}
Mutations

deleteNetWorthExpense

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteNetWorthExpense($id: ID!) {
  deleteNetWorthExpense(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"deleteNetWorthExpense": false}}
Mutations

deleteNetWorthFile

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
fileCode - String!

Example

Query
mutation deleteNetWorthFile($fileCode: String!) {
  deleteNetWorthFile(fileCode: $fileCode)
}
Variables
{"fileCode": "xyz789"}
Response
{"data": {"deleteNetWorthFile": false}}
Mutations

deleteNetWorthGoal

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteNetWorthGoal($id: ID!) {
  deleteNetWorthGoal(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"deleteNetWorthGoal": true}}
Mutations

deleteNetWorthIncome

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteNetWorthIncome($id: ID!) {
  deleteNetWorthIncome(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteNetWorthIncome": false}}
Mutations

deleteNetWorthLiability

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteNetWorthLiability($id: ID!) {
  deleteNetWorthLiability(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteNetWorthLiability": true}}
Mutations

deleteSavedBankAccount

Description

Removes your saved payout bank account. Requires scope: funding.write.

Response

Returns a WiseRecipient!

Example

Query
mutation deleteSavedBankAccount {
  deleteSavedBankAccount {
    createdAt
    currency
    id
    user {
      ...UserFragment
    }
    userProvidedName
    wiseRecipientId
  }
}
Response
{
  "data": {
    "deleteSavedBankAccount": {
      "createdAt": GemDate,
      "currency": "AUD",
      "id": "4",
      "user": User,
      "userProvidedName": "abc123",
      "wiseRecipientId": "abc123"
    }
  }
}
Mutations

deleteSavedPayoutAccount

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
provider - PaymentProviderSelection!

Example

Query
mutation deleteSavedPayoutAccount($provider: PaymentProviderSelection!) {
  deleteSavedPayoutAccount(provider: $provider)
}
Variables
{"provider": "EBURY"}
Response
{"data": {"deleteSavedPayoutAccount": true}}
Mutations

deleteStrategy

Description

Requires scope: portfolio.write.

Response

Returns a Strategy!

Arguments
Name Description
id - ID!

Example

Query
mutation deleteStrategy($id: ID!) {
  deleteStrategy(id: $id) {
    author {
      ...AuthorFragment
    }
    calculatedDays
    calculatedIRR
    calculatedReturn
    category
    createdAt
    description
    expectedYield
    history {
      ...StrategyHistoryFragment
    }
    historyCount
    id
    imageURL
    isVotingEnabled
    latestPerformance
    logoURL
    name
    oneMonthReturn
    performance {
      ...StrategyPerformanceFragment
    }
    periodReturns {
      ...StrategyPeriodReturnFragment
    }
    privacy
    subscriberCount
    targetWeights {
      ...StrategyAssetWeightFragment
    }
    topHolding {
      ...StrategyAssetWeightFragment
    }
    type
    videoLink
    votes {
      ...StrategyAssetVoteFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteStrategy": {
      "author": Author,
      "calculatedDays": 987,
      "calculatedIRR": Decimal,
      "calculatedReturn": Decimal,
      "category": "ACTIVIST",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "expectedYield": Decimal,
      "history": [StrategyHistory],
      "historyCount": 123,
      "id": "4",
      "imageURL": "xyz789",
      "isVotingEnabled": false,
      "latestPerformance": Decimal,
      "logoURL": "xyz789",
      "name": "xyz789",
      "oneMonthReturn": Decimal,
      "performance": [StrategyPerformance],
      "periodReturns": [StrategyPeriodReturn],
      "privacy": "PRIVATE",
      "subscriberCount": 987,
      "targetWeights": [StrategyAssetWeight],
      "topHolding": StrategyAssetWeight,
      "type": "COMMUNITY",
      "videoLink": "xyz789",
      "votes": [StrategyAssetVote]
    }
  }
}
Mutations

deleteWalletWatch

Description

Requires scope: portfolio.write.

Response

Returns a WalletWatch!

Arguments
Name Description
portfolioCode - String!
walletWatchCode - String!

Example

Query
mutation deleteWalletWatch(
  $portfolioCode: String!,
  $walletWatchCode: String!
) {
  deleteWalletWatch(
    portfolioCode: $portfolioCode,
    walletWatchCode: $walletWatchCode
  ) {
    address
    blockchain
    code
    lastSync
  }
}
Variables
{
  "portfolioCode": "abc123",
  "walletWatchCode": "abc123"
}
Response
{
  "data": {
    "deleteWalletWatch": {
      "address": "abc123",
      "blockchain": "xyz789",
      "code": "abc123",
      "lastSync": "xyz789"
    }
  }
}
Mutations

deleteWealthRelayPortfolio

Description

Requires scope: portfolio.write.

Response

Returns a Portfolio!

Arguments
Name Description
portfolioCode - String!

Example

Query
mutation deleteWealthRelayPortfolio($portfolioCode: String!) {
  deleteWealthRelayPortfolio(portfolioCode: $portfolioCode) {
    code
    metaData {
      ...PortfolioMetaDataFragment
    }
    name
    parentPortfolioCode
  }
}
Variables
{"portfolioCode": "abc123"}
Response
{
  "data": {
    "deleteWealthRelayPortfolio": {
      "code": "abc123",
      "metaData": [PortfolioMetaData],
      "name": "abc123",
      "parentPortfolioCode": "xyz789"
    }
  }
}
Mutations

deleteWealthRelayTrade

Description

Requires scope: trade.

Response

Returns a Trade!

Arguments
Name Description
tradeCode - String!

Example

Query
mutation deleteWealthRelayTrade($tradeCode: String!) {
  deleteWealthRelayTrade(tradeCode: $tradeCode) {
    brokerage
    comment
    market
    price
    quantity
    symbol
    thirdPartyId
    tradeCode
    tradeDate
    type
    value
  }
}
Variables
{"tradeCode": "xyz789"}
Response
{
  "data": {
    "deleteWealthRelayTrade": {
      "brokerage": Decimal,
      "comment": "abc123",
      "market": "abc123",
      "price": Decimal,
      "quantity": Decimal,
      "symbol": "abc123",
      "thirdPartyId": "abc123",
      "tradeCode": "xyz789",
      "tradeDate": GemDate,
      "type": "xyz789",
      "value": Decimal
    }
  }
}
Mutations

deleteWhitelistedWallet

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - DeleteWhitelistedWalletInput!

Example

Query
mutation deleteWhitelistedWallet($params: DeleteWhitelistedWalletInput!) {
  deleteWhitelistedWallet(params: $params)
}
Variables
{"params": DeleteWhitelistedWalletInput}
Response
{"data": {"deleteWhitelistedWallet": false}}
Mutations

editOrder

Description

Requires scope: trade.

Response

Returns a BrokerOrderOutput!

Arguments
Name Description
params - BrokerEditOrderInput!

Example

Query
mutation editOrder($params: BrokerEditOrderInput!) {
  editOrder(params: $params) {
    averageFilledPrice
    brokerCredentialId
    brokerType
    createdAt
    expiredAt
    fee
    filledAt
    id
    limitPrice
    notional
    premarket
    quantity
    quantityFilled
    side
    status
    stopPrice
    symbol
    timeInForce
    type
  }
}
Variables
{"params": BrokerEditOrderInput}
Response
{
  "data": {
    "editOrder": {
      "averageFilledPrice": Decimal,
      "brokerCredentialId": "abc123",
      "brokerType": "xyz789",
      "createdAt": "xyz789",
      "expiredAt": "xyz789",
      "fee": Decimal,
      "filledAt": "xyz789",
      "id": "abc123",
      "limitPrice": Decimal,
      "notional": Decimal,
      "premarket": true,
      "quantity": Decimal,
      "quantityFilled": Decimal,
      "side": "BUY",
      "status": "ACCEPTED",
      "stopPrice": Decimal,
      "symbol": "xyz789",
      "timeInForce": "CLS",
      "type": "LIMIT"
    }
  }
}
Mutations

emailLinkToInvestmentCalculator

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - EmailLinkToInvestmentCalculatorInput!

Example

Query
mutation emailLinkToInvestmentCalculator($params: EmailLinkToInvestmentCalculatorInput!) {
  emailLinkToInvestmentCalculator(params: $params)
}
Variables
{"params": EmailLinkToInvestmentCalculatorInput}
Response
{"data": {"emailLinkToInvestmentCalculator": false}}
Mutations

finalizeNetWorthDocument

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthDocument!

Arguments
Name Description
id - ID!

Example

Query
mutation finalizeNetWorthDocument($id: ID!) {
  finalizeNetWorthDocument(id: $id) {
    category
    contentType
    createdAt
    downloadUrl
    fileName
    id
    sizeBytes
    status
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "finalizeNetWorthDocument": {
      "category": "xyz789",
      "contentType": "xyz789",
      "createdAt": "abc123",
      "downloadUrl": "abc123",
      "fileName": "abc123",
      "id": "xyz789",
      "sizeBytes": 987,
      "status": "xyz789"
    }
  }
}
Mutations

fundPaperAccount

Description

Requires scope: trade.

Response

Returns a Boolean!

Arguments
Name Description
params - BrokerFundPaperAccountInput!

Example

Query
mutation fundPaperAccount($params: BrokerFundPaperAccountInput!) {
  fundPaperAccount(params: $params)
}
Variables
{"params": BrokerFundPaperAccountInput}
Response
{"data": {"fundPaperAccount": false}}
Mutations

generateLikeableAssets

Description

Requires scope: profile.write.

Response

Returns [LikeableAsset!]!

Example

Query
mutation generateLikeableAssets {
  generateLikeableAssets {
    assetId
    liked
    reason
  }
}
Response
{
  "data": {
    "generateLikeableAssets": [
      {
        "assetId": "4",
        "liked": true,
        "reason": "xyz789"
      }
    ]
  }
}
Mutations

generateNetWorthReport

Description

Requires scope: portfolio.read.

Response

Returns a String!

Example

Query
mutation generateNetWorthReport {
  generateNetWorthReport
}
Response
{
  "data": {
    "generateNetWorthReport": "abc123"
  }
}
Mutations

insertMessageIntoAssistantThread

Description

Insert a message into an existing assistant thread. Requires scope: profile.write.

Response

Returns an AssistantThread!

Arguments
Name Description
params - InsertMessageIntoAssistantThreadInput!

Example

Query
mutation insertMessageIntoAssistantThread($params: InsertMessageIntoAssistantThreadInput!) {
  insertMessageIntoAssistantThread(params: $params) {
    author {
      ...AuthorFragment
    }
    createdAt
    id
    messages {
      ...AssistantMessageFragment
    }
    name
    privacy
  }
}
Variables
{"params": InsertMessageIntoAssistantThreadInput}
Response
{
  "data": {
    "insertMessageIntoAssistantThread": {
      "author": Author,
      "createdAt": GemDate,
      "id": "4",
      "messages": [AssistantMessage],
      "name": "xyz789",
      "privacy": "PRIVATE"
    }
  }
}
Mutations

liquidateActiveStrategy

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
id - ID!

Example

Query
mutation liquidateActiveStrategy($id: ID!) {
  liquidateActiveStrategy(id: $id) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "liquidateActiveStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": "4",
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": true,
      "isScheduledContributionOn": true,
      "manualContributions": [ManualContribution],
      "name": "xyz789",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "abc123",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

liquidatePosition

Description

Requires scope: trade.

Response

Returns a BrokerOrderOutput!

Arguments
Name Description
params - BrokerLiquidatePositionInput!

Example

Query
mutation liquidatePosition($params: BrokerLiquidatePositionInput!) {
  liquidatePosition(params: $params) {
    averageFilledPrice
    brokerCredentialId
    brokerType
    createdAt
    expiredAt
    fee
    filledAt
    id
    limitPrice
    notional
    premarket
    quantity
    quantityFilled
    side
    status
    stopPrice
    symbol
    timeInForce
    type
  }
}
Variables
{"params": BrokerLiquidatePositionInput}
Response
{
  "data": {
    "liquidatePosition": {
      "averageFilledPrice": Decimal,
      "brokerCredentialId": "xyz789",
      "brokerType": "abc123",
      "createdAt": "xyz789",
      "expiredAt": "xyz789",
      "fee": Decimal,
      "filledAt": "xyz789",
      "id": "abc123",
      "limitPrice": Decimal,
      "notional": Decimal,
      "premarket": false,
      "quantity": Decimal,
      "quantityFilled": Decimal,
      "side": "BUY",
      "status": "ACCEPTED",
      "stopPrice": Decimal,
      "symbol": "abc123",
      "timeInForce": "CLS",
      "type": "LIMIT"
    }
  }
}
Mutations

markAllDepositsAsViewed

Description

Requires scope: funding.write.

Response

Returns an Int!

Example

Query
mutation markAllDepositsAsViewed {
  markAllDepositsAsViewed
}
Response
{"data": {"markAllDepositsAsViewed": 987}}
Mutations

markDepositAsViewed

Description

Requires scope: funding.write.

Response

Returns a Deposit!

Arguments
Name Description
params - MarkDepositAsViewedInput!

Example

Query
mutation markDepositAsViewed($params: MarkDepositAsViewedInput!) {
  markDepositAsViewed(params: $params) {
    NZDAmount
    NZDEburyFee
    NZDEccuityFee
    NZDFinalAmount
    NZDWiseFee
    USDAmount
    USDEburyFee
    USDEccuityFee
    USDFinalAmount
    USDWiseFee
    alpacaJournalCompletedAt
    alpacaJournalId
    alpacaJournalInitiatedAt
    createdAt
    cryptoAutoSweepId
    date
    hasSweepBuyOrder
    id
    lastViewedAt
    reference
    senderAccount
    senderName
    status
    updatedAt
    userEmail
    userName
    wiseReceivedAt
  }
}
Variables
{"params": MarkDepositAsViewedInput}
Response
{
  "data": {
    "markDepositAsViewed": {
      "NZDAmount": Decimal,
      "NZDEburyFee": Decimal,
      "NZDEccuityFee": Decimal,
      "NZDFinalAmount": Decimal,
      "NZDWiseFee": Decimal,
      "USDAmount": Decimal,
      "USDEburyFee": Decimal,
      "USDEccuityFee": Decimal,
      "USDFinalAmount": Decimal,
      "USDWiseFee": Decimal,
      "alpacaJournalCompletedAt": "2007-12-03T10:15:30Z",
      "alpacaJournalId": "xyz789",
      "alpacaJournalInitiatedAt": "2007-12-03T10:15:30Z",
      "createdAt": "2007-12-03T10:15:30Z",
      "cryptoAutoSweepId": "xyz789",
      "date": "2007-12-03T10:15:30Z",
      "hasSweepBuyOrder": true,
      "id": 4,
      "lastViewedAt": "2007-12-03T10:15:30Z",
      "reference": "xyz789",
      "senderAccount": "abc123",
      "senderName": "abc123",
      "status": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "userEmail": "xyz789",
      "userName": "abc123",
      "wiseReceivedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

markExportJobsViewed

Description

Requires scope: funding.read.

Response

Returns an Int!

Example

Query
mutation markExportJobsViewed {
  markExportJobsViewed
}
Response
{"data": {"markExportJobsViewed": 123}}
Mutations

optInInterest

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - OptInInterestInput!

Example

Query
mutation optInInterest($params: OptInInterestInput!) {
  optInInterest(params: $params)
}
Variables
{"params": OptInInterestInput}
Response
{"data": {"optInInterest": false}}
Mutations

placeOrder

Description

Requires scope: trade.

Response

Returns a BrokerOrderOutput!

Arguments
Name Description
params - BrokerPlaceOrderInput!

Example

Query
mutation placeOrder($params: BrokerPlaceOrderInput!) {
  placeOrder(params: $params) {
    averageFilledPrice
    brokerCredentialId
    brokerType
    createdAt
    expiredAt
    fee
    filledAt
    id
    limitPrice
    notional
    premarket
    quantity
    quantityFilled
    side
    status
    stopPrice
    symbol
    timeInForce
    type
  }
}
Variables
{"params": BrokerPlaceOrderInput}
Response
{
  "data": {
    "placeOrder": {
      "averageFilledPrice": Decimal,
      "brokerCredentialId": "xyz789",
      "brokerType": "xyz789",
      "createdAt": "abc123",
      "expiredAt": "xyz789",
      "fee": Decimal,
      "filledAt": "xyz789",
      "id": "abc123",
      "limitPrice": Decimal,
      "notional": Decimal,
      "premarket": true,
      "quantity": Decimal,
      "quantityFilled": Decimal,
      "side": "BUY",
      "status": "ACCEPTED",
      "stopPrice": Decimal,
      "symbol": "xyz789",
      "timeInForce": "CLS",
      "type": "LIMIT"
    }
  }
}
Mutations

rebalanceActiveStrategy

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
id - ID!

Example

Query
mutation rebalanceActiveStrategy($id: ID!) {
  rebalanceActiveStrategy(id: $id) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "rebalanceActiveStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": 4,
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": false,
      "isScheduledContributionOn": true,
      "manualContributions": [ManualContribution],
      "name": "xyz789",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "xyz789",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "abc123",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

recordPushReceipt

Description

Records delivery of a push notification. No auth required, so it can be called from service workers. Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - RecordPushReceiptInput!

Example

Query
mutation recordPushReceipt($params: RecordPushReceiptInput!) {
  recordPushReceipt(params: $params)
}
Variables
{"params": RecordPushReceiptInput}
Response
{"data": {"recordPushReceipt": false}}
Mutations

register

Description

Requires scope: public.

Response

Returns a User!

Arguments
Name Description
params - RegisterInput!

Example

Query
mutation register($params: RegisterInput!) {
  register(params: $params) {
    antiPhishingCode
    chartStartAtZero
    country
    createdAt
    cryptoSpreadFee
    depositWithdrawalFee
    eccuityInvestStatus
    email
    featureFlags
    firstName
    freeTradeCredit
    id
    interestRate
    interestRateStatus
    lastName
    maxActiveStrategies
    maxMonthlyAIMessages
    maxMonthlyAIThreads
    maxMonthlyStrategyCreation
    maxMonthlyStrategyViews
    maxStrategySubscriptions
    maxTradingFees
    mfaEnabled
    mfaQrCodeEnabled
    name
    netWorthAsHomePage
    oAuthLinks {
      ...OAuthLinkFragment
    }
    phoneNumber
    strategySubscriptions
    tradingFees
    usedActiveStrategies
    usedMonthlyAIMessages
    usedMonthlyAIThreads
    usedMonthlyStrategyCreation
    usedMonthlyStrategyViews
    usedStrategySubscriptions
    username
  }
}
Variables
{"params": RegisterInput}
Response
{
  "data": {
    "register": {
      "antiPhishingCode": "abc123",
      "chartStartAtZero": true,
      "country": "abc123",
      "createdAt": GemDate,
      "cryptoSpreadFee": Decimal,
      "depositWithdrawalFee": Decimal,
      "eccuityInvestStatus": "ACCOUNT_CLOSED",
      "email": "xyz789",
      "featureFlags": ["ADMIN"],
      "firstName": "abc123",
      "freeTradeCredit": Decimal,
      "id": 4,
      "interestRate": Decimal,
      "interestRateStatus": "abc123",
      "lastName": "abc123",
      "maxActiveStrategies": 987,
      "maxMonthlyAIMessages": 123,
      "maxMonthlyAIThreads": 123,
      "maxMonthlyStrategyCreation": 987,
      "maxMonthlyStrategyViews": 123,
      "maxStrategySubscriptions": 987,
      "maxTradingFees": Decimal,
      "mfaEnabled": true,
      "mfaQrCodeEnabled": false,
      "name": "xyz789",
      "netWorthAsHomePage": false,
      "oAuthLinks": [OAuthLink],
      "phoneNumber": "xyz789",
      "strategySubscriptions": ["abc123"],
      "tradingFees": Decimal,
      "usedActiveStrategies": 123,
      "usedMonthlyAIMessages": 123,
      "usedMonthlyAIThreads": 123,
      "usedMonthlyStrategyCreation": 123,
      "usedMonthlyStrategyViews": 987,
      "usedStrategySubscriptions": 987,
      "username": "abc123"
    }
  }
}
Mutations

registerDeviceToken

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - RegisterDeviceTokenInput!

Example

Query
mutation registerDeviceToken($params: RegisterDeviceTokenInput!) {
  registerDeviceToken(params: $params)
}
Variables
{"params": RegisterDeviceTokenInput}
Response
{"data": {"registerDeviceToken": true}}
Mutations

removeDeviceToken

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - RemoveDeviceTokenInput!

Example

Query
mutation removeDeviceToken($params: RemoveDeviceTokenInput!) {
  removeDeviceToken(params: $params)
}
Variables
{"params": RemoveDeviceTokenInput}
Response
{"data": {"removeDeviceToken": false}}
Mutations

removePasskey

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - RemovePasskeyInput!

Example

Query
mutation removePasskey($params: RemovePasskeyInput!) {
  removePasskey(params: $params)
}
Variables
{"params": RemovePasskeyInput}
Response
{"data": {"removePasskey": true}}
Mutations

renameNetWorthPortfolio

Description

Requires scope: portfolio.write.

Response

Returns a Portfolio!

Arguments
Name Description
name - String!
portfolioCode - String!

Example

Query
mutation renameNetWorthPortfolio(
  $name: String!,
  $portfolioCode: String!
) {
  renameNetWorthPortfolio(
    name: $name,
    portfolioCode: $portfolioCode
  ) {
    code
    metaData {
      ...PortfolioMetaDataFragment
    }
    name
    parentPortfolioCode
  }
}
Variables
{
  "name": "abc123",
  "portfolioCode": "abc123"
}
Response
{
  "data": {
    "renameNetWorthPortfolio": {
      "code": "xyz789",
      "metaData": [PortfolioMetaData],
      "name": "abc123",
      "parentPortfolioCode": "xyz789"
    }
  }
}
Mutations

requestCryptoWithdrawal

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - RequestCryptoWithdrawalInput!

Example

Query
mutation requestCryptoWithdrawal($params: RequestCryptoWithdrawalInput!) {
  requestCryptoWithdrawal(params: $params)
}
Variables
{"params": RequestCryptoWithdrawalInput}
Response
{"data": {"requestCryptoWithdrawal": false}}
Mutations

requestExport

Description

Requires scope: funding.read.

Response

Returns an ExportJobGql!

Arguments
Name Description
params - RequestExportInput!

Example

Query
mutation requestExport($params: RequestExportInput!) {
  requestExport(params: $params) {
    createdAt
    downloadUrl
    expiresAt
    id
    lastViewedAt
    name
    status
  }
}
Variables
{"params": RequestExportInput}
Response
{
  "data": {
    "requestExport": {
      "createdAt": "xyz789",
      "downloadUrl": "xyz789",
      "expiresAt": "xyz789",
      "id": "abc123",
      "lastViewedAt": "abc123",
      "name": "abc123",
      "status": "abc123"
    }
  }
}
Mutations

requestMfaEmail

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - RequestMfaEmailInput!

Example

Query
mutation requestMfaEmail($params: RequestMfaEmailInput!) {
  requestMfaEmail(params: $params)
}
Variables
{"params": RequestMfaEmailInput}
Response
{"data": {"requestMfaEmail": false}}
Mutations

requestPasswordReset

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - RequestPasswordResetInput!

Example

Query
mutation requestPasswordReset($params: RequestPasswordResetInput!) {
  requestPasswordReset(params: $params)
}
Variables
{"params": RequestPasswordResetInput}
Response
{"data": {"requestPasswordReset": true}}
Mutations

requestWhitelistWallet

Description

Requires scope: funding.write.

Response

Returns a TravelRuleResult!

Arguments
Name Description
params - RequestWhitelistedWalletInput!

Example

Query
mutation requestWhitelistWallet($params: RequestWhitelistedWalletInput!) {
  requestWhitelistWallet(params: $params) {
    message
    nextActions {
      ...TravelRuleNextActionFragment
    }
    success
    travelRuleActionRequired
  }
}
Variables
{"params": RequestWhitelistedWalletInput}
Response
{
  "data": {
    "requestWhitelistWallet": {
      "message": "abc123",
      "nextActions": [TravelRuleNextAction],
      "success": false,
      "travelRuleActionRequired": true
    }
  }
}
Mutations

resendVerificationEmail

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - ResendVerificationEmailInput!

Example

Query
mutation resendVerificationEmail($params: ResendVerificationEmailInput!) {
  resendVerificationEmail(params: $params)
}
Variables
{"params": ResendVerificationEmailInput}
Response
{"data": {"resendVerificationEmail": true}}
Mutations

resetPassword

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - ResetPasswordInput!

Example

Query
mutation resetPassword($params: ResetPasswordInput!) {
  resetPassword(params: $params)
}
Variables
{"params": ResetPasswordInput}
Response
{"data": {"resetPassword": false}}
Mutations

retryNetWorthFileExtraction

Description

Requires scope: portfolio.write.

Response

Returns a Boolean!

Arguments
Name Description
fileCode - String!

Example

Query
mutation retryNetWorthFileExtraction($fileCode: String!) {
  retryNetWorthFileExtraction(fileCode: $fileCode)
}
Variables
{"fileCode": "xyz789"}
Response
{"data": {"retryNetWorthFileExtraction": true}}
Mutations

retryTradeEmail

Description

Requires scope: portfolio.write.

Response

Returns a TradeEmail!

Arguments
Name Description
portfolioCode - String!
tradeEmailCode - String!

Example

Query
mutation retryTradeEmail(
  $portfolioCode: String!,
  $tradeEmailCode: String!
) {
  retryTradeEmail(
    portfolioCode: $portfolioCode,
    tradeEmailCode: $tradeEmailCode
  ) {
    code
    from
    html
    importStatus
    receivedAt
    subject
    text
  }
}
Variables
{
  "portfolioCode": "xyz789",
  "tradeEmailCode": "xyz789"
}
Response
{
  "data": {
    "retryTradeEmail": {
      "code": "abc123",
      "from": "abc123",
      "html": "xyz789",
      "importStatus": "FAILED",
      "receivedAt": "xyz789",
      "subject": "abc123",
      "text": "abc123"
    }
  }
}
Mutations

saveBankAccountNZD

Description

Requires scope: funding.write.

Response

Returns a WiseRecipient!

Arguments
Name Description
params - CreateNZDBankAccountInput!

Example

Query
mutation saveBankAccountNZD($params: CreateNZDBankAccountInput!) {
  saveBankAccountNZD(params: $params) {
    createdAt
    currency
    id
    user {
      ...UserFragment
    }
    userProvidedName
    wiseRecipientId
  }
}
Variables
{"params": CreateNZDBankAccountInput}
Response
{
  "data": {
    "saveBankAccountNZD": {
      "createdAt": GemDate,
      "currency": "AUD",
      "id": "4",
      "user": User,
      "userProvidedName": "abc123",
      "wiseRecipientId": "abc123"
    }
  }
}
Mutations

saveBankAccountUSD

Description

Requires scope: funding.write.

Response

Returns a WiseRecipient!

Arguments
Name Description
params - CreateUSDBankAccountInput!

Example

Query
mutation saveBankAccountUSD($params: CreateUSDBankAccountInput!) {
  saveBankAccountUSD(params: $params) {
    createdAt
    currency
    id
    user {
      ...UserFragment
    }
    userProvidedName
    wiseRecipientId
  }
}
Variables
{"params": CreateUSDBankAccountInput}
Response
{
  "data": {
    "saveBankAccountUSD": {
      "createdAt": GemDate,
      "currency": "AUD",
      "id": "4",
      "user": User,
      "userProvidedName": "abc123",
      "wiseRecipientId": "xyz789"
    }
  }
}
Mutations

saveBrokerCredential

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - BrokerCredentialInput!

Example

Query
mutation saveBrokerCredential($params: BrokerCredentialInput!) {
  saveBrokerCredential(params: $params)
}
Variables
{"params": BrokerCredentialInput}
Response
{"data": {"saveBrokerCredential": true}}
Mutations

saveInvestorPreferences

Description

Requires scope: profile.write.

Response

Returns an InvestorPreferences!

Arguments
Name Description
params - InvestorPreferencesInput!

Example

Query
mutation saveInvestorPreferences($params: InvestorPreferencesInput!) {
  saveInvestorPreferences(params: $params) {
    assetClasses
    assistantContactFrequency
    createdAt
    generatedAssetLists {
      ...GeneratedAssetListFragment
    }
    id
    investingObjectives
    investingStyle
    likeableAssets {
      ...LikeableAssetFragment
    }
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": InvestorPreferencesInput}
Response
{
  "data": {
    "saveInvestorPreferences": {
      "assetClasses": ["xyz789"],
      "assistantContactFrequency": "DAILY",
      "createdAt": GemDate,
      "generatedAssetLists": [GeneratedAssetList],
      "id": "4",
      "investingObjectives": ["xyz789"],
      "investingStyle": "xyz789",
      "likeableAssets": [LikeableAsset],
      "user": User
    }
  }
}
Mutations

saveNewCard

Description

Requires scope: funding.write.

Response

Returns a Card!

Arguments
Name Description
params - NewCardInput!

Example

Query
mutation saveNewCard($params: NewCardInput!) {
  saveNewCard(params: $params) {
    brand
    expMonth
    expYear
    id
    last4
  }
}
Variables
{"params": NewCardInput}
Response
{
  "data": {
    "saveNewCard": {
      "brand": "abc123",
      "expMonth": 123,
      "expYear": 987,
      "id": "abc123",
      "last4": "abc123"
    }
  }
}
Mutations

savePayoutBankAccountNZD

Description

Requires scope: funding.write.

Response

Returns a PayoutRecipient!

Arguments
Name Description
params - CreateNZDBankAccountInput!
provider - PaymentProviderSelection!

Example

Query
mutation savePayoutBankAccountNZD(
  $params: CreateNZDBankAccountInput!,
  $provider: PaymentProviderSelection!
) {
  savePayoutBankAccountNZD(
    params: $params,
    provider: $provider
  ) {
    currency
    externalRecipientId
    id
    lastError
    migrationStatus
    provider
    providerAccountId
    userProvidedName
  }
}
Variables
{"params": CreateNZDBankAccountInput, "provider": "EBURY"}
Response
{
  "data": {
    "savePayoutBankAccountNZD": {
      "currency": "AUD",
      "externalRecipientId": "abc123",
      "id": "abc123",
      "lastError": "xyz789",
      "migrationStatus": "abc123",
      "provider": "EBURY",
      "providerAccountId": "abc123",
      "userProvidedName": "abc123"
    }
  }
}
Mutations

savePayoutBankAccountUSD

Description

Requires scope: funding.write.

Response

Returns a PayoutRecipient!

Arguments
Name Description
params - CreateUSDBankAccountInput!
provider - PaymentProviderSelection!

Example

Query
mutation savePayoutBankAccountUSD(
  $params: CreateUSDBankAccountInput!,
  $provider: PaymentProviderSelection!
) {
  savePayoutBankAccountUSD(
    params: $params,
    provider: $provider
  ) {
    currency
    externalRecipientId
    id
    lastError
    migrationStatus
    provider
    providerAccountId
    userProvidedName
  }
}
Variables
{"params": CreateUSDBankAccountInput, "provider": "EBURY"}
Response
{
  "data": {
    "savePayoutBankAccountUSD": {
      "currency": "AUD",
      "externalRecipientId": "xyz789",
      "id": "xyz789",
      "lastError": "xyz789",
      "migrationStatus": "abc123",
      "provider": "EBURY",
      "providerAccountId": "abc123",
      "userProvidedName": "abc123"
    }
  }
}
Mutations

setActiveStrategyStatus

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
active - Boolean!
id - ID!

Example

Query
mutation setActiveStrategyStatus(
  $active: Boolean!,
  $id: ID!
) {
  setActiveStrategyStatus(
    active: $active,
    id: $id
  ) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"active": false, "id": 4}
Response
{
  "data": {
    "setActiveStrategyStatus": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": "4",
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": true,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "abc123",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "abc123",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

setAssetShares

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
params - AdjustSharesInput!

Example

Query
mutation setAssetShares($params: AdjustSharesInput!) {
  setAssetShares(params: $params) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"params": AdjustSharesInput}
Response
{
  "data": {
    "setAssetShares": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": 4,
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": true,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "abc123",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "abc123",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

setCustomInstrumentMetaData

Description

Requires scope: portfolio.write.

Response

Returns a CustomInstrumentMetaData!

Arguments
Name Description
key - String!
symbol - String!
value - String!

Example

Query
mutation setCustomInstrumentMetaData(
  $key: String!,
  $symbol: String!,
  $value: String!
) {
  setCustomInstrumentMetaData(
    key: $key,
    symbol: $symbol,
    value: $value
  ) {
    key
    value
  }
}
Variables
{
  "key": "abc123",
  "symbol": "abc123",
  "value": "abc123"
}
Response
{
  "data": {
    "setCustomInstrumentMetaData": {
      "key": "abc123",
      "value": "abc123"
    }
  }
}
Mutations

setPortfolioEmailSettings

Description

Requires scope: portfolio.write.

Response

Returns a PortfolioEmailInfo!

Arguments
Name Description
emailEnabled - Boolean!
portfolioCode - String!

Example

Query
mutation setPortfolioEmailSettings(
  $emailEnabled: Boolean!,
  $portfolioCode: String!
) {
  setPortfolioEmailSettings(
    emailEnabled: $emailEnabled,
    portfolioCode: $portfolioCode
  ) {
    code
    email
    emailEnabled
    name
    tradeEmails {
      ...TradeEmailFragment
    }
  }
}
Variables
{
  "emailEnabled": true,
  "portfolioCode": "abc123"
}
Response
{
  "data": {
    "setPortfolioEmailSettings": {
      "code": "abc123",
      "email": "abc123",
      "emailEnabled": false,
      "name": "abc123",
      "tradeEmails": [TradeEmail]
    }
  }
}
Mutations

signAgreements

Description

Requires scope: funding.write.

Response

Returns [AccountAgreementInfo!]!

Arguments
Name Description
params - SignAgreementsInput!

Example

Query
mutation signAgreements($params: SignAgreementsInput!) {
  signAgreements(params: $params) {
    agreement
    revision
    signedAt
  }
}
Variables
{"params": SignAgreementsInput}
Response
{
  "data": {
    "signAgreements": [
      {
        "agreement": "xyz789",
        "revision": "xyz789",
        "signedAt": "abc123"
      }
    ]
  }
}
Mutations

signCustomerAgreement

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - SignCustomerAgreementInput!

Example

Query
mutation signCustomerAgreement($params: SignCustomerAgreementInput!) {
  signCustomerAgreement(params: $params)
}
Variables
{"params": SignCustomerAgreementInput}
Response
{"data": {"signCustomerAgreement": false}}
Mutations

simulatePaperDeposit

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
input - SimulatePaperDepositInput!

Example

Query
mutation simulatePaperDeposit($input: SimulatePaperDepositInput!) {
  simulatePaperDeposit(input: $input)
}
Variables
{"input": SimulatePaperDepositInput}
Response
{"data": {"simulatePaperDeposit": false}}
Mutations

startAssistantThreadWithMessage

Description

Starts a new assistant thread with an initial message. Checks your monthly thread quota first. Requires scope: profile.write.

Response

Returns an AssistantThread!

Arguments
Name Description
params - StartAssistantThreadWithMessageInput!

Example

Query
mutation startAssistantThreadWithMessage($params: StartAssistantThreadWithMessageInput!) {
  startAssistantThreadWithMessage(params: $params) {
    author {
      ...AuthorFragment
    }
    createdAt
    id
    messages {
      ...AssistantMessageFragment
    }
    name
    privacy
  }
}
Variables
{"params": StartAssistantThreadWithMessageInput}
Response
{
  "data": {
    "startAssistantThreadWithMessage": {
      "author": Author,
      "createdAt": GemDate,
      "id": "4",
      "messages": [AssistantMessage],
      "name": "abc123",
      "privacy": "PRIVATE"
    }
  }
}
Mutations

submitKyc

Description

Requires scope: profile.write.

Response

Returns a GemBrokerAccount!

Example

Query
mutation submitKyc {
  submitKyc {
    alpacaAccountId
    alpacaAccountNumber
    brokerProvider
    buyingPower
    createdAt
    depositReference
    environment
    equity
    id
    kycRequirements {
      ...UserKYCRequirementsFragment
    }
    owner {
      ...UserFragment
    }
    status
    userProvidedName
  }
}
Response
{
  "data": {
    "submitKyc": {
      "alpacaAccountId": "xyz789",
      "alpacaAccountNumber": "abc123",
      "brokerProvider": "ALPACA",
      "buyingPower": Decimal,
      "createdAt": GemDate,
      "depositReference": "abc123",
      "environment": "LIVE",
      "equity": Decimal,
      "id": "4",
      "kycRequirements": UserKYCRequirements,
      "owner": User,
      "status": "abc123",
      "userProvidedName": "abc123"
    }
  }
}
Mutations

subscribeToNewsletter

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - NewsletterRegisterInput!

Example

Query
mutation subscribeToNewsletter($params: NewsletterRegisterInput!) {
  subscribeToNewsletter(params: $params)
}
Variables
{"params": NewsletterRegisterInput}
Response
{"data": {"subscribeToNewsletter": true}}
Mutations

subscribeToStrategy

Description

Requires scope: trade.

Response

Returns a Boolean!

Arguments
Name Description
strategyId - ID!

Example

Query
mutation subscribeToStrategy($strategyId: ID!) {
  subscribeToStrategy(strategyId: $strategyId)
}
Variables
{"strategyId": "4"}
Response
{"data": {"subscribeToStrategy": false}}
Mutations

subscribeUser

Description

Requires scope: funding.write.

Response

Returns a Boolean!

Arguments
Name Description
params - NewSubscriptionInput!

Example

Query
mutation subscribeUser($params: NewSubscriptionInput!) {
  subscribeUser(params: $params)
}
Variables
{"params": NewSubscriptionInput}
Response
{"data": {"subscribeUser": true}}
Mutations

syncWithSourceStrategy

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
id - ID!

Example

Query
mutation syncWithSourceStrategy($id: ID!) {
  syncWithSourceStrategy(id: $id) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "syncWithSourceStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": 4,
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": true,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "abc123",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "xyz789",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

toggleLike

Description

Requires scope: profile.write.

Response

Returns a Like!

Arguments
Name Description
params - ToggleLikeInput!

Example

Query
mutation toggleLike($params: ToggleLikeInput!) {
  toggleLike(params: $params) {
    ... on AssetLike {
      ...AssetLikeFragment
    }
    ... on AssistantThreadLike {
      ...AssistantThreadLikeFragment
    }
  }
}
Variables
{"params": ToggleLikeInput}
Response
{"data": {"toggleLike": AssetLike}}
Mutations

unregisterDeviceToken

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - UnregisterDeviceTokenInput!

Example

Query
mutation unregisterDeviceToken($params: UnregisterDeviceTokenInput!) {
  unregisterDeviceToken(params: $params)
}
Variables
{"params": UnregisterDeviceTokenInput}
Response
{"data": {"unregisterDeviceToken": false}}
Mutations

unsubscribeFromStrategy

Description

Requires scope: trade.

Response

Returns a Boolean!

Arguments
Name Description
strategyId - ID!

Example

Query
mutation unsubscribeFromStrategy($strategyId: ID!) {
  unsubscribeFromStrategy(strategyId: $strategyId)
}
Variables
{"strategyId": 4}
Response
{"data": {"unsubscribeFromStrategy": true}}
Mutations

updateActiveStrategy

Description

Requires scope: trade.

Response

Returns an ActiveStrategy!

Arguments
Name Description
params - UpdateActiveStrategyInput!

Example

Query
mutation updateActiveStrategy($params: UpdateActiveStrategyInput!) {
  updateActiveStrategy(params: $params) {
    assets {
      ...ActiveStrategyAssetFragment
    }
    brokerAccountId
    createdAt
    dailyPL
    dailyPLPercentage
    history {
      ...ActiveStrategyHistoryFragment
    }
    id
    initialInvestmentAmount
    initialInvestmentOrders {
      ...OrderFragment
    }
    initialInvestmentPortionType
    isRebalanceOn
    isScheduledContributionOn
    manualContributions {
      ...ManualContributionFragment
    }
    name
    performance {
      ...StrategyPerformanceFragment
    }
    rebalanceFrequency
    rebalances {
      ...RebalanceFragment
    }
    scheduledContributionAmount
    scheduledContributionFrequency
    scheduledContributionPortionType
    scheduledContributions {
      ...ScheduledContributionFragment
    }
    sourceStrategyId
    status
    subscribedStrategyHistory {
      ...StrategyHistoryFragment
    }
    subscribedStrategyHistoryId
    totalInvestment
    totalPL
    totalPLPercentage
    totalValue
  }
}
Variables
{"params": UpdateActiveStrategyInput}
Response
{
  "data": {
    "updateActiveStrategy": {
      "assets": [ActiveStrategyAsset],
      "brokerAccountId": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "dailyPL": Decimal,
      "dailyPLPercentage": Decimal,
      "history": [ActiveStrategyHistory],
      "id": 4,
      "initialInvestmentAmount": Decimal,
      "initialInvestmentOrders": [Order],
      "initialInvestmentPortionType": "AMOUNT",
      "isRebalanceOn": false,
      "isScheduledContributionOn": false,
      "manualContributions": [ManualContribution],
      "name": "abc123",
      "performance": [StrategyPerformance],
      "rebalanceFrequency": "ANNUALLY",
      "rebalances": [Rebalance],
      "scheduledContributionAmount": Decimal,
      "scheduledContributionFrequency": "FORTNIGHT_START",
      "scheduledContributionPortionType": "AMOUNT",
      "scheduledContributions": [ScheduledContribution],
      "sourceStrategyId": "abc123",
      "status": "ACTIVE",
      "subscribedStrategyHistory": StrategyHistory,
      "subscribedStrategyHistoryId": "xyz789",
      "totalInvestment": Decimal,
      "totalPL": Decimal,
      "totalPLPercentage": Decimal,
      "totalValue": Decimal
    }
  }
}
Mutations

updateAntiPhishingCode

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
code - String

Example

Query
mutation updateAntiPhishingCode($code: String) {
  updateAntiPhishingCode(code: $code)
}
Variables
{"code": "abc123"}
Response
{"data": {"updateAntiPhishingCode": false}}
Mutations

updateAssistantThread

Description

Update an assistant thread (e.g. rename, toggle like). Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - UpdateAssistantThreadInput!

Example

Query
mutation updateAssistantThread($params: UpdateAssistantThreadInput!) {
  updateAssistantThread(params: $params)
}
Variables
{"params": UpdateAssistantThreadInput}
Response
{"data": {"updateAssistantThread": false}}
Mutations

updateChartStartAtZero

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
chartStartAtZero - Boolean!

Example

Query
mutation updateChartStartAtZero($chartStartAtZero: Boolean!) {
  updateChartStartAtZero(chartStartAtZero: $chartStartAtZero)
}
Variables
{"chartStartAtZero": false}
Response
{"data": {"updateChartStartAtZero": false}}
Mutations

updateCustomInstrument

Description

Requires scope: portfolio.write.

Response

Returns a CustomInstrument!

Arguments
Name Description
input - UpdateCustomInstrumentInput!

Example

Query
mutation updateCustomInstrument($input: UpdateCustomInstrumentInput!) {
  updateCustomInstrument(input: $input) {
    createdAt
    currency
    delisted
    instrumentType
    logoUrl
    metaData {
      ...CustomInstrumentMetaDataFragment
    }
    name
    symbol
    unit
    updatedAt
  }
}
Variables
{"input": UpdateCustomInstrumentInput}
Response
{
  "data": {
    "updateCustomInstrument": {
      "createdAt": "abc123",
      "currency": "xyz789",
      "delisted": true,
      "instrumentType": "abc123",
      "logoUrl": "xyz789",
      "metaData": [CustomInstrumentMetaData],
      "name": "xyz789",
      "symbol": "abc123",
      "unit": "xyz789",
      "updatedAt": "xyz789"
    }
  }
}
Mutations

updateEccuityInvestAccountConfig

Description

Requires scope: profile.write.

Response

Returns an AccountTradingConfiguration!

Arguments
Name Description
params - AccountTradingConfigurationInput!

Example

Query
mutation updateEccuityInvestAccountConfig($params: AccountTradingConfigurationInput!) {
  updateEccuityInvestAccountConfig(params: $params) {
    autoReinvestDividends
    dtbpCheck
    fractionalTrading
    maxMarginMultiplier
    noShorting
    pdtCheck
    tradeConfirmEmail
    tradeSuspendedByUser
  }
}
Variables
{"params": AccountTradingConfigurationInput}
Response
{
  "data": {
    "updateEccuityInvestAccountConfig": {
      "autoReinvestDividends": true,
      "dtbpCheck": "abc123",
      "fractionalTrading": false,
      "maxMarginMultiplier": 987,
      "noShorting": true,
      "pdtCheck": "abc123",
      "tradeConfirmEmail": false,
      "tradeSuspendedByUser": false
    }
  }
}
Mutations

updateInstrumentPrice

Description

Requires scope: portfolio.write.

Response

Returns a WealthrelayInstrumentPrice!

Arguments
Name Description
input - UpdateInstrumentPriceInput!

Example

Query
mutation updateInstrumentPrice($input: UpdateInstrumentPriceInput!) {
  updateInstrumentPrice(input: $input) {
    close
    currency
    date
    high
    low
    open
  }
}
Variables
{"input": UpdateInstrumentPriceInput}
Response
{
  "data": {
    "updateInstrumentPrice": {
      "close": Decimal,
      "currency": "abc123",
      "date": "xyz789",
      "high": Decimal,
      "low": Decimal,
      "open": Decimal
    }
  }
}
Mutations

updateMfa

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - UpdateMfaInput!

Example

Query
mutation updateMfa($params: UpdateMfaInput!) {
  updateMfa(params: $params)
}
Variables
{"params": UpdateMfaInput}
Response
{"data": {"updateMfa": true}}
Mutations

updateMfaQrCode

Description

Requires scope: profile.write.

Response

Returns a String!

Arguments
Name Description
params - UpdateMfaQrCodeInput!

Example

Query
mutation updateMfaQrCode($params: UpdateMfaQrCodeInput!) {
  updateMfaQrCode(params: $params)
}
Variables
{"params": UpdateMfaQrCodeInput}
Response
{"data": {"updateMfaQrCode": "xyz789"}}
Mutations

updateNetWorthAsHomePage

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
netWorthAsHomePage - Boolean!

Example

Query
mutation updateNetWorthAsHomePage($netWorthAsHomePage: Boolean!) {
  updateNetWorthAsHomePage(netWorthAsHomePage: $netWorthAsHomePage)
}
Variables
{"netWorthAsHomePage": true}
Response
{"data": {"updateNetWorthAsHomePage": false}}
Mutations

updateNetWorthDisplayCurrency

Description

Requires scope: portfolio.write.

Response

Returns a String!

Arguments
Name Description
currency - String!

Example

Query
mutation updateNetWorthDisplayCurrency($currency: String!) {
  updateNetWorthDisplayCurrency(currency: $currency)
}
Variables
{"currency": "abc123"}
Response
{
  "data": {
    "updateNetWorthDisplayCurrency": "abc123"
  }
}
Mutations

updateNetWorthExpense

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthExpense!

Arguments
Name Description
id - ID!
input - UpdateNetWorthExpenseInput!

Example

Query
mutation updateNetWorthExpense(
  $id: ID!,
  $input: UpdateNetWorthExpenseInput!
) {
  updateNetWorthExpense(
    id: $id,
    input: $input
  ) {
    category
    createdAt
    description
    householdId
    id
    monthlyAmount
    updatedAt
  }
}
Variables
{"id": 4, "input": UpdateNetWorthExpenseInput}
Response
{
  "data": {
    "updateNetWorthExpense": {
      "category": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "householdId": "xyz789",
      "id": "abc123",
      "monthlyAmount": Decimal,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateNetWorthGoal

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthGoal!

Arguments
Name Description
id - ID!
input - UpdateNetWorthGoalInput!

Example

Query
mutation updateNetWorthGoal(
  $id: ID!,
  $input: UpdateNetWorthGoalInput!
) {
  updateNetWorthGoal(
    id: $id,
    input: $input
  ) {
    attachedAssetIds
    attachedLiabilityIds
    createdAt
    currentAmount
    description
    householdId
    id
    isFinancial
    name
    priority
    status
    targetAmount
    targetDate
    updatedAt
  }
}
Variables
{"id": 4, "input": UpdateNetWorthGoalInput}
Response
{
  "data": {
    "updateNetWorthGoal": {
      "attachedAssetIds": ["abc123"],
      "attachedLiabilityIds": ["abc123"],
      "createdAt": "2007-12-03T10:15:30Z",
      "currentAmount": Decimal,
      "description": "abc123",
      "householdId": "xyz789",
      "id": "abc123",
      "isFinancial": false,
      "name": "abc123",
      "priority": "abc123",
      "status": "xyz789",
      "targetAmount": Decimal,
      "targetDate": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateNetWorthIncome

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthIncome!

Arguments
Name Description
id - ID!
input - UpdateNetWorthIncomeInput!

Example

Query
mutation updateNetWorthIncome(
  $id: ID!,
  $input: UpdateNetWorthIncomeInput!
) {
  updateNetWorthIncome(
    id: $id,
    input: $input
  ) {
    annualAmount
    createdAt
    description
    householdId
    id
    isAfterTax
    source
    updatedAt
  }
}
Variables
{"id": 4, "input": UpdateNetWorthIncomeInput}
Response
{
  "data": {
    "updateNetWorthIncome": {
      "annualAmount": Decimal,
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "abc123",
      "householdId": "xyz789",
      "id": "abc123",
      "isAfterTax": true,
      "source": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateNetWorthLiability

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthLiability!

Arguments
Name Description
id - ID!
input - UpdateNetWorthLiabilityInput!

Example

Query
mutation updateNetWorthLiability(
  $id: ID!,
  $input: UpdateNetWorthLiabilityInput!
) {
  updateNetWorthLiability(
    id: $id,
    input: $input
  ) {
    createdAt
    currentBalance
    description
    householdId
    id
    interestRate
    monthlyPayment
    originalAmount
    remainingTerm
    type
    updatedAt
  }
}
Variables
{"id": 4, "input": UpdateNetWorthLiabilityInput}
Response
{
  "data": {
    "updateNetWorthLiability": {
      "createdAt": "2007-12-03T10:15:30Z",
      "currentBalance": Decimal,
      "description": "xyz789",
      "householdId": "abc123",
      "id": "abc123",
      "interestRate": Decimal,
      "monthlyPayment": Decimal,
      "originalAmount": Decimal,
      "remainingTerm": "xyz789",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateOnfidoOutcome

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - OnfidoOutcomeInput!

Example

Query
mutation updateOnfidoOutcome($params: OnfidoOutcomeInput!) {
  updateOnfidoOutcome(params: $params)
}
Variables
{"params": OnfidoOutcomeInput}
Response
{"data": {"updateOnfidoOutcome": true}}
Mutations

updateStrategy

Description

Requires scope: portfolio.write.

Response

Returns a Strategy!

Arguments
Name Description
params - UpdateStrategyInput!

Example

Query
mutation updateStrategy($params: UpdateStrategyInput!) {
  updateStrategy(params: $params) {
    author {
      ...AuthorFragment
    }
    calculatedDays
    calculatedIRR
    calculatedReturn
    category
    createdAt
    description
    expectedYield
    history {
      ...StrategyHistoryFragment
    }
    historyCount
    id
    imageURL
    isVotingEnabled
    latestPerformance
    logoURL
    name
    oneMonthReturn
    performance {
      ...StrategyPerformanceFragment
    }
    periodReturns {
      ...StrategyPeriodReturnFragment
    }
    privacy
    subscriberCount
    targetWeights {
      ...StrategyAssetWeightFragment
    }
    topHolding {
      ...StrategyAssetWeightFragment
    }
    type
    videoLink
    votes {
      ...StrategyAssetVoteFragment
    }
  }
}
Variables
{"params": UpdateStrategyInput}
Response
{
  "data": {
    "updateStrategy": {
      "author": Author,
      "calculatedDays": 987,
      "calculatedIRR": Decimal,
      "calculatedReturn": Decimal,
      "category": "ACTIVIST",
      "createdAt": "2007-12-03T10:15:30Z",
      "description": "xyz789",
      "expectedYield": Decimal,
      "history": [StrategyHistory],
      "historyCount": 987,
      "id": 4,
      "imageURL": "xyz789",
      "isVotingEnabled": true,
      "latestPerformance": Decimal,
      "logoURL": "xyz789",
      "name": "abc123",
      "oneMonthReturn": Decimal,
      "performance": [StrategyPerformance],
      "periodReturns": [StrategyPeriodReturn],
      "privacy": "PRIVATE",
      "subscriberCount": 123,
      "targetWeights": [StrategyAssetWeight],
      "topHolding": StrategyAssetWeight,
      "type": "COMMUNITY",
      "videoLink": "xyz789",
      "votes": [StrategyAssetVote]
    }
  }
}
Mutations

updateUserAccount

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - UpdateUserAccountInput!

Example

Query
mutation updateUserAccount($params: UpdateUserAccountInput!) {
  updateUserAccount(params: $params)
}
Variables
{"params": UpdateUserAccountInput}
Response
{"data": {"updateUserAccount": false}}
Mutations

updateUserKycAgreements

Description

Requires scope: profile.write.

Response

Returns [UserKYCAgreement!]!

Arguments
Name Description
params - [UpdateUserKycAgreementInput!]!

Example

Query
mutation updateUserKycAgreements($params: [UpdateUserKycAgreementInput!]!) {
  updateUserKycAgreements(params: $params) {
    agreement
    createdAt
    id
    ipAddress
    revision
    signedAt
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": [UpdateUserKycAgreementInput]}
Response
{
  "data": {
    "updateUserKycAgreements": [
      {
        "agreement": "ACCOUNT",
        "createdAt": GemDate,
        "id": "4",
        "ipAddress": "xyz789",
        "revision": "abc123",
        "signedAt": "abc123",
        "user": User
      }
    ]
  }
}
Mutations

updateUserKycCompanySetup

Description

Requires scope: profile.write.

Response

Returns a CompanySetup!

Arguments
Name Description
params - UpdateUserKycCompanySetupInput!

Example

Query
mutation updateUserKycCompanySetup($params: UpdateUserKycCompanySetupInput!) {
  updateUserKycCompanySetup(params: $params) {
    createdAt
    id
    name
    phoneNumber
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": UpdateUserKycCompanySetupInput}
Response
{
  "data": {
    "updateUserKycCompanySetup": {
      "createdAt": GemDate,
      "id": 4,
      "name": "abc123",
      "phoneNumber": "xyz789",
      "user": User
    }
  }
}
Mutations

updateUserKycContactInformation

Description

Requires scope: profile.write.

Response

Returns a UserKYCContactInformation!

Arguments
Name Description
params - UpdateUserKycContactInformationInput!

Example

Query
mutation updateUserKycContactInformation($params: UpdateUserKycContactInformationInput!) {
  updateUserKycContactInformation(params: $params) {
    city
    createdAt
    emailAddress
    id
    phoneNumber
    postalCode
    state
    streetAddress
    unit
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": UpdateUserKycContactInformationInput}
Response
{
  "data": {
    "updateUserKycContactInformation": {
      "city": "abc123",
      "createdAt": GemDate,
      "emailAddress": "xyz789",
      "id": "4",
      "phoneNumber": "abc123",
      "postalCode": "abc123",
      "state": "xyz789",
      "streetAddress": ["abc123"],
      "unit": "xyz789",
      "user": User
    }
  }
}
Mutations

updateUserKycDisclosures

Description

Requires scope: profile.write.

Response

Returns a UserKYCDisclosures!

Arguments
Name Description
params - UpdateUserKycDisclosuresInput!

Example

Query
mutation updateUserKycDisclosures($params: UpdateUserKycDisclosuresInput!) {
  updateUserKycDisclosures(params: $params) {
    contexts {
      ...IUserKYCDisclosureContextFragment
    }
    createdAt
    employerAddress
    employerName
    employmentPosition
    employmentStatus
    id
    immediateFamilyExposed
    isAffiliatedExchangeOrFinra
    isControlPerson
    isPoliticallyExposed
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": UpdateUserKycDisclosuresInput}
Response
{
  "data": {
    "updateUserKycDisclosures": {
      "contexts": [IUserKYCDisclosureContext],
      "createdAt": GemDate,
      "employerAddress": "xyz789",
      "employerName": "abc123",
      "employmentPosition": "abc123",
      "employmentStatus": "EMPLOYED",
      "id": "4",
      "immediateFamilyExposed": true,
      "isAffiliatedExchangeOrFinra": true,
      "isControlPerson": false,
      "isPoliticallyExposed": true,
      "user": User
    }
  }
}
Mutations

updateUserKycFileDocuments

Description

Requires scope: profile.write.

Response

Returns [UserKYCUploadedFileDocument!]!

Arguments
Name Description
params - [UpdateUserKYCUploadedFileDocumentInput!]!

Example

Query
mutation updateUserKycFileDocuments($params: [UpdateUserKYCUploadedFileDocumentInput!]!) {
  updateUserKycFileDocuments(params: $params) {
    alpacaId
    alpacaURL
    content
    createdAt
    documentSubType
    documentType
    id
    mimeType
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": [UpdateUserKYCUploadedFileDocumentInput]}
Response
{
  "data": {
    "updateUserKycFileDocuments": [
      {
        "alpacaId": "4",
        "alpacaURL": "4",
        "content": "xyz789",
        "createdAt": GemDate,
        "documentSubType": "ACCOUNT_APPLICATION",
        "documentType": "ACCOUNT_APPROVAL",
        "id": 4,
        "mimeType": "abc123",
        "user": User
      }
    ]
  }
}
Mutations

updateUserKycIdentityInformation

Description

Requires scope: profile.write.

Response

Returns a UserKYCIdentityInformation!

Arguments
Name Description
params - UpdateUserKycIdentityInformationInput!

Example

Query
mutation updateUserKycIdentityInformation($params: UpdateUserKycIdentityInformationInput!) {
  updateUserKycIdentityInformation(params: $params) {
    annualIncomeMax
    annualIncomeMin
    countryOfBirth
    countryOfCitizenship
    countryOfTaxResidence
    createdAt
    dateOfBirth
    dateOfDepartureFromUsa
    familyName
    fundingSource
    givenName
    id
    liquidNetWorthMax
    liquidNetWorthMin
    middleName
    permanentResident
    taxId
    taxIdType
    totalNetWorthMax
    totalNetWorthMin
    user {
      ...UserFragment
    }
    visaExpirationDate
    visaType
  }
}
Variables
{"params": UpdateUserKycIdentityInformationInput}
Response
{
  "data": {
    "updateUserKycIdentityInformation": {
      "annualIncomeMax": "xyz789",
      "annualIncomeMin": "xyz789",
      "countryOfBirth": "xyz789",
      "countryOfCitizenship": "abc123",
      "countryOfTaxResidence": "abc123",
      "createdAt": GemDate,
      "dateOfBirth": "xyz789",
      "dateOfDepartureFromUsa": "abc123",
      "familyName": "xyz789",
      "fundingSource": ["BUSINESS"],
      "givenName": "xyz789",
      "id": 4,
      "liquidNetWorthMax": "abc123",
      "liquidNetWorthMin": "abc123",
      "middleName": "abc123",
      "permanentResident": false,
      "taxId": "xyz789",
      "taxIdType": "ARG_AR_CUIT",
      "totalNetWorthMax": "xyz789",
      "totalNetWorthMin": "xyz789",
      "user": User,
      "visaExpirationDate": "xyz789",
      "visaType": "B1"
    }
  }
}
Mutations

updateUserKycTrustedContact

Description

Requires scope: profile.write.

Response

Returns a UserKYCTrustedContact!

Arguments
Name Description
params - UpdateUserKycTrustedContactInput!

Example

Query
mutation updateUserKycTrustedContact($params: UpdateUserKycTrustedContactInput!) {
  updateUserKycTrustedContact(params: $params) {
    city
    country
    createdAt
    emailAddress
    familyName
    givenName
    id
    phoneNumber
    postalCode
    state
    streetAddress
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": UpdateUserKycTrustedContactInput}
Response
{
  "data": {
    "updateUserKycTrustedContact": {
      "city": "xyz789",
      "country": "abc123",
      "createdAt": GemDate,
      "emailAddress": "xyz789",
      "familyName": "xyz789",
      "givenName": "xyz789",
      "id": 4,
      "phoneNumber": "xyz789",
      "postalCode": "xyz789",
      "state": "xyz789",
      "streetAddress": ["xyz789"],
      "user": User
    }
  }
}
Mutations

updateUserKycW8BENFormDocument

Description

Requires scope: profile.write.

Response

Returns an UserKYCUploadedW8BENFormDocument!

Arguments
Name Description
params - UpdateUserKYCUploadedW8BENFormDocumentInput!

Example

Query
mutation updateUserKycW8BENFormDocument($params: UpdateUserKYCUploadedW8BENFormDocumentInput!) {
  updateUserKycW8BENFormDocument(params: $params) {
    alpacaId
    alpacaURL
    contentData {
      ...IUserKYCW8BENFormFragment
    }
    createdAt
    documentSubType
    documentType
    id
    user {
      ...UserFragment
    }
  }
}
Variables
{"params": UpdateUserKYCUploadedW8BENFormDocumentInput}
Response
{
  "data": {
    "updateUserKycW8BENFormDocument": {
      "alpacaId": "4",
      "alpacaURL": "4",
      "contentData": IUserKYCW8BENForm,
      "createdAt": GemDate,
      "documentSubType": "ACCOUNT_APPLICATION",
      "documentType": "ACCOUNT_APPROVAL",
      "id": "4",
      "user": User
    }
  }
}
Mutations

updateUserProfile

Description

Requires scope: profile.write.

Response

Returns a Boolean!

Arguments
Name Description
params - UpdateUserProfileInput!

Example

Query
mutation updateUserProfile($params: UpdateUserProfileInput!) {
  updateUserProfile(params: $params)
}
Variables
{"params": UpdateUserProfileInput}
Response
{"data": {"updateUserProfile": true}}
Mutations

updateWealthRelayTrade

Description

Requires scope: trade.

Response

Returns a Trade!

Arguments
Name Description
input - CreateTradeInput!
tradeCode - String!

Example

Query
mutation updateWealthRelayTrade(
  $input: CreateTradeInput!,
  $tradeCode: String!
) {
  updateWealthRelayTrade(
    input: $input,
    tradeCode: $tradeCode
  ) {
    brokerage
    comment
    market
    price
    quantity
    symbol
    thirdPartyId
    tradeCode
    tradeDate
    type
    value
  }
}
Variables
{
  "input": CreateTradeInput,
  "tradeCode": "abc123"
}
Response
{
  "data": {
    "updateWealthRelayTrade": {
      "brokerage": Decimal,
      "comment": "xyz789",
      "market": "abc123",
      "price": Decimal,
      "quantity": Decimal,
      "symbol": "xyz789",
      "thirdPartyId": "abc123",
      "tradeCode": "xyz789",
      "tradeDate": GemDate,
      "type": "xyz789",
      "value": Decimal
    }
  }
}
Mutations

updateWhitelistedWalletTravelRule

Description

Requires scope: funding.write.

Response

Returns a TravelRuleResult!

Arguments
Name Description
params - UpdateWhitelistedWalletTravelRuleInput!

Example

Query
mutation updateWhitelistedWalletTravelRule($params: UpdateWhitelistedWalletTravelRuleInput!) {
  updateWhitelistedWalletTravelRule(params: $params) {
    message
    nextActions {
      ...TravelRuleNextActionFragment
    }
    success
    travelRuleActionRequired
  }
}
Variables
{"params": UpdateWhitelistedWalletTravelRuleInput}
Response
{
  "data": {
    "updateWhitelistedWalletTravelRule": {
      "message": "xyz789",
      "nextActions": [TravelRuleNextAction],
      "success": false,
      "travelRuleActionRequired": true
    }
  }
}
Mutations

uploadNetWorthFile

Description

Requires scope: portfolio.write.

Response

Returns a NetWorthFileUpload

Arguments
Name Description
contentType - String!
fileName - String!
fileSize - Int!
portfolioCode - String!

Example

Query
mutation uploadNetWorthFile(
  $contentType: String!,
  $fileName: String!,
  $fileSize: Int!,
  $portfolioCode: String!
) {
  uploadNetWorthFile(
    contentType: $contentType,
    fileName: $fileName,
    fileSize: $fileSize,
    portfolioCode: $portfolioCode
  ) {
    code
    fileName
    uploadUrl
  }
}
Variables
{
  "contentType": "abc123",
  "fileName": "abc123",
  "fileSize": 987,
  "portfolioCode": "xyz789"
}
Response
{
  "data": {
    "uploadNetWorthFile": {
      "code": "abc123",
      "fileName": "xyz789",
      "uploadUrl": "abc123"
    }
  }
}
Mutations

verifyEmail

Description

Requires scope: public.

Response

Returns a Boolean!

Arguments
Name Description
params - VerifyEmailInput!

Example

Query
mutation verifyEmail($params: VerifyEmailInput!) {
  verifyEmail(params: $params)
}
Variables
{"params": VerifyEmailInput}
Response
{"data": {"verifyEmail": true}}

Subscriptions

assistantNotifications

Description

Long-lived subscription for AI assistant proactive notifications, filtered to the current user. Requires scope: profile.read.

Response

Returns an AssistantNotification!

Example

Query
subscription assistantNotifications {
  assistantNotifications {
    data
    message
    timestamp
    title
    trigger
  }
}
Response
{
  "data": {
    "assistantNotifications": {
      "data": "abc123",
      "message": "abc123",
      "timestamp": "abc123",
      "title": "xyz789",
      "trigger": "xyz789"
    }
  }
}
Subscriptions

assistantStream

Description

Streams the AI assistant's reply to a message in real time, token by token. Requires scope: profile.read.

Response

Returns an AssistantStreamChunk!

Arguments
Name Description
params - AssistantStreamInput!

Example

Query
subscription assistantStream($params: AssistantStreamInput!) {
  assistantStream(params: $params) {
    actionPayload
    attempt
    chunkType
    confidence
    content
    errorMessage
    exchange
    mentionedAssets {
      ...AssistantMentionedAssetFragment
    }
    messageId
    threadId
    ticker
    title
    toolArgs
    toolName
    toolStatus
  }
}
Variables
{"params": AssistantStreamInput}
Response
{
  "data": {
    "assistantStream": {
      "actionPayload": "abc123",
      "attempt": 987,
      "chunkType": "xyz789",
      "confidence": "abc123",
      "content": "xyz789",
      "errorMessage": "xyz789",
      "exchange": "xyz789",
      "mentionedAssets": [AssistantMentionedAsset],
      "messageId": "abc123",
      "threadId": "xyz789",
      "ticker": "xyz789",
      "title": "abc123",
      "toolArgs": "abc123",
      "toolName": "abc123",
      "toolStatus": "xyz789"
    }
  }
}
Subscriptions

exportJobUpdated

Description

Requires scope: funding.read.

Response

Returns an ExportJobGql!

Example

Query
subscription exportJobUpdated {
  exportJobUpdated {
    createdAt
    downloadUrl
    expiresAt
    id
    lastViewedAt
    name
    status
  }
}
Response
{
  "data": {
    "exportJobUpdated": {
      "createdAt": "xyz789",
      "downloadUrl": "xyz789",
      "expiresAt": "abc123",
      "id": "xyz789",
      "lastViewedAt": "xyz789",
      "name": "abc123",
      "status": "xyz789"
    }
  }
}
Subscriptions

livePriceData

Description

Requires scope: public.

Response

Returns a LivePriceData!

Arguments
Name Description
ticker - String!

Example

Query
subscription livePriceData($ticker: String!) {
  livePriceData(ticker: $ticker) {
    createdAt
    id
    price
    priceChange
    priceChangePercentage
    priceSource
    ticker
    timestamp
  }
}
Variables
{"ticker": "xyz789"}
Response
{
  "data": {
    "livePriceData": {
      "createdAt": GemDate,
      "id": "4",
      "price": Decimal,
      "priceChange": Decimal,
      "priceChangePercentage": Decimal,
      "priceSource": "xyz789",
      "ticker": "abc123",
      "timestamp": {}
    }
  }
}
Subscriptions

newsUpdates

Description

Requires scope: public.

Response

Returns a NewsResponse!

Arguments
Name Description
assetIds - [ID!]!
limit - Int!
offset - Int!

Example

Query
subscription newsUpdates(
  $assetIds: [ID!]!,
  $limit: Int!,
  $offset: Int!
) {
  newsUpdates(
    assetIds: $assetIds,
    limit: $limit,
    offset: $offset
  ) {
    articles {
      ...NewsArticleFragment
    }
    totalCount
  }
}
Variables
{"assetIds": [4], "limit": 123, "offset": 123}
Response
{
  "data": {
    "newsUpdates": {
      "articles": [NewsArticle],
      "totalCount": 987
    }
  }
}

Types

AccountActivitiesInput

Fields
Input Field Description
activityType - String
pageToken - String
tradingMode - String!
Example
{
  "activityType": "abc123",
  "pageToken": "xyz789",
  "tradingMode": "xyz789"
}
Types

AccountActivity

Types
Union Types

AccountNonTradeActivity

AccountTradeActivity
Example
AccountNonTradeActivity
Types

AccountAgreementInfo

Fields
Field Name Description
agreement - String!
revision - String
signedAt - String
Example
{
  "agreement": "abc123",
  "revision": "abc123",
  "signedAt": "abc123"
}
Types

AccountBalances

Fields
Field Name Description
cash - Decimal!
cryptoPositionValue - Decimal!
dayTradeCount - Int!
dayTradingBuyingPower - Decimal!
effectiveBuyingPower - Decimal!
equitiesPositionValue - Decimal!
equity - Decimal!
excessMargin - Decimal!
initialMargin - Decimal!
lastCash - Decimal!
lastDayTradeCount - Int!
lastDayTradingBuyingPower - Decimal!
lastEffectiveBuyingPower - Decimal!
lastEquity - Decimal!
lastExcessMargin - Decimal!
lastInitialMargin - Decimal!
lastLongMarketValue - Decimal!
lastMaintenanceMargin - Decimal!
lastNonMarginableBuyingPower - Decimal!
lastRegtBuyingPower - Decimal!
lastShortMarketValue - Decimal!
longMarketValue - Decimal!
maintenanceMargin - Decimal!
nonMarginableBuyingPower - Decimal!
regtBuyingPower - Decimal!
shortMarketValue - Decimal!
Example
{
  "cash": Decimal,
  "cryptoPositionValue": Decimal,
  "dayTradeCount": 987,
  "dayTradingBuyingPower": Decimal,
  "effectiveBuyingPower": Decimal,
  "equitiesPositionValue": Decimal,
  "equity": Decimal,
  "excessMargin": Decimal,
  "initialMargin": Decimal,
  "lastCash": Decimal,
  "lastDayTradeCount": 123,
  "lastDayTradingBuyingPower": Decimal,
  "lastEffectiveBuyingPower": Decimal,
  "lastEquity": Decimal,
  "lastExcessMargin": Decimal,
  "lastInitialMargin": Decimal,
  "lastLongMarketValue": Decimal,
  "lastMaintenanceMargin": Decimal,
  "lastNonMarginableBuyingPower": Decimal,
  "lastRegtBuyingPower": Decimal,
  "lastShortMarketValue": Decimal,
  "longMarketValue": Decimal,
  "maintenanceMargin": Decimal,
  "nonMarginableBuyingPower": Decimal,
  "regtBuyingPower": Decimal,
  "shortMarketValue": Decimal
}
Types

AccountDocument

Fields
Field Name Description
date - String!
id - ID!
name - String!
sub_type - String!
type - String!
Example
{
  "date": "abc123",
  "id": 4,
  "name": "abc123",
  "sub_type": "abc123",
  "type": "xyz789"
}
Types

AccountDocumentByIdInput

Fields
Input Field Description
documentId - ID!
tradingMode - String!
Example
{"documentId": 4, "tradingMode": "abc123"}
Types

AccountNonTradeActivity

Fields
Field Name Description
account_id - ID!
activity_type - String!
date - DateTimeISO!
description - String!
id - ID!
net_amount - Decimal!
per_share_amount - Decimal
qty - Decimal
status - String!
symbol - String
Example
{
  "account_id": "4",
  "activity_type": "abc123",
  "date": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "id": 4,
  "net_amount": Decimal,
  "per_share_amount": Decimal,
  "qty": Decimal,
  "status": "xyz789",
  "symbol": "abc123"
}
Types

AccountStatus

Values
Enum Value Description

ACCOUNT_CLOSED

ACCOUNT_UPDATED

ACTION_REQUIRED

ACTIVE

APPROVAL_PENDING

APPROVED

INACTIVE

ONBOARDING

REJECTED

SUBMISSION_FAILED

SUBMITTED

UNKNOWN
Example
"ACCOUNT_CLOSED"
Types

AccountTradeActivity

Fields
Field Name Description
account_id - ID!
activity_type - String!
cum_qty - Decimal!
id - ID!
leaves_qty - Decimal!
order_id - String!
order_status - String!
price - Decimal!
qty - Decimal!
side - String!
symbol - String!
transaction_time - DateTimeISO
type - String!
Example
{
  "account_id": "4",
  "activity_type": "abc123",
  "cum_qty": Decimal,
  "id": "4",
  "leaves_qty": Decimal,
  "order_id": "xyz789",
  "order_status": "xyz789",
  "price": Decimal,
  "qty": Decimal,
  "side": "xyz789",
  "symbol": "abc123",
  "transaction_time": "2007-12-03T10:15:30Z",
  "type": "abc123"
}
Types

AccountTradingConfiguration

Fields
Field Name Description
autoReinvestDividends - Boolean!
dtbpCheck - String!
fractionalTrading - Boolean!
maxMarginMultiplier - Int!
noShorting - Boolean!
pdtCheck - String!
tradeConfirmEmail - Boolean!
tradeSuspendedByUser - Boolean!
Example
{
  "autoReinvestDividends": true,
  "dtbpCheck": "xyz789",
  "fractionalTrading": false,
  "maxMarginMultiplier": 123,
  "noShorting": true,
  "pdtCheck": "abc123",
  "tradeConfirmEmail": false,
  "tradeSuspendedByUser": true
}
Types

AccountTradingConfigurationFetchInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "abc123"}
Types

AccountTradingConfigurationInput

Fields
Input Field Description
autoReinvestDividends - Boolean!
dtbpCheck - String!
fractionalTrading - Boolean!
maxMarginMultiplier - Int!
noShorting - Boolean!
pdtCheck - String!
suspendTrade - Boolean!
tradeConfirmEmail - Boolean!
tradingMode - String!
Example
{
  "autoReinvestDividends": false,
  "dtbpCheck": "xyz789",
  "fractionalTrading": false,
  "maxMarginMultiplier": 987,
  "noShorting": true,
  "pdtCheck": "abc123",
  "suspendTrade": true,
  "tradeConfirmEmail": false,
  "tradingMode": "abc123"
}
Types

ActiveStrategy

Fields
Field Name Description
assets - [ActiveStrategyAsset!]!
brokerAccountId - String!
createdAt - DateTimeISO!
dailyPL - Decimal
dailyPLPercentage - Decimal
history - [ActiveStrategyHistory!]!
id - ID!
initialInvestmentAmount - Decimal
initialInvestmentOrders - [Order!]!
initialInvestmentPortionType - InvestmentPortionType
isRebalanceOn - Boolean!
isScheduledContributionOn - Boolean!
manualContributions - [ManualContribution!]!
name - String!
performance - [StrategyPerformance!]!
rebalanceFrequency - RebalanceFrequency
rebalances - [Rebalance!]!
scheduledContributionAmount - Decimal
scheduledContributionFrequency - ScheduledContributionFrequency
scheduledContributionPortionType - InvestmentPortionType
scheduledContributions - [ScheduledContribution!]!
sourceStrategyId - String
status - ActiveStrategyStatus!
subscribedStrategyHistory - StrategyHistory
subscribedStrategyHistoryId - String
totalInvestment - Decimal!
totalPL - Decimal
totalPLPercentage - Decimal
totalValue - Decimal
Example
{
  "assets": [ActiveStrategyAsset],
  "brokerAccountId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "dailyPL": Decimal,
  "dailyPLPercentage": Decimal,
  "history": [ActiveStrategyHistory],
  "id": 4,
  "initialInvestmentAmount": Decimal,
  "initialInvestmentOrders": [Order],
  "initialInvestmentPortionType": "AMOUNT",
  "isRebalanceOn": true,
  "isScheduledContributionOn": false,
  "manualContributions": [ManualContribution],
  "name": "xyz789",
  "performance": [StrategyPerformance],
  "rebalanceFrequency": "ANNUALLY",
  "rebalances": [Rebalance],
  "scheduledContributionAmount": Decimal,
  "scheduledContributionFrequency": "FORTNIGHT_START",
  "scheduledContributionPortionType": "AMOUNT",
  "scheduledContributions": [ScheduledContribution],
  "sourceStrategyId": "xyz789",
  "status": "ACTIVE",
  "subscribedStrategyHistory": StrategyHistory,
  "subscribedStrategyHistoryId": "abc123",
  "totalInvestment": Decimal,
  "totalPL": Decimal,
  "totalPLPercentage": Decimal,
  "totalValue": Decimal
}
Types

ActiveStrategyAsset

Fields
Field Name Description
assetId - String!
averagePrice - Decimal
currentValue - Decimal
currentWeight - Decimal
lastClosePrice - Decimal!
logoURL - String
name - String!
numberOfShares - Decimal
performance - Decimal
targetWeight - Decimal!
ticker - String!
type - String!
Example
{
  "assetId": "abc123",
  "averagePrice": Decimal,
  "currentValue": Decimal,
  "currentWeight": Decimal,
  "lastClosePrice": Decimal,
  "logoURL": "xyz789",
  "name": "abc123",
  "numberOfShares": Decimal,
  "performance": Decimal,
  "targetWeight": Decimal,
  "ticker": "xyz789",
  "type": "abc123"
}
Types

ActiveStrategyAssetInput

Fields
Input Field Description
assetId - String!
weight - Decimal!
Example
{
  "assetId": "abc123",
  "weight": Decimal
}
Types

ActiveStrategyHistory

Fields
Field Name Description
endDate - DateTimeISO
id - String!
name - String!
startDate - DateTimeISO!
targetWeights - [ActiveStrategyAsset!]!
version - Int!
Example
{
  "endDate": "2007-12-03T10:15:30Z",
  "id": "abc123",
  "name": "xyz789",
  "startDate": "2007-12-03T10:15:30Z",
  "targetWeights": [ActiveStrategyAsset],
  "version": 123
}
Types

ActiveStrategyStatus

Values
Enum Value Description

ACTIVE

INACTIVE
Example
"ACTIVE"
Types

AddInstrumentPriceInput

Fields
Input Field Description
market - String!
price - WealthrelayInstrumentPriceInput!
symbol - String!
Example
{
  "market": "abc123",
  "price": WealthrelayInstrumentPriceInput,
  "symbol": "xyz789"
}
Types

AddWalletWatchInput

Fields
Input Field Description
address - String!
blockchain - String!
portfolioCode - String!
syncFrom - GemDate
Example
{
  "address": "abc123",
  "blockchain": "abc123",
  "portfolioCode": "abc123",
  "syncFrom": GemDate
}
Types

AdjustSharesInput

Fields
Input Field Description
activeStrategyId - ID!
assetId - ID!
shares - Decimal!
Example
{
  "activeStrategyId": 4,
  "assetId": "4",
  "shares": Decimal
}
Types

AlpacaOutgoingTransfer

Fields
Field Name Description
alpacaTransferId - String
createdAt - GemDate!
currency - Currency!
fees - Decimal
id - ID!
internalReference - String!
status - String!
totalAmount - Decimal!
userWithdrawalRequests - [UserWithdrawalRequest]!
wiseIncomingTransfer - WiseIncomingTransfer
Example
{
  "alpacaTransferId": "abc123",
  "createdAt": GemDate,
  "currency": "AUD",
  "fees": Decimal,
  "id": 4,
  "internalReference": "abc123",
  "status": "abc123",
  "totalAmount": Decimal,
  "userWithdrawalRequests": [UserWithdrawalRequest],
  "wiseIncomingTransfer": WiseIncomingTransfer
}
Types

AppointmentObject

Fields
Field Name Description
address - String
contactEmail - String
contactName - String
contactPhone - String
endTime - String!
id - ID!
notes - String
startTime - String!
status - String!
title - String!
Example
{
  "address": "xyz789",
  "contactEmail": "abc123",
  "contactName": "xyz789",
  "contactPhone": "abc123",
  "endTime": "abc123",
  "id": "4",
  "notes": "abc123",
  "startTime": "abc123",
  "status": "abc123",
  "title": "xyz789"
}
Types

AprTiers

Fields
Field Name Description
account_rate_bps - Decimal!
name - String!
Example
{
  "account_rate_bps": Decimal,
  "name": "abc123"
}
Types

Asset

Types
Union Types

Crypto

ETF

Stock
Example
Crypto
Types

AssetLike

Fields
Field Name Description
author - Author!
createdAt - GemDate!
id - ID!
recipient - Asset!
Example
{
  "author": Author,
  "createdAt": GemDate,
  "id": 4,
  "recipient": Crypto
}
Types

AssetVoteDirection

Values
Enum Value Description

LONG

SHORT
Example
"LONG"
Types

AssistantContactFrequency

Values
Enum Value Description

DAILY

FORTNIGHTLY

MONTHLY

WEEKLY
Example
"DAILY"
Types

AssistantMentionedAsset

Fields
Field Name Description
exchange - String!
ticker - String!
Example
{
  "exchange": "xyz789",
  "ticker": "xyz789"
}
Types

AssistantMessage

Fields
Field Name Description
content - String!
id - String!
role - String!
Example
{
  "content": "abc123",
  "id": "abc123",
  "role": "xyz789"
}
Types

AssistantNotification

Fields
Field Name Description
data - String
message - String!
timestamp - String!
title - String!
trigger - String!
Example
{
  "data": "abc123",
  "message": "abc123",
  "timestamp": "abc123",
  "title": "abc123",
  "trigger": "abc123"
}
Types

AssistantStreamChunk

Fields
Field Name Description
actionPayload - String
attempt - Int
chunkType - String!
confidence - String
content - String
errorMessage - String
exchange - String
mentionedAssets - [AssistantMentionedAsset!]
messageId - String
threadId - String
ticker - String
title - String
toolArgs - String
toolName - String
toolStatus - String
Example
{
  "actionPayload": "abc123",
  "attempt": 123,
  "chunkType": "abc123",
  "confidence": "abc123",
  "content": "xyz789",
  "errorMessage": "abc123",
  "exchange": "xyz789",
  "mentionedAssets": [AssistantMentionedAsset],
  "messageId": "xyz789",
  "threadId": "abc123",
  "ticker": "abc123",
  "title": "xyz789",
  "toolArgs": "abc123",
  "toolName": "abc123",
  "toolStatus": "abc123"
}
Types

AssistantStreamInput

Fields
Input Field Description
content - String!
pageContext - String
threadId - String
Example
{
  "content": "xyz789",
  "pageContext": "xyz789",
  "threadId": "abc123"
}
Types

AssistantThread

Fields
Field Name Description
author - Author!
createdAt - GemDate!
id - ID!
messages - [AssistantMessage!]!
name - String!
privacy - AssistantThreadPrivacy!
Example
{
  "author": Author,
  "createdAt": GemDate,
  "id": "4",
  "messages": [AssistantMessage],
  "name": "xyz789",
  "privacy": "PRIVATE"
}
Types

AssistantThreadLike

Fields
Field Name Description
author - Author!
createdAt - GemDate!
id - ID!
recipient - AssistantThread!
Example
{
  "author": Author,
  "createdAt": GemDate,
  "id": 4,
  "recipient": AssistantThread
}
Types

AssistantThreadPrivacy

Values
Enum Value Description

PRIVATE

PUBLIC

UNLISTED
Example
"PRIVATE"
Types

Author

Fields
Field Name Description
createdAt - GemDate!
firstName - String
id - ID!
lastName - String
name - String!
username - String!
Example
{
  "createdAt": GemDate,
  "firstName": "abc123",
  "id": 4,
  "lastName": "abc123",
  "name": "abc123",
  "username": "xyz789"
}
Types

AvailableCountry

Fields
Field Name Description
alpha2code - String!
alpha3code - String!
name - String!
Example
{
  "alpha2code": "xyz789",
  "alpha3code": "abc123",
  "name": "abc123"
}
Types

AvailableSharesToAttach

Fields
Field Name Description
availableShares - Decimal!
totalAttachedShares - Decimal!
totalBrokerShares - Decimal!
Example
{
  "availableShares": Decimal,
  "totalAttachedShares": Decimal,
  "totalBrokerShares": Decimal
}
Types

BaseEntity

Fields
Field Name Description
createdAt - GemDate!
id - ID!
Example
{
  "createdAt": GemDate,
  "id": "4"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

BrokerAccountCash

Fields
Field Name Description
USD - Decimal!
Example
{"USD": Decimal}
Types

BrokerAccountEnvironment

Values
Enum Value Description

LIVE

PAPER
Example
"LIVE"
Types

BrokerAccountInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "xyz789"}
Types

BrokerAccountList

Fields
Field Name Description
brokers - [BrokerCredentialWithAccount!]!
buyingPower - Decimal!
cash - [Money!]!
eccuityInvestRequiresAttention - String
equity - Decimal!
nonMarginableBuyingPower - Decimal
Example
{
  "brokers": [BrokerCredentialWithAccount],
  "buyingPower": Decimal,
  "cash": [Money],
  "eccuityInvestRequiresAttention": "abc123",
  "equity": Decimal,
  "nonMarginableBuyingPower": Decimal
}
Types

BrokerAccountProvider

Values
Enum Value Description

ALPACA

GEM_BROKER
Example
"ALPACA"
Types

BrokerAccountType

Values
Enum Value Description

LIVE

PAPER
Example
"LIVE"
Types

BrokerCancelOrderInput

Fields
Input Field Description
brokerCredentialId - String!
orderId - String!
Example
{
  "brokerCredentialId": "xyz789",
  "orderId": "abc123"
}
Types

BrokerCredential

Fields
Field Name Description
brokerName - String!
brokerType - BrokerNameObject!
commissionBps - Decimal!
id - String!
userProvidedName - String!
Example
{
  "brokerName": "xyz789",
  "brokerType": "ALPACA",
  "commissionBps": Decimal,
  "id": "xyz789",
  "userProvidedName": "xyz789"
}
Types

BrokerCredentialDeleteInput

Fields
Input Field Description
id - String!
name - BrokerNameObject!
Example
{"id": "xyz789", "name": "ALPACA"}
Types

BrokerCredentialInput

Fields
Input Field Description
authorizationCode - String!
credentialName - BrokerNameObject!
userProvidedName - String!
Example
{
  "authorizationCode": "xyz789",
  "credentialName": "ALPACA",
  "userProvidedName": "abc123"
}
Types

BrokerCredentialWithAccount

Fields
Field Name Description
account - LegacyBrokerAccount!
credential - BrokerCredential!
type - String!
Example
{
  "account": LegacyBrokerAccount,
  "credential": BrokerCredential,
  "type": "xyz789"
}
Types

BrokerEditOrderInput

Fields
Input Field Description
brokerCredentialId - String!
brokerType - String!
limitPrice - Decimal!
notional - Decimal
orderId - String!
premarket - Boolean!
quantity - Decimal
quantityFilled - Decimal!
side - OrderSide!
stopPrice - Decimal!
timeInForce - OrderTimeInForce
type - OrderType!
Example
{
  "brokerCredentialId": "xyz789",
  "brokerType": "abc123",
  "limitPrice": Decimal,
  "notional": Decimal,
  "orderId": "xyz789",
  "premarket": false,
  "quantity": Decimal,
  "quantityFilled": Decimal,
  "side": "BUY",
  "stopPrice": Decimal,
  "timeInForce": "CLS",
  "type": "LIMIT"
}
Types

BrokerFetchPortfolioHistoryInput

Fields
Input Field Description
aftermarket - Boolean
dateEnd - String
period - String
timeframe - FetchPortfolioHistoryTimeframe
tradingMode - String!
Example
{
  "aftermarket": true,
  "dateEnd": "abc123",
  "period": "abc123",
  "timeframe": "FIFTEEN_MIN",
  "tradingMode": "abc123"
}
Types

BrokerFetchPortfolioHistoryOutput

Fields
Field Name Description
baseValue - Decimal!
profitLoss - [Decimal!]!
profitLossPercent - [Decimal!]!
timeframe - String!
timestamps - [String!]!
values - [Decimal!]!
Example
{
  "baseValue": Decimal,
  "profitLoss": [Decimal],
  "profitLossPercent": [Decimal],
  "timeframe": "xyz789",
  "timestamps": ["xyz789"],
  "values": [Decimal]
}
Types

BrokerFundPaperAccountInput

Fields
Input Field Description
brokerCredentialId - String!
Example
{"brokerCredentialId": "abc123"}
Types

BrokerIntegration

Fields
Field Name Description
description - String!
firstParty - Boolean!
name - String!
oauthUrl - String!
type - String!
Example
{
  "description": "abc123",
  "firstParty": true,
  "name": "abc123",
  "oauthUrl": "xyz789",
  "type": "xyz789"
}
Types

BrokerLiquidatePositionInput

Fields
Input Field Description
brokerCredentialId - String!
symbol - String!
Example
{
  "brokerCredentialId": "abc123",
  "symbol": "abc123"
}
Types

BrokerNameObject

Values
Enum Value Description

ALPACA

ALPACA_PAPER

GEMBROKER

GEMBROKER_PAPER
Example
"ALPACA"
Types

BrokerOrderOutput

Fields
Field Name Description
averageFilledPrice - Decimal!
brokerCredentialId - String!
brokerType - String!
createdAt - String!
expiredAt - String
fee - Decimal!
filledAt - String
id - String!
limitPrice - Decimal!
notional - Decimal
premarket - Boolean!
quantity - Decimal
quantityFilled - Decimal!
side - OrderSide!
status - OrderStatus!
stopPrice - Decimal!
symbol - String!
timeInForce - OrderTimeInForce
type - OrderType!
Example
{
  "averageFilledPrice": Decimal,
  "brokerCredentialId": "abc123",
  "brokerType": "abc123",
  "createdAt": "abc123",
  "expiredAt": "abc123",
  "fee": Decimal,
  "filledAt": "abc123",
  "id": "xyz789",
  "limitPrice": Decimal,
  "notional": Decimal,
  "premarket": true,
  "quantity": Decimal,
  "quantityFilled": Decimal,
  "side": "BUY",
  "status": "ACCEPTED",
  "stopPrice": Decimal,
  "symbol": "abc123",
  "timeInForce": "CLS",
  "type": "LIMIT"
}
Types

BrokerOrdersInput

Fields
Input Field Description
limit - Int
status - String
symbol - String
tradingMode - String!
until - String
Example
{
  "limit": 987,
  "status": "xyz789",
  "symbol": "abc123",
  "tradingMode": "xyz789",
  "until": "abc123"
}
Types

BrokerPlaceOrderInput

Fields
Input Field Description
assetId - ID!
brokerCredentialId - ID!
limitPrice - Decimal!
notional - Decimal!
premarket - Boolean!
quantity - Decimal!
side - OrderSide!
stopPrice - Decimal!
timeInForce - OrderTimeInForce!
type - OrderType!
Example
{
  "assetId": 4,
  "brokerCredentialId": "4",
  "limitPrice": Decimal,
  "notional": Decimal,
  "premarket": true,
  "quantity": Decimal,
  "side": "BUY",
  "stopPrice": Decimal,
  "timeInForce": "CLS",
  "type": "LIMIT"
}
Types

BrokerPosition

Fields
Field Name Description
assetClass - String!
averageEntryPrice - Decimal!
brokerCredentialId - String!
brokerType - BrokerNameObject!
changeToday - Decimal!
costBasis - Decimal!
currentPrice - Decimal!
exchange - String!
lastDayPrice - Decimal!
marketValue - Decimal!
quantity - Decimal!
quantityAvailable - Decimal!
side - String!
symbol - String!
unrealizedProfitLoss - Decimal!
unrealizedProfitLossIntraday - Decimal!
unrealizedProfitLossPercent - Decimal!
unrealizedProfitLossPercentIntraday - Decimal!
Example
{
  "assetClass": "xyz789",
  "averageEntryPrice": Decimal,
  "brokerCredentialId": "abc123",
  "brokerType": "ALPACA",
  "changeToday": Decimal,
  "costBasis": Decimal,
  "currentPrice": Decimal,
  "exchange": "xyz789",
  "lastDayPrice": Decimal,
  "marketValue": Decimal,
  "quantity": Decimal,
  "quantityAvailable": Decimal,
  "side": "abc123",
  "symbol": "abc123",
  "unrealizedProfitLoss": Decimal,
  "unrealizedProfitLossIntraday": Decimal,
  "unrealizedProfitLossPercent": Decimal,
  "unrealizedProfitLossPercentIntraday": Decimal
}
Types

BrokerPositionsInput

Fields
Input Field Description
symbol - String
tradingMode - String!
Example
{
  "symbol": "abc123",
  "tradingMode": "xyz789"
}
Types

BrokerTradableAsset

Fields
Field Name Description
name - String!
symbol - String!
Example
{
  "name": "xyz789",
  "symbol": "xyz789"
}
Types

BrokerTradableAssetsInput

Fields
Input Field Description
broker - BrokerNameObject!
Example
{"broker": "ALPACA"}
Types

CancelSubscriptionInput

Fields
Input Field Description
subscriptionId - String!
Example
{"subscriptionId": "xyz789"}
Types

Candlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": "4",
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

CandlestickDuration

Values
Enum Value Description

ONE_DAY

ONE_HOUR

ONE_MONTH

ONE_WEEK

ONE_YEAR

THREE_MONTH

THREE_YEAR

TWO_YEAR

YTD
Example
"ONE_DAY"
Types

Card

Fields
Field Name Description
brand - String!
expMonth - Int!
expYear - Int!
id - String!
last4 - String!
Example
{
  "brand": "abc123",
  "expMonth": 987,
  "expYear": 123,
  "id": "abc123",
  "last4": "xyz789"
}
Types

CardList

Fields
Field Name Description
cards - [Card!]!
Example
{"cards": [Card]}
Types

CashInterests

Fields
Field Name Description
apr_tier_name - String!
currency - String!
status - String!
userId - String!
Example
{
  "apr_tier_name": "xyz789",
  "currency": "xyz789",
  "status": "xyz789",
  "userId": "abc123"
}
Types

CashflowChartData

Fields
Field Name Description
deposits - [CashflowChartRecord!]!
withdrawals - [CashflowChartRecord!]!
Example
{
  "deposits": [CashflowChartRecord],
  "withdrawals": [CashflowChartRecord]
}
Types

CashflowChartRecord

Fields
Field Name Description
amount - Decimal!
date - String!
Example
{
  "amount": Decimal,
  "date": "xyz789"
}
Types

CompanySetup

Fields
Field Name Description
createdAt - GemDate!
id - ID!
name - String!
phoneNumber - String!
user - User!
Example
{
  "createdAt": GemDate,
  "id": 4,
  "name": "abc123",
  "phoneNumber": "xyz789",
  "user": User
}
Types

ContributeToActiveStrategyInput

Fields
Input Field Description
amount - Decimal
id - ID!
portionType - InvestmentPortionType
Example
{
  "amount": Decimal,
  "id": "4",
  "portionType": "AMOUNT"
}
Types

CreateActiveStrategyInput

Fields
Input Field Description
assets - [ActiveStrategyAssetInput!]!
brokerAccountId - ID!
initialInvestmentAmount - Decimal
initialInvestmentPortionType - InvestmentPortionType
isRebalanceOn - Boolean!
isScheduledContributionOn - Boolean!
name - String!
oneTimeOrder - Boolean!
rebalanceFrequency - RebalanceFrequency
scheduledContributionAmount - Decimal
scheduledContributionFrequency - ScheduledContributionFrequency
scheduledContributionPortionType - InvestmentPortionType
sourceStrategyId - ID
subscribedStrategyHistoryId - String
Example
{
  "assets": [ActiveStrategyAssetInput],
  "brokerAccountId": 4,
  "initialInvestmentAmount": Decimal,
  "initialInvestmentPortionType": "AMOUNT",
  "isRebalanceOn": false,
  "isScheduledContributionOn": true,
  "name": "xyz789",
  "oneTimeOrder": false,
  "rebalanceFrequency": "ANNUALLY",
  "scheduledContributionAmount": Decimal,
  "scheduledContributionFrequency": "FORTNIGHT_START",
  "scheduledContributionPortionType": "AMOUNT",
  "sourceStrategyId": "4",
  "subscribedStrategyHistoryId": "xyz789"
}
Types

CreateCryptoAutoSweepInput

Fields
Input Field Description
asset - String!
tradingMode - String!
whitelistedWalletId - String
Example
{
  "asset": "abc123",
  "tradingMode": "xyz789",
  "whitelistedWalletId": "xyz789"
}
Types

CreateCryptoWalletsInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "abc123"}
Types

CreateCustomInstrumentInput

Fields
Input Field Description
currency - String!
excludeFromCalculations - Boolean
instrumentType - String!
name - String!
symbol - String!
unit - String!
Example
{
  "currency": "xyz789",
  "excludeFromCalculations": false,
  "instrumentType": "xyz789",
  "name": "abc123",
  "symbol": "abc123",
  "unit": "xyz789"
}
Types

CreateCustomInstrumentWithDetailsInput

Fields
Input Field Description
currency - String!
excludeFromCalculations - Boolean
initialPrice - WealthrelayInstrumentPriceInput
instrumentType - String!
metaData - [MetaDataInput!]
name - String!
portfolioCode - String
purchaseDate - String
purchasePrice - String
quantity - String
symbol - String!
unit - String!
Example
{
  "currency": "abc123",
  "excludeFromCalculations": false,
  "initialPrice": WealthrelayInstrumentPriceInput,
  "instrumentType": "xyz789",
  "metaData": [MetaDataInput],
  "name": "xyz789",
  "portfolioCode": "xyz789",
  "purchaseDate": "xyz789",
  "purchasePrice": "xyz789",
  "quantity": "abc123",
  "symbol": "xyz789",
  "unit": "abc123"
}
Types

CreateNZDBankAccountAddressInput

Fields
Input Field Description
city - String!
country - String!
firstLine - String!
postCode - String!
Example
{
  "city": "abc123",
  "country": "xyz789",
  "firstLine": "xyz789",
  "postCode": "abc123"
}
Types

CreateNZDBankAccountDetailsInput

Fields
Input Field Description
accountNumber - String!
address - CreateNZDBankAccountAddressInput!
legalType - LegalType!
swiftCode - String
Example
{
  "accountNumber": "xyz789",
  "address": CreateNZDBankAccountAddressInput,
  "legalType": "BUSINESS",
  "swiftCode": "abc123"
}
Types

CreateNZDBankAccountInput

Fields
Input Field Description
accountHolderName - String!
currency - Currency!
details - CreateNZDBankAccountDetailsInput!
type - String!
userProvidedName - String!
Example
{
  "accountHolderName": "abc123",
  "currency": "AUD",
  "details": CreateNZDBankAccountDetailsInput,
  "type": "xyz789",
  "userProvidedName": "xyz789"
}
Types

CreateNetWorthDividendInput

Fields
Input Field Description
amount - String!
amountPerShare - String
executionDate - String!
market - String!
paidDate - String
portfolioCode - String
symbol - String!
Example
{
  "amount": "xyz789",
  "amountPerShare": "xyz789",
  "executionDate": "xyz789",
  "market": "xyz789",
  "paidDate": "xyz789",
  "portfolioCode": "abc123",
  "symbol": "abc123"
}
Types

CreateNetWorthDocumentUploadInput

Fields
Input Field Description
category - String
contentType - String!
fileName - String!
sizeBytes - Int!
Example
{
  "category": "xyz789",
  "contentType": "abc123",
  "fileName": "xyz789",
  "sizeBytes": 123
}
Types

CreateNetWorthExpenseInput

Fields
Input Field Description
category - String!
description - String
monthlyAmount - String!
Example
{
  "category": "xyz789",
  "description": "abc123",
  "monthlyAmount": "abc123"
}
Types

CreateNetWorthGoalInput

Fields
Input Field Description
attachedAssetIds - [String!]
attachedLiabilityIds - [String!]
currentAmount - String
description - String
isFinancial - Boolean
name - String!
priority - String
targetAmount - String
targetDate - String
Example
{
  "attachedAssetIds": ["xyz789"],
  "attachedLiabilityIds": ["abc123"],
  "currentAmount": "abc123",
  "description": "xyz789",
  "isFinancial": false,
  "name": "xyz789",
  "priority": "abc123",
  "targetAmount": "xyz789",
  "targetDate": "abc123"
}
Types

CreateNetWorthIncomeInput

Fields
Input Field Description
annualAmount - String!
description - String
isAfterTax - Boolean
source - String!
Example
{
  "annualAmount": "abc123",
  "description": "abc123",
  "isAfterTax": false,
  "source": "abc123"
}
Types

CreateNetWorthLiabilityInput

Fields
Input Field Description
currentBalance - String!
description - String
interestRate - String
monthlyPayment - String
originalAmount - String
remainingTerm - String
type - String!
Example
{
  "currentBalance": "xyz789",
  "description": "abc123",
  "interestRate": "xyz789",
  "monthlyPayment": "abc123",
  "originalAmount": "xyz789",
  "remainingTerm": "xyz789",
  "type": "abc123"
}
Types

CreateNetWorthLiabilityTradeInput

Fields
Input Field Description
amount - String!
date - String!
liabilityId - String!
note - String
type - String!
Example
{
  "amount": "abc123",
  "date": "xyz789",
  "liabilityId": "abc123",
  "note": "xyz789",
  "type": "xyz789"
}
Types

CreateNetworthPortfolioInput

Fields
Input Field Description
name - String!
parentPortfolioCode - String
Example
{
  "name": "xyz789",
  "parentPortfolioCode": "xyz789"
}
Types

CreateOAuthLinkInput

Fields
Input Field Description
email - String!
key - String!
name - String
provider - String!
Example
{
  "email": "abc123",
  "key": "abc123",
  "name": "xyz789",
  "provider": "xyz789"
}
Types

CreatePendingUserTransactionInput

Fields
Input Field Description
amountDeposited - Decimal!
currency - Currency!
estimatedExchangeRate - Decimal!
reference - String!
transactionType - PendingUserTransactionType!
Example
{
  "amountDeposited": Decimal,
  "currency": "AUD",
  "estimatedExchangeRate": Decimal,
  "reference": "abc123",
  "transactionType": "DEPOSIT"
}
Types

CreateStrategyAssetVoteInput

Fields
Input Field Description
assetId - ID!
direction - AssetVoteDirection!
strategyId - ID!
Example
{
  "assetId": "4",
  "direction": "LONG",
  "strategyId": "4"
}
Types

CreateStrategyInput

Fields
Input Field Description
category - StrategyCategory
description - String
isVotingEnabled - Boolean!
name - String!
privacy - StrategyPrivacy!
targetWeights - [StrategyAssetWeightInput!]
type - StrategyType!
Example
{
  "category": "ACTIVIST",
  "description": "xyz789",
  "isVotingEnabled": true,
  "name": "abc123",
  "privacy": "PRIVATE",
  "targetWeights": [StrategyAssetWeightInput],
  "type": "COMMUNITY"
}
Types

CreateTradeForAssetInput

Fields
Input Field Description
purchaseDate - String!
purchasePrice - String
quantity - String
symbol - String!
Example
{
  "purchaseDate": "xyz789",
  "purchasePrice": "xyz789",
  "quantity": "xyz789",
  "symbol": "xyz789"
}
Types

CreateTradeInput

Fields
Input Field Description
comment - String
data - TradeDataInput!
market - String!
portfolioCode - String
symbol - String!
thirdPartyId - String
tradeDate - GemDate!
Example
{
  "comment": "abc123",
  "data": TradeDataInput,
  "market": "xyz789",
  "portfolioCode": "xyz789",
  "symbol": "xyz789",
  "thirdPartyId": "xyz789",
  "tradeDate": GemDate
}
Types

CreateUSDBankAccountAddressInput

Fields
Input Field Description
city - String!
country - String!
firstLine - String!
postCode - String!
state - String!
Example
{
  "city": "abc123",
  "country": "abc123",
  "firstLine": "xyz789",
  "postCode": "xyz789",
  "state": "xyz789"
}
Types

CreateUSDBankAccountDetailsInput

Fields
Input Field Description
abartn - String!
accountNumber - String!
accountType - String!
address - CreateUSDBankAccountAddressInput!
legalType - LegalType!
swiftCode - String
Example
{
  "abartn": "xyz789",
  "accountNumber": "xyz789",
  "accountType": "abc123",
  "address": CreateUSDBankAccountAddressInput,
  "legalType": "BUSINESS",
  "swiftCode": "abc123"
}
Types

CreateUSDBankAccountInput

Fields
Input Field Description
accountHolderName - String!
currency - Currency!
details - CreateUSDBankAccountDetailsInput!
type - String!
userProvidedName - String!
Example
{
  "accountHolderName": "xyz789",
  "currency": "AUD",
  "details": CreateUSDBankAccountDetailsInput,
  "type": "abc123",
  "userProvidedName": "abc123"
}
Types

CreateUserWithdrawalRequestInput

Fields
Input Field Description
amount - Decimal!
targetCurrency - Currency!
userProvidedReference - String!
Example
{
  "amount": Decimal,
  "targetCurrency": "AUD",
  "userProvidedReference": "abc123"
}
Types

CreateWalletInput

Fields
Input Field Description
address - String!
blockchain - String!
name - String!
syncFrom - GemDate
Example
{
  "address": "abc123",
  "blockchain": "xyz789",
  "name": "xyz789",
  "syncFrom": GemDate
}
Types

Crypto

Fields
Field Name Description
createdAt - GemDate!
financials - CryptoFinancials
id - ID!
identifiers - ICryptoIdentifiers!
isDelisted - Boolean!
isFractionable - Boolean!
isTradable - Boolean!
logoURL - String
maintenanceMarginRequirement - Decimal
minOrderSize - Decimal
minTradeIncrement - Decimal
name - String!
priceIncrement - Decimal
sparkline - [Candlestick!]!
statistics - CryptoStatistics
Example
{
  "createdAt": GemDate,
  "financials": CryptoFinancials,
  "id": 4,
  "identifiers": ICryptoIdentifiers,
  "isDelisted": true,
  "isFractionable": false,
  "isTradable": false,
  "logoURL": "xyz789",
  "maintenanceMarginRequirement": Decimal,
  "minOrderSize": Decimal,
  "minTradeIncrement": Decimal,
  "name": "xyz789",
  "priceIncrement": Decimal,
  "sparkline": [Candlestick],
  "statistics": CryptoStatistics
}
Types

CryptoAutoSweepResponse

Fields
Field Name Description
asset - String!
id - ID!
reference - String!
status - String!
whitelistedWalletId - String
Example
{
  "asset": "abc123",
  "id": "4",
  "reference": "xyz789",
  "status": "xyz789",
  "whitelistedWalletId": "abc123"
}
Types

CryptoFinancials

Fields
Field Name Description
createdAt - GemDate!
id - ID!
latestDailyCandlestick - OneDayCandlestick
latestPrice - Decimal!
penultimateDailyCandlestick - OneDayCandlestick
priceWindows - IPriceWindows!
recipient - Crypto!
Example
{
  "createdAt": GemDate,
  "id": "4",
  "latestDailyCandlestick": OneDayCandlestick,
  "latestPrice": Decimal,
  "penultimateDailyCandlestick": OneDayCandlestick,
  "priceWindows": IPriceWindows,
  "recipient": Crypto
}
Types

CryptoStatistics

Fields
Field Name Description
CirculatingSupply - Decimal
Explorer - String
HighAllTime - Decimal
LowAllTime - Decimal
MarketCapDominance - Decimal
MarketCapitalization - Decimal
MarketCapitalizationDiluted - Decimal
MaxSupply - Decimal
MessageBoard - String
SourceCode - String
TechnicalDoc - String
TotalSupply - Decimal
Example
{
  "CirculatingSupply": Decimal,
  "Explorer": "abc123",
  "HighAllTime": Decimal,
  "LowAllTime": Decimal,
  "MarketCapDominance": Decimal,
  "MarketCapitalization": Decimal,
  "MarketCapitalizationDiluted": Decimal,
  "MaxSupply": Decimal,
  "MessageBoard": "xyz789",
  "SourceCode": "abc123",
  "TechnicalDoc": "abc123",
  "TotalSupply": Decimal
}
Types

CryptoTransfer

Fields
Field Name Description
amount - String!
asset - String!
chain - String!
created_at - String!
direction - String!
fees - String!
from_address - String!
id - String!
network_fee - String!
status - String!
to_address - String!
tx_hash - String
usd_value - String!
Example
{
  "amount": "xyz789",
  "asset": "xyz789",
  "chain": "xyz789",
  "created_at": "xyz789",
  "direction": "xyz789",
  "fees": "xyz789",
  "from_address": "xyz789",
  "id": "xyz789",
  "network_fee": "xyz789",
  "status": "abc123",
  "to_address": "xyz789",
  "tx_hash": "xyz789",
  "usd_value": "xyz789"
}
Types

CryptoWallet

Fields
Field Name Description
address - String!
amount - Decimal!
assetName - String!
pendingWithdrawalAmount - Decimal!
value - Decimal!
Example
{
  "address": "abc123",
  "amount": Decimal,
  "assetName": "xyz789",
  "pendingWithdrawalAmount": Decimal,
  "value": Decimal
}
Types

CryptoWalletAddress

Fields
Field Name Description
address - String!
assetName - String!
network - String
Example
{
  "address": "abc123",
  "assetName": "abc123",
  "network": "xyz789"
}
Types

Currency

Values
Enum Value Description

AUD

CAD

GBP

HKD

NZD

USD

YEN
Example
"AUD"
Types

CurrentRateInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "xyz789"}
Types

CustomInstrument

Fields
Field Name Description
createdAt - String!
currency - String!
delisted - Boolean!
instrumentType - String!
logoUrl - String
metaData - [CustomInstrumentMetaData!]
name - String!
symbol - String!
unit - String!
updatedAt - String!
Example
{
  "createdAt": "xyz789",
  "currency": "xyz789",
  "delisted": true,
  "instrumentType": "abc123",
  "logoUrl": "abc123",
  "metaData": [CustomInstrumentMetaData],
  "name": "xyz789",
  "symbol": "xyz789",
  "unit": "xyz789",
  "updatedAt": "xyz789"
}
Types

CustomInstrumentMetaData

Fields
Field Name Description
key - String!
value - String!
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

DateTimeISO

Example
"2007-12-03T10:15:30Z"
Types

DayOfWeek

Values
Enum Value Description

Friday

Monday

Saturday

Sunday

Thursday

Tuesday

Wednesday
Example
"Friday"
Types

Decimal

Example
Decimal
Types

DeleteAssistantThreadByAssistantThreadIdInput

Fields
Input Field Description
idForThread - String!
Example
{"idForThread": "xyz789"}
Types

DeleteCardInput

Fields
Input Field Description
cardId - String!
Example
{"cardId": "xyz789"}
Types

DeleteInstrumentFromPortfolioInput

Fields
Input Field Description
market - String!
portfolioCode - String!
symbol - String!
Example
{
  "market": "abc123",
  "portfolioCode": "xyz789",
  "symbol": "xyz789"
}
Types

DeleteInstrumentPriceInput

Fields
Input Field Description
dateTime - String!
market - String!
symbol - String!
Example
{
  "dateTime": "abc123",
  "market": "abc123",
  "symbol": "xyz789"
}
Types

DeleteOAuthLinkInput

Fields
Input Field Description
key - String!
provider - String!
Example
{
  "key": "xyz789",
  "provider": "abc123"
}
Types

DeletePendingUserTransactionInput

Fields
Input Field Description
id - String!
reference - String!
transactionType - PendingUserTransactionType!
Example
{
  "id": "abc123",
  "reference": "xyz789",
  "transactionType": "DEPOSIT"
}
Types

DeleteWhitelistedWalletInput

Fields
Input Field Description
tradingMode - String!
whitelistedWalletId - String!
Example
{
  "tradingMode": "abc123",
  "whitelistedWalletId": "abc123"
}
Types

Deposit

Fields
Field Name Description
NZDAmount - Decimal
NZDEburyFee - Decimal
NZDEccuityFee - Decimal
NZDFinalAmount - Decimal
NZDWiseFee - Decimal
USDAmount - Decimal
USDEburyFee - Decimal
USDEccuityFee - Decimal
USDFinalAmount - Decimal
USDWiseFee - Decimal
alpacaJournalCompletedAt - DateTimeISO
alpacaJournalId - String
alpacaJournalInitiatedAt - DateTimeISO
createdAt - DateTimeISO!
cryptoAutoSweepId - String
date - DateTimeISO!
hasSweepBuyOrder - Boolean
id - ID!
lastViewedAt - DateTimeISO
reference - String!
senderAccount - String!
senderName - String!
status - String!
updatedAt - DateTimeISO!
userEmail - String!
userName - String!
wiseReceivedAt - DateTimeISO
Example
{
  "NZDAmount": Decimal,
  "NZDEburyFee": Decimal,
  "NZDEccuityFee": Decimal,
  "NZDFinalAmount": Decimal,
  "NZDWiseFee": Decimal,
  "USDAmount": Decimal,
  "USDEburyFee": Decimal,
  "USDEccuityFee": Decimal,
  "USDFinalAmount": Decimal,
  "USDWiseFee": Decimal,
  "alpacaJournalCompletedAt": "2007-12-03T10:15:30Z",
  "alpacaJournalId": "xyz789",
  "alpacaJournalInitiatedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "cryptoAutoSweepId": "xyz789",
  "date": "2007-12-03T10:15:30Z",
  "hasSweepBuyOrder": true,
  "id": 4,
  "lastViewedAt": "2007-12-03T10:15:30Z",
  "reference": "xyz789",
  "senderAccount": "abc123",
  "senderName": "xyz789",
  "status": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "userEmail": "xyz789",
  "userName": "xyz789",
  "wiseReceivedAt": "2007-12-03T10:15:30Z"
}
Types

DevicePlatformInput

Values
Enum Value Description

ANDROID_FCM

IOS_APNS

WEB_PUSH
Example
"ANDROID_FCM"
Types

DeviceToken

Fields
Field Name Description
createdAt - DateTimeISO!
id - ID!
lastUsedAt - DateTimeISO
platform - DevicePlatformInput!
userAgent - String
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "lastUsedAt": "2007-12-03T10:15:30Z",
  "platform": "ANDROID_FCM",
  "userAgent": "xyz789"
}
Types

DiscoverList

Fields
Field Name Description
createdAt - DateTimeISO!
description - String!
hexColor - String!
id - ID!
imageUrl - String
link - String!
title - String!
updatedAt - DateTimeISO!
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "hexColor": "xyz789",
  "id": "4",
  "imageUrl": "abc123",
  "link": "xyz789",
  "title": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

ETF

Fields
Field Name Description
candlesticks - [Candlestick!]!
createdAt - GemDate!
description - String!
exchange - Exchange!
expenseRatio - Decimal
financials - ETFFinancials
holdings - [ETFHolding!]!
id - ID!
identifiers - IETFIdentifiers!
isDelisted - Boolean!
isFractionable - Boolean!
isTradable - Boolean!
logoURL - String
maintenanceMarginRequirement - Decimal
marketCap - Decimal
minOrderSize - Decimal
minTradeIncrement - Decimal
name - String!
priceIncrement - Decimal
sparkline - [Candlestick!]!
status - ETFStatus!
yield - Decimal
Example
{
  "candlesticks": [Candlestick],
  "createdAt": GemDate,
  "description": "abc123",
  "exchange": Exchange,
  "expenseRatio": Decimal,
  "financials": ETFFinancials,
  "holdings": [ETFHolding],
  "id": "4",
  "identifiers": IETFIdentifiers,
  "isDelisted": false,
  "isFractionable": true,
  "isTradable": true,
  "logoURL": "xyz789",
  "maintenanceMarginRequirement": Decimal,
  "marketCap": Decimal,
  "minOrderSize": Decimal,
  "minTradeIncrement": Decimal,
  "name": "abc123",
  "priceIncrement": Decimal,
  "sparkline": [Candlestick],
  "status": "ACTIVE",
  "yield": Decimal
}
Types

ETFFinancials

Fields
Field Name Description
createdAt - GemDate!
id - ID!
latestDailyCandlestick - OneDayCandlestick
latestPrice - Decimal!
penultimateDailyCandlestick - OneDayCandlestick
priceWindows - IPriceWindows!
recipient - ETF!
Example
{
  "createdAt": GemDate,
  "id": "4",
  "latestDailyCandlestick": OneDayCandlestick,
  "latestPrice": Decimal,
  "penultimateDailyCandlestick": OneDayCandlestick,
  "priceWindows": IPriceWindows,
  "recipient": ETF
}
Types

ETFHolding

Fields
Field Name Description
asset - Asset!
createdAt - GemDate!
id - ID!
weight - Decimal!
Example
{
  "asset": Crypto,
  "createdAt": GemDate,
  "id": "4",
  "weight": Decimal
}
Types

ETFStatus

Values
Enum Value Description

ACTIVE

INACTIVE
Example
"ACTIVE"
Types

EmailImportStatus

Values
Enum Value Description

FAILED

IMPORTED

NOT_SUPPORTED

PENDING

UNKNOWN
Example
"FAILED"
Types

EmailLinkToInvestmentCalculatorInput

Fields
Input Field Description
compoundFrequency - Decimal!
contributeAtStart - Boolean!
contributionFrequency - Decimal!
email - String!
regularContribution - Decimal!
returnRate - Decimal!
startPrincipal - Decimal!
targetAmount - Decimal!
years - Decimal!
Example
{
  "compoundFrequency": Decimal,
  "contributeAtStart": true,
  "contributionFrequency": Decimal,
  "email": "abc123",
  "regularContribution": Decimal,
  "returnRate": Decimal,
  "startPrincipal": Decimal,
  "targetAmount": Decimal,
  "years": Decimal
}
Types

Exchange

Fields
Field Name Description
activeStocks - [Stock!]!
createdAt - GemDate!
currency - String!
exchangeClosedAt - GemDate
exchangeOpenedAt - GemDate!
id - ID!
identifiers - IExchangeIdentifiers!
name - String!
timezone - String!
tradingWindows - [IExchangeTradingWindow!]!
Example
{
  "activeStocks": [Stock],
  "createdAt": GemDate,
  "currency": "abc123",
  "exchangeClosedAt": GemDate,
  "exchangeOpenedAt": GemDate,
  "id": 4,
  "identifiers": IExchangeIdentifiers,
  "name": "xyz789",
  "timezone": "xyz789",
  "tradingWindows": [IExchangeTradingWindow]
}
Types

ExchangeHoliday

Fields
Field Name Description
date - DateTimeISO!
name - String!
type - String!
Example
{
  "date": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "type": "abc123"
}
Types

ExchangeTradingWindow

Fields
Field Name Description
close - String!
day - DayOfWeek!
open - String!
Example
{
  "close": "abc123",
  "day": "Friday",
  "open": "xyz789"
}
Types

ExpertObject

Fields
Field Name Description
bio - String!
categories - [String!]!
id - ID!
imageAlt - String
imageUrl - String
isDraft - Boolean!
lastUpdated - String
meetingLink - String
name - String!
slug - String
title - String!
Example
{
  "bio": "abc123",
  "categories": ["xyz789"],
  "id": "4",
  "imageAlt": "abc123",
  "imageUrl": "xyz789",
  "isDraft": true,
  "lastUpdated": "abc123",
  "meetingLink": "abc123",
  "name": "abc123",
  "slug": "xyz789",
  "title": "abc123"
}
Types

ExportJobGql

Fields
Field Name Description
createdAt - String!
downloadUrl - String
expiresAt - String
id - String!
lastViewedAt - String
name - String!
status - String!
Example
{
  "createdAt": "xyz789",
  "downloadUrl": "abc123",
  "expiresAt": "xyz789",
  "id": "xyz789",
  "lastViewedAt": "abc123",
  "name": "xyz789",
  "status": "abc123"
}
Types

FeatureFlagNames

Values
Enum Value Description

ADMIN

ADVISOR_FORECAST

AI_NETWORTH

ANNOUNCEMENTS

CRYPTO_CSV_EXPORT

CSV_EXPORT

DOCUMENT_VAULT

EBURY

EXTENDED_ECCUITY_PRIVATE

FLOATING_AI_ASSISTANT

HAS_ACCOUNT

IMPERSONATION

KYC_ONBOARDING_REDESIGN

NATIVE_SOCIAL_APPLE_PASSKEYS

NETWORTH_ONBOARDING

PAPER_CRYPTO_WALLETS

PERSISTENT_MOBILE_BOTTOM_NAV

PORTFOLIO_MOBILE_REDESIGN

PORTFOLIO_NET_DEPOSITS_LINE

SUBSCRIPTION_PLUS

SUBSCRIPTION_PRIVATE

SUBSCRIPTION_PRO

SYNC_ECCUITY

WHOLESALE
Example
"ADMIN"
Types

FetchAccountAgreementsInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "xyz789"}
Types

FetchActiveStrategyInput

Fields
Input Field Description
includeInactive - Boolean
limit - Int
offset - Int
tradingMode - String!
Example
{
  "includeInactive": true,
  "limit": 123,
  "offset": 987,
  "tradingMode": "xyz789"
}
Types

FetchAssetByAssetIdInput

Fields
Input Field Description
idForAsset - ID!
Example
{"idForAsset": 4}
Types

FetchAssetsByAssetIdsInput

Fields
Input Field Description
idsForAssets - [ID!]!
Example
{"idsForAssets": [4]}
Types

FetchAssetsByTickersInput

Fields
Input Field Description
tickers - [String!]!
Example
{"tickers": ["xyz789"]}
Types

FetchAssistantThreadByIdInput

Fields
Input Field Description
idForThread - String!
Example
{"idForThread": "xyz789"}
Types

FetchCryptoTransfersInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "xyz789"}
Types

FetchCryptoWalletAddressInput

Fields
Input Field Description
asset - String!
network - String
tradingMode - String!
Example
{
  "asset": "xyz789",
  "network": "xyz789",
  "tradingMode": "xyz789"
}
Types

FetchCryptoWalletsInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "abc123"}
Types

FetchNewsByAssetIdsInput

Fields
Input Field Description
assetIds - [ID!]!
limit - Int!
offset - Int!
Example
{"assetIds": [4], "limit": 123, "offset": 123}
Types

FetchPortfolioHistoryTimeframe

Values
Enum Value Description

FIFTEEN_MIN

FIVE_MIN

ONE_DAY

ONE_HOUR

ONE_MIN
Example
"FIFTEEN_MIN"
Types

FetchStrategyInput

Fields
Input Field Description
assetType - String
createdWithin - String
filter - String
limit - Int
offset - Int
positionType - String
runningDuration - String
search - String
sortBy - String
sortDirection - String
type - StrategyType
types - [StrategyType!]
Example
{
  "assetType": "xyz789",
  "createdWithin": "xyz789",
  "filter": "abc123",
  "limit": 123,
  "offset": 123,
  "positionType": "xyz789",
  "runningDuration": "abc123",
  "search": "xyz789",
  "sortBy": "abc123",
  "sortDirection": "abc123",
  "type": "COMMUNITY",
  "types": ["COMMUNITY"]
}
Types

FetchWhitelistedWalletsInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "xyz789"}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

GemBrokerAccount

Fields
Field Name Description
alpacaAccountId - String!
alpacaAccountNumber - String!
brokerProvider - BrokerAccountProvider!
buyingPower - Decimal!
createdAt - GemDate!
depositReference - String!
environment - BrokerAccountEnvironment!
equity - Decimal!
id - ID!
kycRequirements - UserKYCRequirements
owner - User!
status - String!
userProvidedName - String!
Example
{
  "alpacaAccountId": "xyz789",
  "alpacaAccountNumber": "xyz789",
  "brokerProvider": "ALPACA",
  "buyingPower": Decimal,
  "createdAt": GemDate,
  "depositReference": "abc123",
  "environment": "LIVE",
  "equity": Decimal,
  "id": 4,
  "kycRequirements": UserKYCRequirements,
  "owner": User,
  "status": "xyz789",
  "userProvidedName": "xyz789"
}
Types

GemDate

Example
GemDate
Types

GeneratedAssetList

Fields
Field Name Description
assetIds - [String!]!
description - String!
name - String!
Example
{
  "assetIds": ["xyz789"],
  "description": "abc123",
  "name": "xyz789"
}
Types

GetDepositsAndWithdrawalsInput

Fields
Input Field Description
isPaperTrading - Boolean!
Example
{"isPaperTrading": false}
Types

IAddress

Fields
Field Name Description
city - String!
countryCode - String!
countryName - String!
postalCode - String!
stateOrRegion - String!
streetAddress - [String!]!
Example
{
  "city": "abc123",
  "countryCode": "xyz789",
  "countryName": "abc123",
  "postalCode": "abc123",
  "stateOrRegion": "abc123",
  "streetAddress": ["abc123"]
}
Types

ICryptoIdentifiers

Fields
Field Name Description
alpacaPositionSymbol - String!
alpacaPurchaseSymbol - String!
symbol - String!
ticker - String!
Example
{
  "alpacaPositionSymbol": "xyz789",
  "alpacaPurchaseSymbol": "xyz789",
  "symbol": "xyz789",
  "ticker": "xyz789"
}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

IETFIdentifiers

Fields
Field Name Description
symbol - String!
ticker - String!
Example
{
  "symbol": "xyz789",
  "ticker": "abc123"
}
Types

IExchangeIdentifiers

Fields
Field Name Description
alpacaCode - String!
code - String!
Example
{
  "alpacaCode": "abc123",
  "code": "xyz789"
}
Types

IExchangeTradingWindow

Fields
Field Name Description
endDay - DayOfWeek!
endTime - GemDate!
startDay - DayOfWeek!
startTime - GemDate!
Example
{
  "endDay": "Friday",
  "endTime": GemDate,
  "startDay": "Friday",
  "startTime": GemDate
}
Types

ILimitedCompanyIdentifiers

Fields
Field Name Description
orgId - String!
Example
{"orgId": "abc123"}
Types

IPriceWindows

Fields
Field Name Description
oneDay - OneDayCandlestick
oneMonth - OneMonthCandlestick
oneWeek - OneWeekCandlestick
oneYear - OneYearCandlestick
threeMonth - ThreeMonthCandlestick
threeYear - ThreeYearCandlestick
twoYear - TwoYearCandlestick
ytd - YTDCandlestick
Example
{
  "oneDay": OneDayCandlestick,
  "oneMonth": OneMonthCandlestick,
  "oneWeek": OneWeekCandlestick,
  "oneYear": OneYearCandlestick,
  "threeMonth": ThreeMonthCandlestick,
  "threeYear": ThreeYearCandlestick,
  "twoYear": TwoYearCandlestick,
  "ytd": YTDCandlestick
}
Types

IStockHighlights

Fields
Field Name Description
BookValue - Decimal
DilutedEpsTTM - Decimal
DividendShare - Decimal
DividendYield - Decimal
EBITDA - Decimal
EPSEstimateCurrentQuarter - Decimal
EPSEstimateCurrentYear - Decimal
EPSEstimateNextQuarter - Decimal
EPSEstimateNextYear - Decimal
EarningsShare - Decimal
GrossProfitTTM - Decimal
MarketCapitalization - Decimal
MarketCapitalizationMln - Decimal
MostRecentQuarter - String
OperatingMarginTTM - Decimal
PEGRatio - Decimal
PERatio - Decimal
ProfitMargin - Decimal
QuarterlyEarningsGrowthYOY - Decimal
QuarterlyRevenueGrowthYOY - Decimal
ReturnOnAssetsTTM - Decimal
ReturnOnEquityTTM - Decimal
RevenuePerShareTTM - Decimal
RevenueTTM - Decimal
WallStreetTargetPrice - Decimal
Example
{
  "BookValue": Decimal,
  "DilutedEpsTTM": Decimal,
  "DividendShare": Decimal,
  "DividendYield": Decimal,
  "EBITDA": Decimal,
  "EPSEstimateCurrentQuarter": Decimal,
  "EPSEstimateCurrentYear": Decimal,
  "EPSEstimateNextQuarter": Decimal,
  "EPSEstimateNextYear": Decimal,
  "EarningsShare": Decimal,
  "GrossProfitTTM": Decimal,
  "MarketCapitalization": Decimal,
  "MarketCapitalizationMln": Decimal,
  "MostRecentQuarter": "xyz789",
  "OperatingMarginTTM": Decimal,
  "PEGRatio": Decimal,
  "PERatio": Decimal,
  "ProfitMargin": Decimal,
  "QuarterlyEarningsGrowthYOY": Decimal,
  "QuarterlyRevenueGrowthYOY": Decimal,
  "ReturnOnAssetsTTM": Decimal,
  "ReturnOnEquityTTM": Decimal,
  "RevenuePerShareTTM": Decimal,
  "RevenueTTM": Decimal,
  "WallStreetTargetPrice": Decimal
}
Types

IStockIdentifiers

Fields
Field Name Description
contractIdentifier - Decimal
symbol - String!
ticker - String!
Example
{
  "contractIdentifier": Decimal,
  "symbol": "abc123",
  "ticker": "xyz789"
}
Types

IStockShareStats

Fields
Field Name Description
PercentInsiders - Decimal
PercentInstitutions - Decimal
SharesFloat - Decimal
SharesOutstanding - Decimal
SharesShort - Decimal
SharesShortPriorMonth - Decimal
ShortPercentFloat - Decimal
ShortPercentOutstanding - Decimal
ShortRatio - Decimal
Example
{
  "PercentInsiders": Decimal,
  "PercentInstitutions": Decimal,
  "SharesFloat": Decimal,
  "SharesOutstanding": Decimal,
  "SharesShort": Decimal,
  "SharesShortPriorMonth": Decimal,
  "ShortPercentFloat": Decimal,
  "ShortPercentOutstanding": Decimal,
  "ShortRatio": Decimal
}
Types

IStockTechnicals

Fields
Field Name Description
Beta - Decimal
Price50DayMA - Decimal
Price52WeekHigh - Decimal
Price52WeekLow - Decimal
Price200DayMA - Decimal
SharesShort - Decimal
SharesShortPriorMonth - Decimal
ShortPercent - Decimal
ShortRatio - Decimal
Example
{
  "Beta": Decimal,
  "Price50DayMA": Decimal,
  "Price52WeekHigh": Decimal,
  "Price52WeekLow": Decimal,
  "Price200DayMA": Decimal,
  "SharesShort": Decimal,
  "SharesShortPriorMonth": Decimal,
  "ShortPercent": Decimal,
  "ShortRatio": Decimal
}
Types

IStockValuation

Fields
Field Name Description
EnterpriseValue - Decimal
EnterpriseValueEbitda - Decimal
EnterpriseValueRevenue - Decimal
ForwardPE - Decimal
PriceBookMRQ - Decimal
PriceSalesTTM - Decimal
TrailingPE - Decimal
Example
{
  "EnterpriseValue": Decimal,
  "EnterpriseValueEbitda": Decimal,
  "EnterpriseValueRevenue": Decimal,
  "ForwardPE": Decimal,
  "PriceBookMRQ": Decimal,
  "PriceSalesTTM": Decimal,
  "TrailingPE": Decimal
}
Types

IUserKYCDisclosureContext

Fields
Field Name Description
companyCity - String
companyComplianceEmail - String
companyCountry - String
companyName - String
companyState - String
companyStreetAddress - String
contextType - UserKYCDisclosureContextType!
familyName - String
givenName - String
Example
{
  "companyCity": "xyz789",
  "companyComplianceEmail": "abc123",
  "companyCountry": "abc123",
  "companyName": "xyz789",
  "companyState": "xyz789",
  "companyStreetAddress": "abc123",
  "contextType": "AFFILIATE_FIRM",
  "familyName": "xyz789",
  "givenName": "xyz789"
}
Types

IUserKYCW8BENForm

Fields
Field Name Description
additionalConditions - String
countryCitizen - String!
date - String!
dateOfBirth - String!
foreignTaxId - String
ftinNotRequired - Boolean
fullName - String!
incomeType - String
ipAddress - String!
mailingAddressCityState - String
mailingAddressCountry - String
mailingAddressStreet - String
paragraphNumber - String
percentRateWithholding - Decimal
permanentAddressCityState - String!
permanentAddressCountry - String!
permanentAddressStreet - String!
referenceNumber - String
residency - String
revision - String!
signerFullName - String!
taxIdSsn - String
timestamp - String!
Example
{
  "additionalConditions": "xyz789",
  "countryCitizen": "xyz789",
  "date": "abc123",
  "dateOfBirth": "xyz789",
  "foreignTaxId": "abc123",
  "ftinNotRequired": true,
  "fullName": "xyz789",
  "incomeType": "xyz789",
  "ipAddress": "xyz789",
  "mailingAddressCityState": "xyz789",
  "mailingAddressCountry": "abc123",
  "mailingAddressStreet": "abc123",
  "paragraphNumber": "abc123",
  "percentRateWithholding": Decimal,
  "permanentAddressCityState": "abc123",
  "permanentAddressCountry": "xyz789",
  "permanentAddressStreet": "xyz789",
  "referenceNumber": "xyz789",
  "residency": "xyz789",
  "revision": "abc123",
  "signerFullName": "xyz789",
  "taxIdSsn": "abc123",
  "timestamp": "xyz789"
}
Types

InsertMessageIntoAssistantThreadInput

Fields
Input Field Description
idForThread - String!
message - String!
Example
{
  "idForThread": "xyz789",
  "message": "xyz789"
}
Types

InstrumentSearchInput

Fields
Input Field Description
currency - String
includeCustom - Boolean
includeDelisted - Boolean
limit - Int
market - String
query - String!
type - String
Example
{
  "currency": "xyz789",
  "includeCustom": false,
  "includeDelisted": true,
  "limit": 987,
  "market": "abc123",
  "query": "xyz789",
  "type": "abc123"
}
Types

InstrumentSearchResult

Fields
Field Name Description
currency - String!
isCustom - Boolean!
isDelisted - Boolean!
logoUrl - String
market - String!
name - String!
symbol - String!
type - String!
Example
{
  "currency": "abc123",
  "isCustom": false,
  "isDelisted": true,
  "logoUrl": "xyz789",
  "market": "xyz789",
  "name": "xyz789",
  "symbol": "xyz789",
  "type": "xyz789"
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

InterestRatesInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "abc123"}
Types

InvestmentPortionType

Values
Enum Value Description

AMOUNT

PERCENTAGE_BUYING_POWER

PERCENTAGE_CASH

PERCENTAGE_EQUITY
Example
"AMOUNT"
Types

InvestorPreferences

Fields
Field Name Description
assetClasses - [String!]
assistantContactFrequency - AssistantContactFrequency
createdAt - GemDate!
generatedAssetLists - [GeneratedAssetList]!
id - ID!
investingObjectives - [String!]
investingStyle - String
likeableAssets - [LikeableAsset]!
user - User!
Example
{
  "assetClasses": ["abc123"],
  "assistantContactFrequency": "DAILY",
  "createdAt": GemDate,
  "generatedAssetLists": [GeneratedAssetList],
  "id": 4,
  "investingObjectives": ["abc123"],
  "investingStyle": "xyz789",
  "likeableAssets": [LikeableAsset],
  "user": User
}
Types

InvestorPreferencesInput

Fields
Input Field Description
assetClasses - [String!]
assetListId - ID
assistantContactFrequency - AssistantContactFrequency
investingObjectives - [String!]
investingStyle - String
likeableAssets - [LikeableAssetInput!]
Example
{
  "assetClasses": ["abc123"],
  "assetListId": "4",
  "assistantContactFrequency": "DAILY",
  "investingObjectives": ["abc123"],
  "investingStyle": "abc123",
  "likeableAssets": [LikeableAssetInput]
}
Types

KYC

Fields
Field Name Description
companySetup - CompanySetup
createdAt - GemDate!
eccuityInvestStatus - AccountStatus!
id - ID!
kycAgreements - [UserKYCAgreement]!
kycContact - UserKYCContactInformation
kycDisclosures - UserKYCDisclosures
kycFileUploads - [UserKYCUploadedDocument]!
kycIdentity - UserKYCIdentityInformation
kycRequirements - UserKYCRequirements
kycTrustedContact - UserKYCTrustedContact
kycW8BENForm - UserKYCUploadedW8BENFormDocument
onfidoStatus - String
Example
{
  "companySetup": CompanySetup,
  "createdAt": GemDate,
  "eccuityInvestStatus": "ACCOUNT_CLOSED",
  "id": "4",
  "kycAgreements": [UserKYCAgreement],
  "kycContact": UserKYCContactInformation,
  "kycDisclosures": UserKYCDisclosures,
  "kycFileUploads": [UserKYCUploadedFileDocument],
  "kycIdentity": UserKYCIdentityInformation,
  "kycRequirements": UserKYCRequirements,
  "kycTrustedContact": UserKYCTrustedContact,
  "kycW8BENForm": UserKYCUploadedW8BENFormDocument,
  "onfidoStatus": "xyz789"
}
Types

LegacyBrokerAccount

Fields
Field Name Description
autoReinvestDividends - Boolean!
buyingPower - Decimal!
cash - BrokerAccountCash!
cashWithdrawable - BrokerAccountCash!
equity - Decimal!
id - String!
maintenanceMargin - Decimal!
nonMarginableBuyingPower - Decimal
status - String!
type - BrokerAccountType!
Example
{
  "autoReinvestDividends": true,
  "buyingPower": Decimal,
  "cash": BrokerAccountCash,
  "cashWithdrawable": BrokerAccountCash,
  "equity": Decimal,
  "id": "abc123",
  "maintenanceMargin": Decimal,
  "nonMarginableBuyingPower": Decimal,
  "status": "xyz789",
  "type": "LIVE"
}
Types

LegalType

Values
Enum Value Description

BUSINESS

PRIVATE
Example
"BUSINESS"
Types

Like

Types
Union Types

AssetLike

AssistantThreadLike
Example
AssetLike
Types

LikeableAsset

Fields
Field Name Description
assetId - ID!
liked - Boolean!
reason - String!
Example
{
  "assetId": "4",
  "liked": true,
  "reason": "xyz789"
}
Types

LikeableAssetInput

Fields
Input Field Description
assetId - ID!
liked - Boolean!
reason - String!
Example
{
  "assetId": "4",
  "liked": true,
  "reason": "abc123"
}
Types

LimitedCompany

Fields
Field Name Description
address - IAddress!
createdAt - GemDate!
description - String!
financialStatements - [LimitedCompanyFinancialStatement!]!
id - ID!
identifiers - ILimitedCompanyIdentifiers!
industryDescription - String!
name - String!
ratiosReport - LimitedCompanyRatiosReport
sectorDescription - String!
stocks - [Stock!]!
totalOutstandingShares - Decimal!
websites - [String!]!
Example
{
  "address": IAddress,
  "createdAt": GemDate,
  "description": "abc123",
  "financialStatements": [
    LimitedCompanyFinancialStatement
  ],
  "id": 4,
  "identifiers": ILimitedCompanyIdentifiers,
  "industryDescription": "xyz789",
  "name": "xyz789",
  "ratiosReport": LimitedCompanyRatiosReport,
  "sectorDescription": "abc123",
  "stocks": [Stock],
  "totalOutstandingShares": Decimal,
  "websites": ["abc123"]
}
Types

LimitedCompanyBalanceSheet

Fields
Field Name Description
accountsPayable - String
accumulatedAmortization - String
accumulatedDepreciation - String
accumulatedOtherComprehensiveIncome - String
additionalPaidInCapital - String
capitalLeaseObligations - String
capitalStock - String
capitalSurpluse - String
cash - String
cashAndEquivalents - String
cashAndShortTermInvestments - String
commonStock - String
commonStockSharesOutstanding - String
commonStockTotalEquity - String
currentDeferredRevenue - String
deferredLongTermAssetCharges - String
deferredLongTermLiab - String
earningAssets - String
goodWill - String
intangibleAssets - String
inventory - String
liabilitiesAndStockholdersEquity - String
longTermDebt - String
longTermDebtTotal - String
longTermInvestments - String
negativeGoodwill - String
netDebt - String
netInvestedCapital - String
netReceivables - String
netTangibleAssets - String
netWorkingCapital - String
nonCurrentAssetsTotal - String
nonCurrentLiabilitiesOther - String
nonCurrentLiabilitiesTotal - String
nonCurrrentAssetsOther - String
noncontrollingInterestInConsolidatedEntity - String
otherAssets - String
otherCurrentAssets - String
otherCurrentLiab - String
otherLiab - String
otherStockholderEquity - String
preferredStockRedeemable - String
preferredStockTotalEquity - String
propertyPlantAndEquipmentGross - String
propertyPlantAndEquipmentNet - String
propertyPlantEquipment - String
retainedEarnings - String
retainedEarningsTotalEquity - String
shortLongTermDebt - String
shortLongTermDebtTotal - String
shortTermDebt - String
shortTermInvestments - String
temporaryEquityRedeemableNoncontrollingInterests - String
totalAssets - String
totalCurrentAssets - String
totalCurrentLiabilities - String
totalLiab - String
totalPermanentEquity - String
totalStockholderEquity - String
treasuryStock - String
warrants - String
Example
{
  "accountsPayable": "abc123",
  "accumulatedAmortization": "xyz789",
  "accumulatedDepreciation": "abc123",
  "accumulatedOtherComprehensiveIncome": "xyz789",
  "additionalPaidInCapital": "abc123",
  "capitalLeaseObligations": "xyz789",
  "capitalStock": "abc123",
  "capitalSurpluse": "abc123",
  "cash": "xyz789",
  "cashAndEquivalents": "abc123",
  "cashAndShortTermInvestments": "abc123",
  "commonStock": "abc123",
  "commonStockSharesOutstanding": "abc123",
  "commonStockTotalEquity": "xyz789",
  "currentDeferredRevenue": "xyz789",
  "deferredLongTermAssetCharges": "xyz789",
  "deferredLongTermLiab": "xyz789",
  "earningAssets": "xyz789",
  "goodWill": "xyz789",
  "intangibleAssets": "abc123",
  "inventory": "abc123",
  "liabilitiesAndStockholdersEquity": "abc123",
  "longTermDebt": "abc123",
  "longTermDebtTotal": "xyz789",
  "longTermInvestments": "abc123",
  "negativeGoodwill": "xyz789",
  "netDebt": "xyz789",
  "netInvestedCapital": "abc123",
  "netReceivables": "xyz789",
  "netTangibleAssets": "xyz789",
  "netWorkingCapital": "abc123",
  "nonCurrentAssetsTotal": "abc123",
  "nonCurrentLiabilitiesOther": "abc123",
  "nonCurrentLiabilitiesTotal": "abc123",
  "nonCurrrentAssetsOther": "abc123",
  "noncontrollingInterestInConsolidatedEntity": "abc123",
  "otherAssets": "xyz789",
  "otherCurrentAssets": "abc123",
  "otherCurrentLiab": "abc123",
  "otherLiab": "abc123",
  "otherStockholderEquity": "abc123",
  "preferredStockRedeemable": "xyz789",
  "preferredStockTotalEquity": "abc123",
  "propertyPlantAndEquipmentGross": "xyz789",
  "propertyPlantAndEquipmentNet": "xyz789",
  "propertyPlantEquipment": "abc123",
  "retainedEarnings": "abc123",
  "retainedEarningsTotalEquity": "xyz789",
  "shortLongTermDebt": "xyz789",
  "shortLongTermDebtTotal": "xyz789",
  "shortTermDebt": "xyz789",
  "shortTermInvestments": "abc123",
  "temporaryEquityRedeemableNoncontrollingInterests": "xyz789",
  "totalAssets": "abc123",
  "totalCurrentAssets": "abc123",
  "totalCurrentLiabilities": "xyz789",
  "totalLiab": "xyz789",
  "totalPermanentEquity": "abc123",
  "totalStockholderEquity": "abc123",
  "treasuryStock": "xyz789",
  "warrants": "xyz789"
}
Types

LimitedCompanyCashFlowStatement

Fields
Field Name Description
beginPeriodCashFlow - String
capitalExpenditures - String
cashAndCashEquivalentsChanges - String
cashFlowsOtherOperating - String
changeInCash - String
changeInWorkingCapital - String
changeReceivables - String
changeToAccountReceivables - String
changeToInventory - String
changeToLiabilities - String
changeToNetincome - String
changeToOperatingActivities - String
depreciation - String
dividendsPaid - String
endPeriodCashFlow - String
exchangeRateChanges - String
freeCashFlow - String
investments - String
issuanceOfCapitalStock - String
netBorrowings - String
netIncome - String
otherCashflowsFromFinancingActivities - String
otherCashflowsFromInvestingActivities - String
otherNonCashItems - String
salePurchaseOfStock - String
stockBasedCompensation - String
totalCashFromFinancingActivities - String
totalCashFromOperatingActivities - String
totalCashflowsFromInvestingActivities - String
Example
{
  "beginPeriodCashFlow": "xyz789",
  "capitalExpenditures": "abc123",
  "cashAndCashEquivalentsChanges": "xyz789",
  "cashFlowsOtherOperating": "abc123",
  "changeInCash": "xyz789",
  "changeInWorkingCapital": "xyz789",
  "changeReceivables": "abc123",
  "changeToAccountReceivables": "abc123",
  "changeToInventory": "abc123",
  "changeToLiabilities": "xyz789",
  "changeToNetincome": "xyz789",
  "changeToOperatingActivities": "xyz789",
  "depreciation": "xyz789",
  "dividendsPaid": "xyz789",
  "endPeriodCashFlow": "xyz789",
  "exchangeRateChanges": "xyz789",
  "freeCashFlow": "xyz789",
  "investments": "abc123",
  "issuanceOfCapitalStock": "abc123",
  "netBorrowings": "xyz789",
  "netIncome": "abc123",
  "otherCashflowsFromFinancingActivities": "abc123",
  "otherCashflowsFromInvestingActivities": "xyz789",
  "otherNonCashItems": "abc123",
  "salePurchaseOfStock": "xyz789",
  "stockBasedCompensation": "xyz789",
  "totalCashFromFinancingActivities": "abc123",
  "totalCashFromOperatingActivities": "abc123",
  "totalCashflowsFromInvestingActivities": "xyz789"
}
Types

LimitedCompanyFinancialStatement

Fields
Field Name Description
balanceSheet - LimitedCompanyBalanceSheet!
cashFlowStatement - LimitedCompanyCashFlowStatement!
createdAt - GemDate!
id - ID!
incomeStatement - LimitedCompanyIncomeStatement!
period - LimitedCompanyFinancialStatementPeriod!
recipient - LimitedCompany!
Example
{
  "balanceSheet": LimitedCompanyBalanceSheet,
  "cashFlowStatement": LimitedCompanyCashFlowStatement,
  "createdAt": GemDate,
  "id": "4",
  "incomeStatement": LimitedCompanyIncomeStatement,
  "period": "ANNUAL",
  "recipient": LimitedCompany
}
Types

LimitedCompanyFinancialStatementPeriod

Values
Enum Value Description

ANNUAL

INTERIM
Example
"ANNUAL"
Types

LimitedCompanyIncomeStatement

Fields
Field Name Description
costOfRevenue - String
depreciationAndAmortization - String
discontinuedOperations - String
ebit - String
ebitda - String
effectOfAccountingCharges - String
extraordinaryItems - String
grossProfit - String
incomeBeforeTax - String
incomeTaxExpense - String
interestExpense - String
interestIncome - String
minorityInterest - String
netIncome - String
netIncomeApplicableToCommonShares - String
netIncomeFromContinuingOps - String
netInterestIncome - String
nonOperatingIncomeNetOther - String
nonRecurring - String
operatingIncome - String
otherItems - String
otherOperatingExpenses - String
preferredStockAndOtherAdjustments - String
reconciledDepreciation - String
researchDevelopment - String
sellingAndMarketingExpenses - String
sellingGeneralAdministrative - String
taxProvision - String
totalOperatingExpenses - String
totalOtherIncomeExpenseNet - String
totalRevenue - String
Example
{
  "costOfRevenue": "abc123",
  "depreciationAndAmortization": "abc123",
  "discontinuedOperations": "abc123",
  "ebit": "xyz789",
  "ebitda": "xyz789",
  "effectOfAccountingCharges": "xyz789",
  "extraordinaryItems": "abc123",
  "grossProfit": "abc123",
  "incomeBeforeTax": "xyz789",
  "incomeTaxExpense": "abc123",
  "interestExpense": "xyz789",
  "interestIncome": "abc123",
  "minorityInterest": "abc123",
  "netIncome": "xyz789",
  "netIncomeApplicableToCommonShares": "abc123",
  "netIncomeFromContinuingOps": "xyz789",
  "netInterestIncome": "xyz789",
  "nonOperatingIncomeNetOther": "abc123",
  "nonRecurring": "xyz789",
  "operatingIncome": "abc123",
  "otherItems": "abc123",
  "otherOperatingExpenses": "xyz789",
  "preferredStockAndOtherAdjustments": "xyz789",
  "reconciledDepreciation": "abc123",
  "researchDevelopment": "xyz789",
  "sellingAndMarketingExpenses": "xyz789",
  "sellingGeneralAdministrative": "xyz789",
  "taxProvision": "xyz789",
  "totalOperatingExpenses": "xyz789",
  "totalOtherIncomeExpenseNet": "abc123",
  "totalRevenue": "abc123"
}
Types

LimitedCompanyRatiosReport

Fields
Field Name Description
createdAt - GemDate!
highlights - IStockHighlights!
id - ID!
recipient - LimitedCompany!
shareStats - IStockShareStats!
technicals - IStockTechnicals!
valuation - IStockValuation!
Example
{
  "createdAt": GemDate,
  "highlights": IStockHighlights,
  "id": 4,
  "recipient": LimitedCompany,
  "shareStats": IStockShareStats,
  "technicals": IStockTechnicals,
  "valuation": IStockValuation
}
Types

LivePriceData

Fields
Field Name Description
createdAt - GemDate!
id - ID!
price - Decimal
priceChange - Decimal
priceChangePercentage - Decimal
priceSource - String
ticker - String!
timestamp - Long
Example
{
  "createdAt": GemDate,
  "id": "4",
  "price": Decimal,
  "priceChange": Decimal,
  "priceChangePercentage": Decimal,
  "priceSource": "xyz789",
  "ticker": "abc123",
  "timestamp": {}
}
Types

Long

Example
{}
Types

ManualContribution

Fields
Field Name Description
date - DateTimeISO!
id - ID!
orders - [Order!]!
Example
{
  "date": "2007-12-03T10:15:30Z",
  "id": "4",
  "orders": [Order]
}
Types

MarkDepositAsViewedInput

Fields
Input Field Description
id - ID!
Example
{"id": "4"}
Types

MarketHours

Fields
Field Name Description
currentStatus - MarketSessionStatus!
currentStatusLabel - String!
exchangeCode - String!
exchangeName - String!
id - ID!
nextPreMarketTime - DateTimeISO
remainingTime - String
sessions - [MarketSession!]!
timezone - String!
tradingWindows - [ExchangeTradingWindow!]!
upcomingHolidays - [ExchangeHoliday!]!
Example
{
  "currentStatus": "AFTER_HOURS",
  "currentStatusLabel": "abc123",
  "exchangeCode": "xyz789",
  "exchangeName": "xyz789",
  "id": "4",
  "nextPreMarketTime": "2007-12-03T10:15:30Z",
  "remainingTime": "xyz789",
  "sessions": [MarketSession],
  "timezone": "xyz789",
  "tradingWindows": [ExchangeTradingWindow],
  "upcomingHolidays": [ExchangeHoliday]
}
Types

MarketSession

Fields
Field Name Description
endTime - String!
isActive - Boolean!
name - String!
startTime - String!
status - MarketSessionStatus!
Example
{
  "endTime": "xyz789",
  "isActive": true,
  "name": "xyz789",
  "startTime": "xyz789",
  "status": "AFTER_HOURS"
}
Types

MarketSessionStatus

Values
Enum Value Description

AFTER_HOURS

CLOSED

OPEN

PRE_MARKET
Example
"AFTER_HOURS"
Types

MetaDataInput

Fields
Input Field Description
key - String!
value - String!
Example
{
  "key": "xyz789",
  "value": "xyz789"
}
Types

Money

Fields
Field Name Description
amount - Decimal!
currency - Currency!
Example
{"amount": Decimal, "currency": "AUD"}
Types

NetWorthAsset

Fields
Field Name Description
contributionPercentage - Decimal
convertedValue - Decimal
createdAt - DateTimeISO!
currency - String
currencyGain - Decimal
currentValue - Decimal!
description - String
estimatedReturn - Decimal
fxRate - Decimal
growth - Decimal
growthPercent - Decimal
householdId - String!
id - String!
includeInCalculations - Boolean!
initialValue - Decimal
logoUrl - String
market - String
portfolioCode - String
portfolioName - String
purchaseDate - DateTimeISO
purchasePrice - Decimal
quantity - Decimal
ticker - String
type - String!
unitPrice - Decimal
updatedAt - DateTimeISO!
Example
{
  "contributionPercentage": Decimal,
  "convertedValue": Decimal,
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "xyz789",
  "currencyGain": Decimal,
  "currentValue": Decimal,
  "description": "abc123",
  "estimatedReturn": Decimal,
  "fxRate": Decimal,
  "growth": Decimal,
  "growthPercent": Decimal,
  "householdId": "abc123",
  "id": "abc123",
  "includeInCalculations": true,
  "initialValue": Decimal,
  "logoUrl": "abc123",
  "market": "xyz789",
  "portfolioCode": "xyz789",
  "portfolioName": "abc123",
  "purchaseDate": "2007-12-03T10:15:30Z",
  "purchasePrice": Decimal,
  "quantity": Decimal,
  "ticker": "abc123",
  "type": "abc123",
  "unitPrice": Decimal,
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

NetWorthAssetDividend

Fields
Field Name Description
amount - Float!
amountPerShare - Float!
code - String!
currency - String!
executionDate - String!
paidDate - String!
pending - Boolean!
Example
{
  "amount": 123.45,
  "amountPerShare": 987.65,
  "code": "abc123",
  "currency": "abc123",
  "executionDate": "xyz789",
  "paidDate": "xyz789",
  "pending": true
}
Types

NetWorthAssetHistory

Fields
Field Name Description
assetId - String!
changeReason - String
contributionPercentage - Decimal
createdAt - DateTimeISO!
currency - String
currentValue - Decimal!
description - String
estimatedReturn - Decimal
householdId - String!
id - String!
includeInCalculations - Boolean!
purchaseDate - DateTimeISO
purchasePrice - Decimal
tradeData - WealthRelayTradeData
type - String!
updatedAt - DateTimeISO!
validFrom - DateTimeISO!
validTo - DateTimeISO
Example
{
  "assetId": "xyz789",
  "changeReason": "abc123",
  "contributionPercentage": Decimal,
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "xyz789",
  "currentValue": Decimal,
  "description": "abc123",
  "estimatedReturn": Decimal,
  "householdId": "xyz789",
  "id": "abc123",
  "includeInCalculations": false,
  "purchaseDate": "2007-12-03T10:15:30Z",
  "purchasePrice": Decimal,
  "tradeData": WealthRelayTradeData,
  "type": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "validFrom": "2007-12-03T10:15:30Z",
  "validTo": "2007-12-03T10:15:30Z"
}
Types

NetWorthDashboard

Fields
Field Name Description
assets - [NetWorthAsset!]!
currentPortfolio - NetWorthPortfolio
expenses - [NetWorthExpense!]!
goals - [NetWorthGoal!]!
household - NetWorthHousehold!
incomes - [NetWorthIncome!]!
liabilities - [NetWorthLiability!]!
portfolios - [NetWorthPortfolio!]!
snapshots - [NetWorthSnapshot!]!
totals - NetWorthTotals!
valueHistory - [NetWorthValueSeries!]!
Example
{
  "assets": [NetWorthAsset],
  "currentPortfolio": NetWorthPortfolio,
  "expenses": [NetWorthExpense],
  "goals": [NetWorthGoal],
  "household": NetWorthHousehold,
  "incomes": [NetWorthIncome],
  "liabilities": [NetWorthLiability],
  "portfolios": [NetWorthPortfolio],
  "snapshots": [NetWorthSnapshot],
  "totals": NetWorthTotals,
  "valueHistory": [NetWorthValueSeries]
}
Types

NetWorthDocument

Fields
Field Name Description
category - String!
contentType - String!
createdAt - String!
downloadUrl - String
fileName - String!
id - String!
sizeBytes - Int!
status - String!
Example
{
  "category": "abc123",
  "contentType": "xyz789",
  "createdAt": "xyz789",
  "downloadUrl": "abc123",
  "fileName": "xyz789",
  "id": "xyz789",
  "sizeBytes": 123,
  "status": "abc123"
}
Types

NetWorthDocumentUpload

Fields
Field Name Description
document - NetWorthDocument!
uploadUrl - String!
Example
{
  "document": NetWorthDocument,
  "uploadUrl": "abc123"
}
Types

NetWorthExpense

Fields
Field Name Description
category - String!
createdAt - DateTimeISO!
description - String
householdId - String!
id - String!
monthlyAmount - Decimal!
updatedAt - DateTimeISO!
Example
{
  "category": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "householdId": "xyz789",
  "id": "abc123",
  "monthlyAmount": Decimal,
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

NetWorthFileUpload

Fields
Field Name Description
code - String!
fileName - String!
uploadUrl - String!
Example
{
  "code": "abc123",
  "fileName": "xyz789",
  "uploadUrl": "xyz789"
}
Types

NetWorthGoal

Fields
Field Name Description
attachedAssetIds - [String!]!
attachedLiabilityIds - [String!]!
createdAt - DateTimeISO!
currentAmount - Decimal!
description - String
householdId - String!
id - String!
isFinancial - Boolean!
name - String!
priority - String!
status - String!
targetAmount - Decimal
targetDate - DateTimeISO
updatedAt - DateTimeISO!
Example
{
  "attachedAssetIds": ["abc123"],
  "attachedLiabilityIds": ["abc123"],
  "createdAt": "2007-12-03T10:15:30Z",
  "currentAmount": Decimal,
  "description": "xyz789",
  "householdId": "xyz789",
  "id": "abc123",
  "isFinancial": true,
  "name": "abc123",
  "priority": "abc123",
  "status": "xyz789",
  "targetAmount": Decimal,
  "targetDate": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

NetWorthHousehold

Fields
Field Name Description
coachNotes - String
createdAt - DateTimeISO!
familySize - Int
id - String!
name - String!
status - String!
updatedAt - DateTimeISO!
userId - String!
Example
{
  "coachNotes": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "familySize": 987,
  "id": "abc123",
  "name": "abc123",
  "status": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z",
  "userId": "xyz789"
}
Types

NetWorthIncome

Fields
Field Name Description
annualAmount - Decimal!
createdAt - DateTimeISO!
description - String
householdId - String!
id - String!
isAfterTax - Boolean!
source - String!
updatedAt - DateTimeISO!
Example
{
  "annualAmount": Decimal,
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "householdId": "xyz789",
  "id": "abc123",
  "isAfterTax": true,
  "source": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

NetWorthLiability

Fields
Field Name Description
createdAt - DateTimeISO!
currentBalance - Decimal!
description - String
householdId - String!
id - String!
interestRate - Decimal
monthlyPayment - Decimal
originalAmount - Decimal
remainingTerm - String
type - String!
updatedAt - DateTimeISO!
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "currentBalance": Decimal,
  "description": "abc123",
  "householdId": "xyz789",
  "id": "abc123",
  "interestRate": Decimal,
  "monthlyPayment": Decimal,
  "originalAmount": Decimal,
  "remainingTerm": "abc123",
  "type": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

NetWorthPortfolio

Fields
Field Name Description
capitalGain - Decimal
code - String!
currencyGain - Decimal
name - String!
totalInvested - Decimal
value - Decimal!
Example
{
  "capitalGain": Decimal,
  "code": "abc123",
  "currencyGain": Decimal,
  "name": "abc123",
  "totalInvested": Decimal,
  "value": Decimal
}
Types

NetWorthPortfolioFile

Fields
Field Name Description
code - String!
contentType - String!
createdAt - String!
downloadUrl - String
extractedData - String
extractionError - String
extractionStatus - String!
fileName - String!
fileSize - Int!
portfolioCode - String
portfolioName - String
source - String!
Example
{
  "code": "xyz789",
  "contentType": "abc123",
  "createdAt": "abc123",
  "downloadUrl": "abc123",
  "extractedData": "abc123",
  "extractionError": "xyz789",
  "extractionStatus": "abc123",
  "fileName": "xyz789",
  "fileSize": 987,
  "portfolioCode": "abc123",
  "portfolioName": "xyz789",
  "source": "xyz789"
}
Types

NetWorthSnapshot

Fields
Field Name Description
createdAt - DateTimeISO!
householdId - String!
id - String!
netWorth - Decimal!
snapshotDate - DateTimeISO!
totalAssets - Decimal!
totalLiabilities - Decimal!
updatedAt - DateTimeISO!
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "householdId": "abc123",
  "id": "abc123",
  "netWorth": Decimal,
  "snapshotDate": "2007-12-03T10:15:30Z",
  "totalAssets": Decimal,
  "totalLiabilities": Decimal,
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

NetWorthTotals

Fields
Field Name Description
annualInterest - Decimal!
baseCurrency - String
monthlySavings - Decimal!
netWorth - Decimal!
totalAnnualIncome - Decimal!
totalAssets - Decimal!
totalCapitalGain - Decimal
totalCurrencyGain - Decimal
totalInvested - Decimal
totalLiabilities - Decimal!
totalMonthlyExpenses - Decimal!
totalReturn - Decimal
Example
{
  "annualInterest": Decimal,
  "baseCurrency": "xyz789",
  "monthlySavings": Decimal,
  "netWorth": Decimal,
  "totalAnnualIncome": Decimal,
  "totalAssets": Decimal,
  "totalCapitalGain": Decimal,
  "totalCurrencyGain": Decimal,
  "totalInvested": Decimal,
  "totalLiabilities": Decimal,
  "totalMonthlyExpenses": Decimal,
  "totalReturn": Decimal
}
Types

NetWorthValuePoint

Fields
Field Name Description
date - String!
value - Decimal!
Example
{
  "date": "xyz789",
  "value": Decimal
}
Types

NetWorthValueSeries

Fields
Field Name Description
key - String!
values - [NetWorthValuePoint!]!
Example
{
  "key": "xyz789",
  "values": [NetWorthValuePoint]
}
Types

NewCardInput

Fields
Input Field Description
token - String!
Example
{"token": "xyz789"}
Types

NewSubscriptionInput

Fields
Input Field Description
lineItemId - String
newPriceId - String!
newProductId - String
oldPriceId - String
oldProductId - String
subscriptionId - String
Example
{
  "lineItemId": "xyz789",
  "newPriceId": "xyz789",
  "newProductId": "xyz789",
  "oldPriceId": "abc123",
  "oldProductId": "abc123",
  "subscriptionId": "abc123"
}
Types

NewsArticle

Fields
Field Name Description
assetInfo - [NewsArticleAssetInfo!]!
date - String!
link - String!
sentiment - NewsArticleSentiment!
symbols - [String!]!
tags - [String!]
title - String!
Example
{
  "assetInfo": [NewsArticleAssetInfo],
  "date": "xyz789",
  "link": "xyz789",
  "sentiment": NewsArticleSentiment,
  "symbols": ["xyz789"],
  "tags": ["xyz789"],
  "title": "abc123"
}
Types

NewsArticleAssetInfo

Fields
Field Name Description
assetType - String!
ticker - String!
Example
{
  "assetType": "xyz789",
  "ticker": "xyz789"
}
Types

NewsArticleSentiment

Fields
Field Name Description
neg - Decimal!
neu - Decimal!
polarity - Decimal!
pos - Decimal!
Example
{
  "neg": Decimal,
  "neu": Decimal,
  "polarity": Decimal,
  "pos": Decimal
}
Types

NewsResponse

Fields
Field Name Description
articles - [NewsArticle!]!
totalCount - Int!
Example
{"articles": [NewsArticle], "totalCount": 987}
Types

NewsletterRegisterInput

Fields
Input Field Description
email - String!
name - String!
subscribe - Boolean!
Example
{
  "email": "xyz789",
  "name": "xyz789",
  "subscribe": false
}
Types

OAuthCommonProfile

Fields
Field Name Description
email - String
name - String
Example
{
  "email": "xyz789",
  "name": "abc123"
}
Types

OneDayCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": 4,
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

OneMonthCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": 4,
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

OneWeekCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": "4",
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

OneYearCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": 4,
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

OnfidoOutcome

Values
Enum Value Description

NOT_STARTED

SDK_ERROR

USER_COMPLETED

USER_EXITED
Example
"NOT_STARTED"
Types

OnfidoOutcomeInput

Fields
Input Field Description
outcome - OnfidoOutcome!
token - String!
Example
{
  "outcome": "NOT_STARTED",
  "token": "xyz789"
}
Types

OptInInterestInput

Fields
Input Field Description
optOut - Boolean!
tradingMode - String!
Example
{"optOut": true, "tradingMode": "abc123"}
Types

OptionChainInput

Fields
Input Field Description
expiration - String
root - String!
Example
{
  "expiration": "abc123",
  "root": "xyz789"
}
Types

OptionContract

Fields
Field Name Description
contractSymbol - String!
expiration - String!
right - String!
root - String!
strike - Decimal!
Example
{
  "contractSymbol": "xyz789",
  "expiration": "abc123",
  "right": "abc123",
  "root": "xyz789",
  "strike": Decimal
}
Types

OptionHistoricalDataInput

Fields
Input Field Description
endDate - String
expiration - String!
right - String!
root - String!
startDate - String!
strike - Decimal!
Example
{
  "endDate": "abc123",
  "expiration": "abc123",
  "right": "abc123",
  "root": "xyz789",
  "startDate": "xyz789",
  "strike": Decimal
}
Types

OptionHistoricalDataPoint

Fields
Field Name Description
askPrice - Decimal
bidPrice - Decimal
close - Decimal!
date - Long!
high - Decimal!
low - Decimal!
open - Decimal!
volume - Long!
Example
{
  "askPrice": Decimal,
  "bidPrice": Decimal,
  "close": Decimal,
  "date": {},
  "high": Decimal,
  "low": Decimal,
  "open": Decimal,
  "volume": {}
}
Types

Order

Fields
Field Name Description
assetId - ID!
commission - Decimal
commissionType - OrderCommissionType!
date - DateTimeISO!
filledAveragePrice - Decimal
filledDate - DateTimeISO
filledQuantity - Decimal
filledTotal - Decimal
id - ID!
limitPrice - Decimal
logoURL - String
name - String
notionalAmount - Decimal
orderId - ID
quantity - Decimal
side - OrderSide!
status - OrderStatus!
statusReason - String
stopPrice - Decimal
ticker - String!
timeInForce - OrderTimeInForce!
type - OrderType!
Example
{
  "assetId": "4",
  "commission": Decimal,
  "commissionType": "BPS",
  "date": "2007-12-03T10:15:30Z",
  "filledAveragePrice": Decimal,
  "filledDate": "2007-12-03T10:15:30Z",
  "filledQuantity": Decimal,
  "filledTotal": Decimal,
  "id": "4",
  "limitPrice": Decimal,
  "logoURL": "abc123",
  "name": "xyz789",
  "notionalAmount": Decimal,
  "orderId": "4",
  "quantity": Decimal,
  "side": "BUY",
  "status": "ACCEPTED",
  "statusReason": "abc123",
  "stopPrice": Decimal,
  "ticker": "abc123",
  "timeInForce": "CLS",
  "type": "LIMIT"
}
Types

OrderCommissionType

Values
Enum Value Description

BPS

NOTIONAL

QTY
Example
"BPS"
Types

OrderSide

Values
Enum Value Description

BUY

SELL
Example
"BUY"
Types

OrderStatus

Values
Enum Value Description

ACCEPTED

ACCEPTED_FOR_BIDDING

CALCULATED

CANCELED

DONE_FOR_DAY

EXPIRED

FILLED

NEW

PARTIALLY_FILLED

PENDING_CANCEL

PENDING_NEW

PENDING_REPLACE

REJECTED

REPLACED

STOPPED

SUSPENDED
Example
"ACCEPTED"
Types

OrderTimeInForce

Values
Enum Value Description

CLS

DAY

FOK

GTC

IOC

OPG
Example
"CLS"
Types

OrderType

Values
Enum Value Description

LIMIT

MARKET

STOP

STOP_LIMIT

TRAILING_STOP
Example
"LIMIT"
Types

PagedOutputOfPortfolio

Fields
Field Name Description
items - [Portfolio!]!
size - Int!
total - Int!
Example
{"items": [Portfolio], "size": 987, "total": 123}
Types

PagedOutputOfWalletWatch

Fields
Field Name Description
hasNextPage - Boolean!
items - [WalletWatch!]!
Example
{"hasNextPage": true, "items": [WalletWatch]}
Types

PagingInput

Fields
Input Field Description
size - Int
Example
{"size": 123}
Types

Passkey

Fields
Field Name Description
backedUp - Boolean!
createdAt - DateTimeISO!
deviceType - String
id - ID!
lastUsedAt - DateTimeISO
name - String
Example
{
  "backedUp": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "deviceType": "abc123",
  "id": 4,
  "lastUsedAt": "2007-12-03T10:15:30Z",
  "name": "abc123"
}
Types

PaymentProviderGQL

Values
Enum Value Description

EBURY

WISE
Example
"EBURY"
Types

PaymentProviderSelection

Values
Enum Value Description

EBURY

WISE
Example
"EBURY"
Types

PayoutRecipient

Fields
Field Name Description
currency - Currency!
externalRecipientId - String!
id - String!
lastError - String
migrationStatus - String!
provider - PaymentProviderSelection!
providerAccountId - String
userProvidedName - String!
Example
{
  "currency": "AUD",
  "externalRecipientId": "xyz789",
  "id": "abc123",
  "lastError": "xyz789",
  "migrationStatus": "abc123",
  "provider": "EBURY",
  "providerAccountId": "abc123",
  "userProvidedName": "abc123"
}
Types

PendingUserTransaction

Fields
Field Name Description
amountDeposited - Decimal!
createdAt - GemDate!
currency - Currency!
estimatedExchangeRate - Decimal!
id - ID!
reference - String!
transactionType - PendingUserTransactionType!
user - User!
Example
{
  "amountDeposited": Decimal,
  "createdAt": GemDate,
  "currency": "AUD",
  "estimatedExchangeRate": Decimal,
  "id": 4,
  "reference": "xyz789",
  "transactionType": "DEPOSIT",
  "user": User
}
Types

PendingUserTransactionType

Values
Enum Value Description

DEPOSIT

WITHDRAWAL
Example
"DEPOSIT"
Types

Portfolio

Fields
Field Name Description
code - String!
metaData - [PortfolioMetaData!]!
name - String!
parentPortfolioCode - String
Example
{
  "code": "abc123",
  "metaData": [PortfolioMetaData],
  "name": "abc123",
  "parentPortfolioCode": "xyz789"
}
Types

PortfolioEmailInfo

Fields
Field Name Description
code - String!
email - String!
emailEnabled - Boolean!
name - String!
tradeEmails - [TradeEmail!]!
Example
{
  "code": "abc123",
  "email": "abc123",
  "emailEnabled": false,
  "name": "xyz789",
  "tradeEmails": [TradeEmail]
}
Types

PortfolioMetaData

Fields
Field Name Description
key - String!
value - String!
Example
{
  "key": "xyz789",
  "value": "abc123"
}
Types

Rebalance

Fields
Field Name Description
date - DateTimeISO!
id - ID!
orders - [Order!]!
Example
{
  "date": "2007-12-03T10:15:30Z",
  "id": 4,
  "orders": [Order]
}
Types

RebalanceFrequency

Values
Enum Value Description

ANNUALLY

BIANNUALLY

FORTNIGHTLY

MONTHLY

QUARTERLY

WEEKLY
Example
"ANNUALLY"
Types

RebalancePreview

Fields
Field Name Description
totalBuys - Decimal!
totalSells - Decimal!
trades - [RebalancePreviewTrade!]!
Example
{
  "totalBuys": Decimal,
  "totalSells": Decimal,
  "trades": [RebalancePreviewTrade]
}
Types

RebalancePreviewTrade

Fields
Field Name Description
action - String!
amount - Decimal!
assetId - String!
currentWeight - Decimal!
logoURL - String!
name - String!
targetWeight - Decimal!
ticker - String!
Example
{
  "action": "abc123",
  "amount": Decimal,
  "assetId": "abc123",
  "currentWeight": Decimal,
  "logoURL": "xyz789",
  "name": "abc123",
  "targetWeight": Decimal,
  "ticker": "xyz789"
}
Types

RecordPushReceiptInput

Fields
Input Field Description
notificationId - String!
Example
{"notificationId": "xyz789"}
Types

RegisterDeviceTokenInput

Fields
Input Field Description
platform - DevicePlatformInput!
token - String!
userAgent - String
Example
{
  "platform": "ANDROID_FCM",
  "token": "xyz789",
  "userAgent": "abc123"
}
Types

RegisterInput

Fields
Input Field Description
email - String!
firstName - String!
key - String
lastName - String!
password - String!
phoneNumber - String!
provider - String
Example
{
  "email": "abc123",
  "firstName": "xyz789",
  "key": "abc123",
  "lastName": "xyz789",
  "password": "xyz789",
  "phoneNumber": "xyz789",
  "provider": "xyz789"
}
Types

RemoveDeviceTokenInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}
Types

RemovePasskeyInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}
Types

RequestCryptoWithdrawalInput

Fields
Input Field Description
address - String!
amount - String!
asset - String!
tradingMode - String!
Example
{
  "address": "abc123",
  "amount": "abc123",
  "asset": "abc123",
  "tradingMode": "xyz789"
}
Types

RequestExportInput

Fields
Input Field Description
activityType - String
asset - String
tradingMode - String!
type - String!
Example
{
  "activityType": "abc123",
  "asset": "xyz789",
  "tradingMode": "xyz789",
  "type": "abc123"
}
Types

RequestMfaEmailInput

Fields
Input Field Description
email - String!
Example
{"email": "abc123"}
Types

RequestPasswordResetInput

Fields
Input Field Description
email - String!
Example
{"email": "abc123"}
Types

RequestWhitelistedWalletInput

Fields
Input Field Description
address - String!
alias - String
asset - String!
name - String!
tradingMode - String!
travelRuleInfo - TravelRuleInfoInput
Example
{
  "address": "xyz789",
  "alias": "xyz789",
  "asset": "abc123",
  "name": "xyz789",
  "tradingMode": "abc123",
  "travelRuleInfo": TravelRuleInfoInput
}
Types

ResendVerificationEmailInput

Fields
Input Field Description
email - String!
Example
{"email": "xyz789"}
Types

ResetPasswordInput

Fields
Input Field Description
email - String!
password - String!
resetCode - String!
Example
{
  "email": "abc123",
  "password": "xyz789",
  "resetCode": "abc123"
}
Types

ScheduledContribution

Fields
Field Name Description
date - DateTimeISO!
id - ID!
orders - [Order!]!
Example
{
  "date": "2007-12-03T10:15:30Z",
  "id": "4",
  "orders": [Order]
}
Types

ScheduledContributionFrequency

Values
Enum Value Description

FORTNIGHT_START

MONTH_END

MONTH_MID

MONTH_START

WEEK_START
Example
"FORTNIGHT_START"
Types

SearchBarInput

Fields
Input Field Description
onlyTradable - Boolean!
search - String!
Example
{"onlyTradable": false, "search": "abc123"}
Types

SearchBarOptionAsset

Fields
Field Name Description
icon - String
id - String!
isTradable - Boolean!
name - String!
symbol - String!
ticker - String!
type - String!
wealthRelayMarketType - String
wealthRelaySymbol - String
Example
{
  "icon": "xyz789",
  "id": "abc123",
  "isTradable": true,
  "name": "abc123",
  "symbol": "abc123",
  "ticker": "xyz789",
  "type": "xyz789",
  "wealthRelayMarketType": "xyz789",
  "wealthRelaySymbol": "abc123"
}
Types

SearchVASPsInput

Fields
Input Field Description
query - String!
tradingMode - String!
Example
{
  "query": "xyz789",
  "tradingMode": "xyz789"
}
Types

SignAgreementsInput

Fields
Input Field Description
agreements - [String!]!
tradingMode - String!
Example
{
  "agreements": ["abc123"],
  "tradingMode": "abc123"
}
Types

SignCustomerAgreementInput

Fields
Input Field Description
tradingMode - String!
Example
{"tradingMode": "xyz789"}
Types

SimulatePaperDepositInput

Fields
Input Field Description
amount - Decimal!
sweepId - String!
Example
{
  "amount": Decimal,
  "sweepId": "xyz789"
}
Types

StartAssistantThreadWithMessageInput

Fields
Input Field Description
message - String!
name - String
Example
{
  "message": "abc123",
  "name": "abc123"
}
Types

Stock

Fields
Field Name Description
candlesticks - [Candlestick!]!
createdAt - GemDate!
description - String!
dividends - [StockDividend!]!
exchange - Exchange!
financials - StockFinancials
id - ID!
identifiers - IStockIdentifiers!
isDelisted - Boolean!
isFractionable - Boolean!
isTradable - Boolean!
limitedCompany - LimitedCompany!
logoURL - String
maintenanceMarginRequirement - Decimal
minOrderSize - Decimal
minTradeIncrement - Decimal
name - String!
priceIncrement - Decimal
sparkline - [Candlestick!]!
status - StockStatus!
Example
{
  "candlesticks": [Candlestick],
  "createdAt": GemDate,
  "description": "xyz789",
  "dividends": [StockDividend],
  "exchange": Exchange,
  "financials": StockFinancials,
  "id": "4",
  "identifiers": IStockIdentifiers,
  "isDelisted": false,
  "isFractionable": false,
  "isTradable": true,
  "limitedCompany": LimitedCompany,
  "logoURL": "xyz789",
  "maintenanceMarginRequirement": Decimal,
  "minOrderSize": Decimal,
  "minTradeIncrement": Decimal,
  "name": "xyz789",
  "priceIncrement": Decimal,
  "sparkline": [Candlestick],
  "status": "ACTIVE"
}
Types

StockDividend

Fields
Field Name Description
createdAt - GemDate!
date - DateTimeISO!
id - ID!
period - String
recipient - Stock!
value - Decimal!
Example
{
  "createdAt": GemDate,
  "date": "2007-12-03T10:15:30Z",
  "id": 4,
  "period": "xyz789",
  "recipient": Stock,
  "value": Decimal
}
Types

StockFinancials

Fields
Field Name Description
createdAt - GemDate!
dividendYield - Decimal!
id - ID!
latestDailyCandlestick - OneDayCandlestick
latestPrice - Decimal!
peRatio - Decimal!
penultimateDailyCandlestick - OneDayCandlestick
priceWindows - IPriceWindows!
recipient - Stock!
Example
{
  "createdAt": GemDate,
  "dividendYield": Decimal,
  "id": "4",
  "latestDailyCandlestick": OneDayCandlestick,
  "latestPrice": Decimal,
  "peRatio": Decimal,
  "penultimateDailyCandlestick": OneDayCandlestick,
  "priceWindows": IPriceWindows,
  "recipient": Stock
}
Types

StockHistoricalDataInput

Fields
Input Field Description
endDate - String
root - String!
startDate - String!
Example
{
  "endDate": "xyz789",
  "root": "xyz789",
  "startDate": "xyz789"
}
Types

StockHistoricalDataPoint

Fields
Field Name Description
close - Decimal!
date - Long!
high - Decimal!
low - Decimal!
open - Decimal!
volume - Long!
Example
{
  "close": Decimal,
  "date": {},
  "high": Decimal,
  "low": Decimal,
  "open": Decimal,
  "volume": {}
}
Types

StockStatus

Values
Enum Value Description

ACTIVE

INACTIVE
Example
"ACTIVE"
Types

Strategy

Fields
Field Name Description
author - Author!
calculatedDays - Int
calculatedIRR - Decimal
calculatedReturn - Decimal
category - StrategyCategory
createdAt - DateTimeISO!
description - String
expectedYield - Decimal
history - [StrategyHistory!]!
Arguments
limit - Int
historyCount - Int
id - ID!
imageURL - String
isVotingEnabled - Boolean!
latestPerformance - Decimal
logoURL - String
name - String!
oneMonthReturn - Decimal
performance - [StrategyPerformance!]!
Arguments
limit - Int
sample - Int
periodReturns - [StrategyPeriodReturn!]!
privacy - StrategyPrivacy
subscriberCount - Int
targetWeights - [StrategyAssetWeight!]!
topHolding - StrategyAssetWeight
type - StrategyType!
videoLink - String
votes - [StrategyAssetVote!]!
Arguments
limit - Int
Example
{
  "author": Author,
  "calculatedDays": 123,
  "calculatedIRR": Decimal,
  "calculatedReturn": Decimal,
  "category": "ACTIVIST",
  "createdAt": "2007-12-03T10:15:30Z",
  "description": "abc123",
  "expectedYield": Decimal,
  "history": [StrategyHistory],
  "historyCount": 123,
  "id": "4",
  "imageURL": "xyz789",
  "isVotingEnabled": false,
  "latestPerformance": Decimal,
  "logoURL": "abc123",
  "name": "abc123",
  "oneMonthReturn": Decimal,
  "performance": [StrategyPerformance],
  "periodReturns": [StrategyPeriodReturn],
  "privacy": "PRIVATE",
  "subscriberCount": 123,
  "targetWeights": [StrategyAssetWeight],
  "topHolding": StrategyAssetWeight,
  "type": "COMMUNITY",
  "videoLink": "xyz789",
  "votes": [StrategyAssetVote]
}
Types

StrategyAssetVote

Fields
Field Name Description
assetId - String!
authorId - String!
direction - AssetVoteDirection!
Example
{
  "assetId": "xyz789",
  "authorId": "xyz789",
  "direction": "LONG"
}
Types

StrategyAssetWeight

Fields
Field Name Description
assetId - String!
logoURL - String
performance - Decimal
ticker - String!
weight - Decimal!
Example
{
  "assetId": "abc123",
  "logoURL": "xyz789",
  "performance": Decimal,
  "ticker": "xyz789",
  "weight": Decimal
}
Types

StrategyAssetWeightInput

Fields
Input Field Description
assetId - String!
weight - Decimal!
Example
{
  "assetId": "xyz789",
  "weight": Decimal
}
Types

StrategyCategory

Values
Enum Value Description

ACTIVIST

AGGRESSIVE

ALPHA

ALTERNATE

ALTERNATIVES

BETA

CLASSIC_BALANCED

GROWTH

HEDGE_FUND_AND_MACRO

RISK_PARITY_AND_DEFENSIVE

VALUE

VALUE_AND_QUALITY

VC_AND_GROWTH
Example
"ACTIVIST"
Types

StrategyHistory

Fields
Field Name Description
endDate - DateTimeISO
id - String!
name - String!
startDate - DateTimeISO!
targetWeights - [StrategyAssetWeight!]!
version - Int!
Example
{
  "endDate": "2007-12-03T10:15:30Z",
  "id": "abc123",
  "name": "abc123",
  "startDate": "2007-12-03T10:15:30Z",
  "targetWeights": [StrategyAssetWeight],
  "version": 987
}
Types

StrategyPerformance

Fields
Field Name Description
date - DateTimeISO!
value - Decimal!
Example
{
  "date": "2007-12-03T10:15:30Z",
  "value": Decimal
}
Types

StrategyPeriodReturn

Fields
Field Name Description
days - Int
label - String!
value - Decimal
Example
{
  "days": 123,
  "label": "abc123",
  "value": Decimal
}
Types

StrategyPrivacy

Values
Enum Value Description

PRIVATE

PUBLIC

UNLISTED
Example
"PRIVATE"
Types

StrategyType

Values
Enum Value Description

COMMUNITY

ECCUITY

FACTOR_INVESTING

PASSIVE

PRO
Example
"COMMUNITY"
Types

StrategyWithTotal

Fields
Field Name Description
strategies - [Strategy!]!
total - Int!
Example
{"strategies": [Strategy], "total": 123}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

SubscriptionList

Fields
Field Name Description
subscriptions - [SubscriptionPlan!]!
Example
{"subscriptions": [SubscriptionPlan]}
Types

SubscriptionPlan

Fields
Field Name Description
archived - Boolean!
currency - String!
description - String!
featureFlags - [String!]!
features - [String!]!
image - String
interval - String!
intervalCount - Int!
name - String!
priceAmount - Decimal!
priceId - String!
productId - String!
subtitle - String
Example
{
  "archived": false,
  "currency": "xyz789",
  "description": "xyz789",
  "featureFlags": ["xyz789"],
  "features": ["abc123"],
  "image": "abc123",
  "interval": "xyz789",
  "intervalCount": 123,
  "name": "abc123",
  "priceAmount": Decimal,
  "priceId": "abc123",
  "productId": "xyz789",
  "subtitle": "xyz789"
}
Types

ThreeMonthCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": 4,
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

ThreeYearCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": 4,
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

ToggleLikeInput

Fields
Input Field Description
idForRecipient - String!
recipientType - String!
Example
{
  "idForRecipient": "abc123",
  "recipientType": "abc123"
}
Types

Trade

Fields
Field Name Description
brokerage - Decimal
comment - String
market - String
price - Decimal
quantity - Decimal
symbol - String
thirdPartyId - String
tradeCode - String!
tradeDate - GemDate!
type - String
value - Decimal
Example
{
  "brokerage": Decimal,
  "comment": "xyz789",
  "market": "xyz789",
  "price": Decimal,
  "quantity": Decimal,
  "symbol": "xyz789",
  "thirdPartyId": "xyz789",
  "tradeCode": "abc123",
  "tradeDate": GemDate,
  "type": "xyz789",
  "value": Decimal
}
Types

TradeDataBuyInput

Fields
Input Field Description
brokerage - Decimal!
quantity - Decimal!
unitPrice - Decimal!
Example
{
  "brokerage": Decimal,
  "quantity": Decimal,
  "unitPrice": Decimal
}
Types

TradeDataConsolidationInput

Fields
Input Field Description
denominator - Decimal!
numerator - Decimal!
shares - Decimal!
Example
{
  "denominator": Decimal,
  "numerator": Decimal,
  "shares": Decimal
}
Types

TradeDataInput

Fields
Input Field Description
buy - TradeDataBuyInput
consolidation - TradeDataConsolidationInput
deposit - TradeDataValueInput
fee - TradeDataValueInput
interest - TradeDataValueInput
openingBalance - TradeDataValueInput
sell - TradeDataSellInput
split - TradeDataSplitInput
withdraw - TradeDataValueInput
Example
{
  "buy": TradeDataBuyInput,
  "consolidation": TradeDataConsolidationInput,
  "deposit": TradeDataValueInput,
  "fee": TradeDataValueInput,
  "interest": TradeDataValueInput,
  "openingBalance": TradeDataValueInput,
  "sell": TradeDataSellInput,
  "split": TradeDataSplitInput,
  "withdraw": TradeDataValueInput
}
Types

TradeDataSellInput

Fields
Input Field Description
brokerage - Decimal!
quantity - Decimal!
unitPrice - Decimal!
Example
{
  "brokerage": Decimal,
  "quantity": Decimal,
  "unitPrice": Decimal
}
Types

TradeDataSplitInput

Fields
Input Field Description
denominator - Decimal!
numerator - Decimal!
shares - Decimal!
Example
{
  "denominator": Decimal,
  "numerator": Decimal,
  "shares": Decimal
}
Types

TradeDataValueInput

Fields
Input Field Description
value - Decimal!
Example
{"value": Decimal}
Types

TradeEmail

Fields
Field Name Description
code - String!
from - String!
html - String
importStatus - EmailImportStatus!
receivedAt - String!
subject - String!
text - String
Example
{
  "code": "xyz789",
  "from": "xyz789",
  "html": "xyz789",
  "importStatus": "FAILED",
  "receivedAt": "abc123",
  "subject": "xyz789",
  "text": "abc123"
}
Types

TradeIdea

Fields
Field Name Description
actualCloseDate - DateTimeISO
actualOpenDate - DateTimeISO
content - String!
convictionLevel - String!
createdAt - DateTimeISO!
daysToClose - Int
daysToOpen - Int
description - String!
direction - String!
displayOrder - Int!
estimatedCloseDate - DateTimeISO
estimatedOpenDate - DateTimeISO
hasOpenTrades - Boolean!
id - String!
isProfitable - Boolean
returnPercentage - Decimal
title - String!
totalProfitLoss - Decimal
tradesClosed - Boolean!
updatedAt - DateTimeISO!
Example
{
  "actualCloseDate": "2007-12-03T10:15:30Z",
  "actualOpenDate": "2007-12-03T10:15:30Z",
  "content": "abc123",
  "convictionLevel": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "daysToClose": 987,
  "daysToOpen": 987,
  "description": "xyz789",
  "direction": "abc123",
  "displayOrder": 123,
  "estimatedCloseDate": "2007-12-03T10:15:30Z",
  "estimatedOpenDate": "2007-12-03T10:15:30Z",
  "hasOpenTrades": false,
  "id": "abc123",
  "isProfitable": false,
  "returnPercentage": Decimal,
  "title": "abc123",
  "totalProfitLoss": Decimal,
  "tradesClosed": false,
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

TravelRuleInfoInput

Fields
Input Field Description
beneficiaryFamilyName - String!
beneficiaryGivenName - String!
isSelfHosted - Boolean!
manualVaspName - String
manualVaspWebsite - String
originatorBuildingNumber - String
originatorCountry - String
originatorPostCode - String
originatorStreetName - String
originatorTownName - String
vaspId - String
Example
{
  "beneficiaryFamilyName": "abc123",
  "beneficiaryGivenName": "abc123",
  "isSelfHosted": true,
  "manualVaspName": "xyz789",
  "manualVaspWebsite": "abc123",
  "originatorBuildingNumber": "xyz789",
  "originatorCountry": "xyz789",
  "originatorPostCode": "xyz789",
  "originatorStreetName": "abc123",
  "originatorTownName": "xyz789",
  "vaspId": "xyz789"
}
Types

TravelRuleNextAction

Fields
Field Name Description
description - String!
name - String!
requiredFields - [TravelRuleRequiredField!]!
type - String!
Example
{
  "description": "xyz789",
  "name": "abc123",
  "requiredFields": [TravelRuleRequiredField],
  "type": "abc123"
}
Types

TravelRuleRequiredField

Fields
Field Name Description
description - String!
field - String!
valueType - String!
Example
{
  "description": "abc123",
  "field": "xyz789",
  "valueType": "abc123"
}
Types

TravelRuleResult

Fields
Field Name Description
message - String
nextActions - [TravelRuleNextAction!]
success - Boolean!
travelRuleActionRequired - Boolean!
Example
{
  "message": "xyz789",
  "nextActions": [TravelRuleNextAction],
  "success": false,
  "travelRuleActionRequired": true
}
Types

TwoYearCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": "4",
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Types

USDBankingDetails

Fields
Field Name Description
accountName - String!
accountNumber - String!
alpacaAddress - String!
bankAddress - String!
bankName - String!
correspondenceCode - String!
routingNumber - String!
swiftCode - String!
userAccountNumber - String!
wireFee - String!
Example
{
  "accountName": "abc123",
  "accountNumber": "xyz789",
  "alpacaAddress": "abc123",
  "bankAddress": "xyz789",
  "bankName": "xyz789",
  "correspondenceCode": "xyz789",
  "routingNumber": "abc123",
  "swiftCode": "xyz789",
  "userAccountNumber": "abc123",
  "wireFee": "xyz789"
}
Types

UnregisterDeviceTokenInput

Fields
Input Field Description
token - String!
Example
{"token": "abc123"}
Types

UpdateActiveStrategyInput

Fields
Input Field Description
assets - [ActiveStrategyAssetInput!]
id - ID!
isRebalanceOn - Boolean
isScheduledContributionOn - Boolean
name - String
rebalanceFrequency - RebalanceFrequency
scheduledContributionAmount - Decimal
scheduledContributionFrequency - ScheduledContributionFrequency
scheduledContributionPortionType - InvestmentPortionType
sourceStrategyId - String
subscribedStrategyHistoryId - String
Example
{
  "assets": [ActiveStrategyAssetInput],
  "id": "4",
  "isRebalanceOn": false,
  "isScheduledContributionOn": false,
  "name": "xyz789",
  "rebalanceFrequency": "ANNUALLY",
  "scheduledContributionAmount": Decimal,
  "scheduledContributionFrequency": "FORTNIGHT_START",
  "scheduledContributionPortionType": "AMOUNT",
  "sourceStrategyId": "xyz789",
  "subscribedStrategyHistoryId": "abc123"
}
Types

UpdateAssistantThreadInput

Fields
Input Field Description
idForThread - String!
name - String!
privacy - AssistantThreadPrivacy!
Example
{
  "idForThread": "abc123",
  "name": "abc123",
  "privacy": "PRIVATE"
}
Types

UpdateCustomInstrumentInput

Fields
Input Field Description
currency - String
excludeFromCalculations - Boolean
instrumentType - String
logoUrl - String
name - String
symbol - String!
unit - String
Example
{
  "currency": "abc123",
  "excludeFromCalculations": false,
  "instrumentType": "xyz789",
  "logoUrl": "abc123",
  "name": "xyz789",
  "symbol": "abc123",
  "unit": "xyz789"
}
Types

UpdateInstrumentPriceInput

Fields
Input Field Description
dateTime - String!
market - String!
price - WealthrelayInstrumentPriceInput!
symbol - String!
Example
{
  "dateTime": "abc123",
  "market": "abc123",
  "price": WealthrelayInstrumentPriceInput,
  "symbol": "abc123"
}
Types

UpdateMfaInput

Fields
Input Field Description
confirmMfaCode - String
mfaEnabled - Boolean!
Example
{
  "confirmMfaCode": "abc123",
  "mfaEnabled": false
}
Types

UpdateMfaQrCodeInput

Fields
Input Field Description
confirmMfaCode - String
mfaEnabled - Boolean!
Example
{
  "confirmMfaCode": "abc123",
  "mfaEnabled": false
}
Types

UpdateNetWorthExpenseInput

Fields
Input Field Description
category - String
description - String
monthlyAmount - String
Example
{
  "category": "abc123",
  "description": "abc123",
  "monthlyAmount": "abc123"
}
Types

UpdateNetWorthGoalInput

Fields
Input Field Description
attachedAssetIds - [String!]
attachedLiabilityIds - [String!]
currentAmount - String
description - String
isFinancial - Boolean
name - String
priority - String
targetAmount - String
targetDate - String
Example
{
  "attachedAssetIds": ["abc123"],
  "attachedLiabilityIds": ["xyz789"],
  "currentAmount": "xyz789",
  "description": "abc123",
  "isFinancial": false,
  "name": "xyz789",
  "priority": "xyz789",
  "targetAmount": "xyz789",
  "targetDate": "abc123"
}
Types

UpdateNetWorthIncomeInput

Fields
Input Field Description
annualAmount - String
description - String
isAfterTax - Boolean
source - String
Example
{
  "annualAmount": "xyz789",
  "description": "xyz789",
  "isAfterTax": false,
  "source": "xyz789"
}
Types

UpdateNetWorthLiabilityInput

Fields
Input Field Description
currentBalance - String
description - String
interestRate - String
monthlyPayment - String
originalAmount - String
remainingTerm - String
type - String
Example
{
  "currentBalance": "xyz789",
  "description": "xyz789",
  "interestRate": "xyz789",
  "monthlyPayment": "abc123",
  "originalAmount": "xyz789",
  "remainingTerm": "xyz789",
  "type": "xyz789"
}
Types

UpdateStrategyInput

Fields
Input Field Description
assets - [StrategyAssetWeightInput!]
category - StrategyCategory
description - String
id - ID!
imageURL - String
isVotingEnabled - Boolean!
logoURL - String
name - String!
privacy - StrategyPrivacy!
type - StrategyType!
videoLink - String
Example
{
  "assets": [StrategyAssetWeightInput],
  "category": "ACTIVIST",
  "description": "xyz789",
  "id": 4,
  "imageURL": "abc123",
  "isVotingEnabled": true,
  "logoURL": "abc123",
  "name": "abc123",
  "privacy": "PRIVATE",
  "type": "COMMUNITY",
  "videoLink": "xyz789"
}
Types

UpdateUserAccountInput

Fields
Input Field Description
email - String
password - String
phoneNumber - String
Example
{
  "email": "abc123",
  "password": "xyz789",
  "phoneNumber": "xyz789"
}
Types

UpdateUserKYCUploadedFileDocumentInput

Fields
Input Field Description
content - String!
documentSubType - UserKYCDocumentSubType!
documentType - UserKYCDocumentType!
id - ID!
mimeType - String!
Example
{
  "content": "abc123",
  "documentSubType": "ACCOUNT_APPLICATION",
  "documentType": "ACCOUNT_APPROVAL",
  "id": 4,
  "mimeType": "xyz789"
}
Types

UpdateUserKYCUploadedW8BENFormDocumentInput

Fields
Input Field Description
contentData - UpdateUserKYCW8BENFormContentDataInput!
id - ID!
Example
{
  "contentData": UpdateUserKYCW8BENFormContentDataInput,
  "id": 4
}
Types

UpdateUserKYCW8BENFormContentDataInput

Fields
Input Field Description
mailingAddressCityState - String
mailingAddressCountry - String
mailingAddressStreet - String
paragraphNumber - String
percentRateWithholding - Decimal
permanentAddressCityState - String!
permanentAddressCountry - String!
permanentAddressStreet - String!
signerFullName - String!
Example
{
  "mailingAddressCityState": "abc123",
  "mailingAddressCountry": "xyz789",
  "mailingAddressStreet": "xyz789",
  "paragraphNumber": "abc123",
  "percentRateWithholding": Decimal,
  "permanentAddressCityState": "xyz789",
  "permanentAddressCountry": "xyz789",
  "permanentAddressStreet": "xyz789",
  "signerFullName": "abc123"
}
Types

UpdateUserKycAgreementInput

Fields
Input Field Description
agreement - UserKYCAgreementType!
revision - String
signedAt - String!
Example
{
  "agreement": "ACCOUNT",
  "revision": "abc123",
  "signedAt": "xyz789"
}
Types

UpdateUserKycCompanySetupInput

Fields
Input Field Description
name - String!
phoneNumber - String!
Example
{
  "name": "xyz789",
  "phoneNumber": "xyz789"
}
Types

UpdateUserKycContactInformationInput

Fields
Input Field Description
city - String!
emailAddress - String!
phoneNumber - String!
postalCode - String
state - String
streetAddress - [String!]!
unit - String
Example
{
  "city": "abc123",
  "emailAddress": "xyz789",
  "phoneNumber": "abc123",
  "postalCode": "xyz789",
  "state": "abc123",
  "streetAddress": ["xyz789"],
  "unit": "abc123"
}
Types

UpdateUserKycDisclosuresInput

Fields
Input Field Description
contexts - [UserKycDisclosureContextInput]!
employerAddress - String!
employerName - String!
employmentPosition - String!
employmentStatus - UserKYCEmploymentStatus!
immediateFamilyExposed - Boolean!
isAffiliatedExchangeOrFinra - Boolean!
isControlPerson - Boolean!
isPoliticallyExposed - Boolean!
Example
{
  "contexts": [UserKycDisclosureContextInput],
  "employerAddress": "xyz789",
  "employerName": "xyz789",
  "employmentPosition": "abc123",
  "employmentStatus": "EMPLOYED",
  "immediateFamilyExposed": true,
  "isAffiliatedExchangeOrFinra": false,
  "isControlPerson": false,
  "isPoliticallyExposed": false
}
Types

UpdateUserKycIdentityInformationInput

Fields
Input Field Description
annualIncomeMax - String
annualIncomeMin - String
countryOfBirth - String!
countryOfCitizenship - String!
countryOfTaxResidence - String!
dateOfBirth - String!
dateOfDepartureFromUsa - String
familyName - String!
fundingSource - [UserKYCFundingSource!]!
givenName - String!
liquidNetWorthMax - String
liquidNetWorthMin - String
middleName - String
permanentResident - Boolean
taxId - String!
taxIdType - UserKYCTaxIdType!
totalNetWorthMax - String
totalNetWorthMin - String
visaExpirationDate - String
visaType - UserKYCVisaType
Example
{
  "annualIncomeMax": "xyz789",
  "annualIncomeMin": "xyz789",
  "countryOfBirth": "xyz789",
  "countryOfCitizenship": "xyz789",
  "countryOfTaxResidence": "abc123",
  "dateOfBirth": "abc123",
  "dateOfDepartureFromUsa": "xyz789",
  "familyName": "abc123",
  "fundingSource": ["BUSINESS"],
  "givenName": "xyz789",
  "liquidNetWorthMax": "abc123",
  "liquidNetWorthMin": "xyz789",
  "middleName": "abc123",
  "permanentResident": true,
  "taxId": "xyz789",
  "taxIdType": "ARG_AR_CUIT",
  "totalNetWorthMax": "abc123",
  "totalNetWorthMin": "abc123",
  "visaExpirationDate": "abc123",
  "visaType": "B1"
}
Types

UpdateUserKycTrustedContactInput

Fields
Input Field Description
city - String
country - String
emailAddress - String
familyName - String!
givenName - String!
phoneNumber - String
postalCode - String
state - String
streetAddress - [String]!
Example
{
  "city": "xyz789",
  "country": "xyz789",
  "emailAddress": "xyz789",
  "familyName": "xyz789",
  "givenName": "xyz789",
  "phoneNumber": "xyz789",
  "postalCode": "xyz789",
  "state": "abc123",
  "streetAddress": ["xyz789"]
}
Types

UpdateUserProfileInput

Fields
Input Field Description
name - String
username - String
Example
{
  "name": "xyz789",
  "username": "xyz789"
}
Types

UpdateWhitelistedWalletTravelRuleInput

Fields
Input Field Description
tradingMode - String!
travelRuleInfo - TravelRuleInfoInput!
whitelistedWalletId - String!
Example
{
  "tradingMode": "abc123",
  "travelRuleInfo": TravelRuleInfoInput,
  "whitelistedWalletId": "xyz789"
}
Types

User

Fields
Field Name Description
antiPhishingCode - String
chartStartAtZero - Boolean!
country - String!
createdAt - GemDate!
cryptoSpreadFee - Decimal
depositWithdrawalFee - Decimal
eccuityInvestStatus - AccountStatus
email - String!
featureFlags - [FeatureFlagNames!]
firstName - String
freeTradeCredit - Decimal
id - ID!
interestRate - Decimal
interestRateStatus - String
lastName - String
maxActiveStrategies - Int
maxMonthlyAIMessages - Int
maxMonthlyAIThreads - Int
maxMonthlyStrategyCreation - Int
maxMonthlyStrategyViews - Int
maxStrategySubscriptions - Int
maxTradingFees - Decimal
mfaEnabled - Boolean!
mfaQrCodeEnabled - Boolean!
name - String!
netWorthAsHomePage - Boolean!
oAuthLinks - [OAuthLink!]!
phoneNumber - String
strategySubscriptions - [String!]!
tradingFees - Decimal
usedActiveStrategies - Int
usedMonthlyAIMessages - Int
usedMonthlyAIThreads - Int
usedMonthlyStrategyCreation - Int
usedMonthlyStrategyViews - Int
usedStrategySubscriptions - Int
username - String!
Example
{
  "antiPhishingCode": "abc123",
  "chartStartAtZero": true,
  "country": "abc123",
  "createdAt": GemDate,
  "cryptoSpreadFee": Decimal,
  "depositWithdrawalFee": Decimal,
  "eccuityInvestStatus": "ACCOUNT_CLOSED",
  "email": "xyz789",
  "featureFlags": ["ADMIN"],
  "firstName": "abc123",
  "freeTradeCredit": Decimal,
  "id": "4",
  "interestRate": Decimal,
  "interestRateStatus": "abc123",
  "lastName": "xyz789",
  "maxActiveStrategies": 987,
  "maxMonthlyAIMessages": 123,
  "maxMonthlyAIThreads": 123,
  "maxMonthlyStrategyCreation": 987,
  "maxMonthlyStrategyViews": 123,
  "maxStrategySubscriptions": 987,
  "maxTradingFees": Decimal,
  "mfaEnabled": true,
  "mfaQrCodeEnabled": false,
  "name": "abc123",
  "netWorthAsHomePage": false,
  "oAuthLinks": [OAuthLink],
  "phoneNumber": "abc123",
  "strategySubscriptions": ["xyz789"],
  "tradingFees": Decimal,
  "usedActiveStrategies": 123,
  "usedMonthlyAIMessages": 987,
  "usedMonthlyAIThreads": 987,
  "usedMonthlyStrategyCreation": 123,
  "usedMonthlyStrategyViews": 987,
  "usedStrategySubscriptions": 987,
  "username": "abc123"
}
Types

UserKYCAgreement

Fields
Field Name Description
agreement - UserKYCAgreementType!
createdAt - GemDate!
id - ID!
ipAddress - String!
revision - String
signedAt - String!
user - User!
Example
{
  "agreement": "ACCOUNT",
  "createdAt": GemDate,
  "id": 4,
  "ipAddress": "xyz789",
  "revision": "xyz789",
  "signedAt": "xyz789",
  "user": User
}
Types

UserKYCAgreementType

Values
Enum Value Description

ACCOUNT

CRYPTO

CUSTOMER

MARGIN
Example
"ACCOUNT"
Types

UserKYCContactInformation

Fields
Field Name Description
city - String!
createdAt - GemDate!
emailAddress - String!
id - ID!
phoneNumber - String!
postalCode - String
state - String
streetAddress - [String!]!
unit - String
user - User!
Example
{
  "city": "xyz789",
  "createdAt": GemDate,
  "emailAddress": "xyz789",
  "id": 4,
  "phoneNumber": "abc123",
  "postalCode": "abc123",
  "state": "abc123",
  "streetAddress": ["abc123"],
  "unit": "abc123",
  "user": User
}
Types

UserKYCDisclosureContextType

Values
Enum Value Description

AFFILIATE_FIRM

CONTROLLED_FIRM

IMMEDIATE_FAMILY_EXPOSED
Example
"AFFILIATE_FIRM"
Types

UserKYCDisclosures

Fields
Field Name Description
contexts - [IUserKYCDisclosureContext!]!
createdAt - GemDate!
employerAddress - String!
employerName - String!
employmentPosition - String!
employmentStatus - UserKYCEmploymentStatus!
id - ID!
immediateFamilyExposed - Boolean!
isAffiliatedExchangeOrFinra - Boolean!
isControlPerson - Boolean!
isPoliticallyExposed - Boolean!
user - User!
Example
{
  "contexts": [IUserKYCDisclosureContext],
  "createdAt": GemDate,
  "employerAddress": "abc123",
  "employerName": "xyz789",
  "employmentPosition": "abc123",
  "employmentStatus": "EMPLOYED",
  "id": 4,
  "immediateFamilyExposed": true,
  "isAffiliatedExchangeOrFinra": true,
  "isControlPerson": false,
  "isPoliticallyExposed": false,
  "user": User
}
Types

UserKYCDocumentSubType

Values
Enum Value Description

ACCOUNT_APPLICATION

DRIVERS_LICENSE

DRIVERS_LICENSE_BACK

DRIVERS_LICENSE_FRONT

PASSPORT

W8BEN
Example
"ACCOUNT_APPLICATION"
Types

UserKYCDocumentType

Values
Enum Value Description

ACCOUNT_APPROVAL

ADDRESS

CIP

DATEOFBIRTH

IDENTITY

TAX

W8BEN
Example
"ACCOUNT_APPROVAL"
Types

UserKYCEmploymentStatus

Values
Enum Value Description

EMPLOYED

RETIRED

STUDENT

UNEMPLOYED
Example
"EMPLOYED"
Types

UserKYCFundingSource

Values
Enum Value Description

BUSINESS

EMPLOYMENT

FAMILY

INHERITANCE

INVESTMENTS

SAVINGS

SELF_EMPLOYMENT
Example
"BUSINESS"
Types

UserKYCIdentityInformation

Fields
Field Name Description
annualIncomeMax - String
annualIncomeMin - String
countryOfBirth - String!
countryOfCitizenship - String!
countryOfTaxResidence - String!
createdAt - GemDate!
dateOfBirth - String!
dateOfDepartureFromUsa - String
familyName - String!
fundingSource - [UserKYCFundingSource!]!
givenName - String!
id - ID!
liquidNetWorthMax - String
liquidNetWorthMin - String
middleName - String
permanentResident - Boolean
taxId - String
taxIdType - UserKYCTaxIdType
totalNetWorthMax - String
totalNetWorthMin - String
user - User!
visaExpirationDate - String
visaType - UserKYCVisaType
Example
{
  "annualIncomeMax": "abc123",
  "annualIncomeMin": "xyz789",
  "countryOfBirth": "xyz789",
  "countryOfCitizenship": "abc123",
  "countryOfTaxResidence": "abc123",
  "createdAt": GemDate,
  "dateOfBirth": "abc123",
  "dateOfDepartureFromUsa": "abc123",
  "familyName": "xyz789",
  "fundingSource": ["BUSINESS"],
  "givenName": "xyz789",
  "id": "4",
  "liquidNetWorthMax": "xyz789",
  "liquidNetWorthMin": "xyz789",
  "middleName": "abc123",
  "permanentResident": false,
  "taxId": "abc123",
  "taxIdType": "ARG_AR_CUIT",
  "totalNetWorthMax": "abc123",
  "totalNetWorthMin": "abc123",
  "user": User,
  "visaExpirationDate": "xyz789",
  "visaType": "B1"
}
Types

UserKYCRequirements

Fields
Field Name Description
ADDRESS_VERIFICATION - Boolean!
AFFILIATED - Boolean!
CONTROL_PERSON - Boolean!
COUNTRY_NOT_SUPPORTED - Boolean!
DATE_OF_BIRTH - Boolean!
FAMILY_MEMBER_PEP - Boolean!
IDENTITY_VERIFICATION - Boolean!
INVALID_IDENTITY_PASSPORT - Boolean!
OTHER - Boolean!
OTHER_PARTNER - Boolean!
PEP - Boolean!
SELFIE_VERIFICATION - Boolean!
TAX_IDENTIFICATION - Boolean!
VISA_TYPE_OTHER - Boolean!
W8BEN_CORRECTION - Boolean!
WATCHLIST_HIT - Boolean!
createdAt - GemDate!
id - ID!
requirementOtherText - String
user - User!
Example
{
  "ADDRESS_VERIFICATION": false,
  "AFFILIATED": true,
  "CONTROL_PERSON": true,
  "COUNTRY_NOT_SUPPORTED": false,
  "DATE_OF_BIRTH": false,
  "FAMILY_MEMBER_PEP": true,
  "IDENTITY_VERIFICATION": true,
  "INVALID_IDENTITY_PASSPORT": true,
  "OTHER": false,
  "OTHER_PARTNER": false,
  "PEP": true,
  "SELFIE_VERIFICATION": false,
  "TAX_IDENTIFICATION": false,
  "VISA_TYPE_OTHER": true,
  "W8BEN_CORRECTION": true,
  "WATCHLIST_HIT": false,
  "createdAt": GemDate,
  "id": "4",
  "requirementOtherText": "abc123",
  "user": User
}
Types

UserKYCTaxIdType

Values
Enum Value Description

ARG_AR_CUIT

AUS_ABN

AUS_TFN

BOL_NIT

BRA_CPF

CHL_RUT

COL_NIT

CRI_NITE

DEU_TAX_ID

DOM_RNC

ECU_RUC

FRA_SPI

GBR_NINO

GBR_UTR

GTM_NIT

HND_RTN

HUN_TIN

IDN_KTP

ISR_TAX_ID

ITA_TAX_ID

JPN_TAX_ID

MEX_RFC

NIC_RUC

NLD_TIN

NOT_SPECIFIED

PAN_RUC

PER_RUC

PRY_RUC

SGP_ASGD

SGP_FIN

SGP_ITR

SGP_NRIC

SLV_NIT

SWE_TAX_ID

URY_RUT

USA_SSN

VEN_RIF
Example
"ARG_AR_CUIT"
Types

UserKYCTrustedContact

Fields
Field Name Description
city - String
country - String
createdAt - GemDate!
emailAddress - String
familyName - String!
givenName - String!
id - ID!
phoneNumber - String
postalCode - String
state - String
streetAddress - [String]!
user - User!
Example
{
  "city": "xyz789",
  "country": "abc123",
  "createdAt": GemDate,
  "emailAddress": "xyz789",
  "familyName": "abc123",
  "givenName": "xyz789",
  "id": "4",
  "phoneNumber": "abc123",
  "postalCode": "abc123",
  "state": "xyz789",
  "streetAddress": ["abc123"],
  "user": User
}
Types

UserKYCUploadedDocument

Types
Union Types

UserKYCUploadedFileDocument

UserKYCUploadedW8BENFormDocument
Example
UserKYCUploadedFileDocument
Types

UserKYCUploadedFileDocument

Fields
Field Name Description
alpacaId - ID
alpacaURL - ID
content - String!
createdAt - GemDate!
documentSubType - UserKYCDocumentSubType!
documentType - UserKYCDocumentType!
id - ID!
mimeType - String!
user - User!
Example
{
  "alpacaId": "4",
  "alpacaURL": 4,
  "content": "abc123",
  "createdAt": GemDate,
  "documentSubType": "ACCOUNT_APPLICATION",
  "documentType": "ACCOUNT_APPROVAL",
  "id": 4,
  "mimeType": "abc123",
  "user": User
}
Types

UserKYCUploadedW8BENFormDocument

Fields
Field Name Description
alpacaId - ID
alpacaURL - ID
contentData - IUserKYCW8BENForm!
createdAt - GemDate!
documentSubType - UserKYCDocumentSubType!
documentType - UserKYCDocumentType!
id - ID!
user - User!
Example
{
  "alpacaId": "4",
  "alpacaURL": 4,
  "contentData": IUserKYCW8BENForm,
  "createdAt": GemDate,
  "documentSubType": "ACCOUNT_APPLICATION",
  "documentType": "ACCOUNT_APPROVAL",
  "id": 4,
  "user": User
}
Types

UserKYCVisaType

Values
Enum Value Description

B1

B2

DACA

E1

E2

E3

F1

G4

H1B

J1

L1

O1

OTHER

TN1
Example
"B1"
Types

UserKycDisclosureContextInput

Fields
Input Field Description
companyCity - String
companyComplianceEmail - String
companyCountry - String
companyName - String
companyState - String
companyStreetAddress - String
contextType - UserKYCDisclosureContextType!
familyName - String
givenName - String
Example
{
  "companyCity": "abc123",
  "companyComplianceEmail": "xyz789",
  "companyCountry": "abc123",
  "companyName": "xyz789",
  "companyState": "abc123",
  "companyStreetAddress": "abc123",
  "contextType": "AFFILIATE_FIRM",
  "familyName": "xyz789",
  "givenName": "abc123"
}
Types

UserSubscription

Fields
Field Name Description
active - Boolean!
archived - Boolean!
cancelAtPeriodEnd - Boolean!
currency - String!
description - String!
featureFlags - [String!]!
features - [String!]!
image - String
interval - String!
intervalCount - Int!
lineItemId - String!
name - String!
priceAmount - Decimal!
priceId - String!
productId - String!
status - String!
subscriptionEnd - String!
subscriptionId - String!
subscriptionStart - String!
subtitle - String
Example
{
  "active": false,
  "archived": true,
  "cancelAtPeriodEnd": false,
  "currency": "abc123",
  "description": "abc123",
  "featureFlags": ["abc123"],
  "features": ["xyz789"],
  "image": "abc123",
  "interval": "xyz789",
  "intervalCount": 987,
  "lineItemId": "abc123",
  "name": "abc123",
  "priceAmount": Decimal,
  "priceId": "abc123",
  "productId": "xyz789",
  "status": "xyz789",
  "subscriptionEnd": "xyz789",
  "subscriptionId": "abc123",
  "subscriptionStart": "xyz789",
  "subtitle": "xyz789"
}
Types

UserSubscriptionList

Fields
Field Name Description
subscriptions - [UserSubscription!]!
Example
{"subscriptions": [UserSubscription]}
Types

UserWithdrawalRequest

Fields
Field Name Description
alpacaJournalId - String
alpacaOutgoingTransfer - AlpacaOutgoingTransfer
amount - Decimal!
createdAt - GemDate!
gembrokerAccount - GemBrokerAccount!
id - ID!
targetCurrency - Currency!
user - User!
userProvidedReference - String!
wiseIncomingTransfer - WiseIncomingTransfer
wiseOutgoingTransfer - WiseOutgoingTransfer
Example
{
  "alpacaJournalId": "xyz789",
  "alpacaOutgoingTransfer": AlpacaOutgoingTransfer,
  "amount": Decimal,
  "createdAt": GemDate,
  "gembrokerAccount": GemBrokerAccount,
  "id": 4,
  "targetCurrency": "AUD",
  "user": User,
  "userProvidedReference": "abc123",
  "wiseIncomingTransfer": WiseIncomingTransfer,
  "wiseOutgoingTransfer": WiseOutgoingTransfer
}
Types

VASP

Fields
Field Name Description
id - String!
name - String!
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

VerifyEmailInput

Fields
Input Field Description
code - String!
email - String!
Example
{
  "code": "abc123",
  "email": "abc123"
}
Types

WalletWatch

Fields
Field Name Description
address - String!
blockchain - String!
code - String!
lastSync - String!
Example
{
  "address": "abc123",
  "blockchain": "xyz789",
  "code": "abc123",
  "lastSync": "xyz789"
}
Types

WealthRelayTradeData

Fields
Field Name Description
brokerage - Decimal
code - String
comment - String
denominator - Decimal
numerator - Decimal
pending - Boolean
price - Decimal
quantity - Decimal
shares - Decimal
thirdPartyId - String
total - Decimal
type - String!
value - Decimal
Example
{
  "brokerage": Decimal,
  "code": "xyz789",
  "comment": "abc123",
  "denominator": Decimal,
  "numerator": Decimal,
  "pending": true,
  "price": Decimal,
  "quantity": Decimal,
  "shares": Decimal,
  "thirdPartyId": "xyz789",
  "total": Decimal,
  "type": "abc123",
  "value": Decimal
}
Types

WealthrelayInstrumentPrice

Fields
Field Name Description
close - Decimal!
currency - String!
date - String!
high - Decimal!
low - Decimal!
open - Decimal!
Example
{
  "close": Decimal,
  "currency": "abc123",
  "date": "abc123",
  "high": Decimal,
  "low": Decimal,
  "open": Decimal
}
Types

WealthrelayInstrumentPriceInput

Fields
Input Field Description
close - Decimal!
dateTime - String!
high - Decimal!
low - Decimal!
open - Decimal!
Example
{
  "close": Decimal,
  "dateTime": "xyz789",
  "high": Decimal,
  "low": Decimal,
  "open": Decimal
}
Types

WhitelistedWallet

Fields
Field Name Description
address - String!
alias - String
asset - String!
chain - String!
id - String!
status - String!
travelRuleInfo - WhitelistedWalletTravelRuleInfo
Example
{
  "address": "abc123",
  "alias": "abc123",
  "asset": "xyz789",
  "chain": "xyz789",
  "id": "abc123",
  "status": "xyz789",
  "travelRuleInfo": WhitelistedWalletTravelRuleInfo
}
Types

WhitelistedWalletTravelRuleInfo

Fields
Field Name Description
beneficiaryFamilyName - String
beneficiaryGivenName - String
isSelfHosted - Boolean!
manualVaspName - String
manualVaspWebsite - String
originatorBuildingNumber - String
originatorCountry - String
originatorPostCode - String
originatorStreetName - String
originatorTownName - String
vaspId - String
Example
{
  "beneficiaryFamilyName": "xyz789",
  "beneficiaryGivenName": "xyz789",
  "isSelfHosted": false,
  "manualVaspName": "xyz789",
  "manualVaspWebsite": "xyz789",
  "originatorBuildingNumber": "xyz789",
  "originatorCountry": "abc123",
  "originatorPostCode": "abc123",
  "originatorStreetName": "xyz789",
  "originatorTownName": "abc123",
  "vaspId": "xyz789"
}
Types

WiseBankAccountDetail

Fields
Field Name Description
active - Boolean!
currencyCode - Currency!
currencyName - String!
details - [WiseBankAccountDetailList!]!
id - Int
Example
{
  "active": false,
  "currencyCode": "AUD",
  "currencyName": "abc123",
  "details": [WiseBankAccountDetailList],
  "id": 987
}
Types

WiseBankAccountDetailList

Fields
Field Name Description
body - String!
subtitle - String
title - String!
Example
{
  "body": "abc123",
  "subtitle": "xyz789",
  "title": "xyz789"
}
Types

WiseIncomingTransfer

Fields
Field Name Description
alpacaOutgoingTransfer - AlpacaOutgoingTransfer
amount - Decimal!
createdAt - GemDate!
currency - Currency!
fees - Decimal!
id - ID!
internalReference - String!
wiseOutgoingTransfer - WiseOutgoingTransfer
wiseReferenceNumber - String!
Example
{
  "alpacaOutgoingTransfer": AlpacaOutgoingTransfer,
  "amount": Decimal,
  "createdAt": GemDate,
  "currency": "AUD",
  "fees": Decimal,
  "id": "4",
  "internalReference": "abc123",
  "wiseOutgoingTransfer": WiseOutgoingTransfer,
  "wiseReferenceNumber": "abc123"
}
Types

WiseOutgoingTransfer

Fields
Field Name Description
createdAt - GemDate!
estimatedDelivery - GemDate
exchangeRate - Decimal
fees - Decimal
gembotFee - Decimal
hasBeenDispatched - Boolean!
id - ID!
internalBatchId - String
sourceAmount - Decimal!
sourceCurrency - Currency!
targetAmount - Decimal
targetCurrency - Currency!
user - User!
userProvidedReference - String!
userWithdrawalRequest - UserWithdrawalRequest
wiseBatchId - String!
wiseIncomingTransfer - WiseIncomingTransfer
wiseRecipient - WiseRecipient
wiseTransferId - String
Example
{
  "createdAt": GemDate,
  "estimatedDelivery": GemDate,
  "exchangeRate": Decimal,
  "fees": Decimal,
  "gembotFee": Decimal,
  "hasBeenDispatched": true,
  "id": "4",
  "internalBatchId": "xyz789",
  "sourceAmount": Decimal,
  "sourceCurrency": "AUD",
  "targetAmount": Decimal,
  "targetCurrency": "AUD",
  "user": User,
  "userProvidedReference": "xyz789",
  "userWithdrawalRequest": UserWithdrawalRequest,
  "wiseBatchId": "xyz789",
  "wiseIncomingTransfer": WiseIncomingTransfer,
  "wiseRecipient": WiseRecipient,
  "wiseTransferId": "xyz789"
}
Types

WiseQuote

Fields
Field Name Description
fxFee - Decimal!
gembotFee - Decimal!
gembotFeeRate - Decimal!
marketsClosed - Boolean!
rate - Decimal!
sourceAmount - Decimal!
sourceCurrency - Currency!
targetAmount - Decimal!
targetCurrency - Currency!
Example
{
  "fxFee": Decimal,
  "gembotFee": Decimal,
  "gembotFeeRate": Decimal,
  "marketsClosed": false,
  "rate": Decimal,
  "sourceAmount": Decimal,
  "sourceCurrency": "AUD",
  "targetAmount": Decimal,
  "targetCurrency": "AUD"
}
Types

WiseQuoteInput

Fields
Input Field Description
isDeposit - Boolean
provider - PaymentProviderGQL
sourceAmount - Decimal!
sourceCurrency - Currency!
targetCurrency - Currency!
Example
{
  "isDeposit": false,
  "provider": "EBURY",
  "sourceAmount": Decimal,
  "sourceCurrency": "AUD",
  "targetCurrency": "AUD"
}
Types

WiseRecipient

Fields
Field Name Description
createdAt - GemDate!
currency - Currency!
id - ID!
user - User!
userProvidedName - String!
wiseRecipientId - String!
Example
{
  "createdAt": GemDate,
  "currency": "AUD",
  "id": "4",
  "user": User,
  "userProvidedName": "xyz789",
  "wiseRecipientId": "xyz789"
}
Types

YTDCandlestick

Fields
Field Name Description
close - Decimal!
createdAt - GemDate!
date - GemDate!
duration - CandlestickDuration!
high - Decimal!
id - ID!
low - Decimal!
open - Decimal!
recipient - BaseEntity!
volume - Long!
Example
{
  "close": Decimal,
  "createdAt": GemDate,
  "date": GemDate,
  "duration": "ONE_DAY",
  "high": Decimal,
  "id": "4",
  "low": Decimal,
  "open": Decimal,
  "recipient": BaseEntity,
  "volume": {}
}
Documentation by Anvil SpectaQL