SensaAI GraphQL API Reference

Welcome to the SensaAI GraphQL API reference! This reference includes the complete set of public GraphQL types, queries, mutations, and their parameters.

Contact

API Support

[email protected]

https://sensaai.com/contact

Terms of Service

https://sensaai.com/legal/terms

API Endpoints
# Endpoint:
https://sensaai.com/graphiql/

Queries

apiCreditsUsage

Response

Returns an Int

Arguments
Name Description
months - Int

Example

Query
query ApiCreditsUsage($months: Int) {
  apiCreditsUsage(months: $months)
}
Variables
{"months": 987}
Response
{"data": {"apiCreditsUsage": 987}}
Queries

benchmarks

Description

Retrieves a list of available benchmarks which can be utilized for performance comparison purposes.

Response

Returns [BenchmarkType]

Example

Query
query Benchmarks {
  benchmarks {
    id
    owner {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    name
    category {
      id
      name
      displayName
      description
      include
      portfolioSet {
        ...PortfolioTypeFragment
      }
    }
    description
    private
    featured
    createdAt
    rebalanceFrequency
    maxStocks
    maxStocksCriteria
    maxStocksCriteriaOrder
    maxSectorConcentration
    totalRating
    returnRating
    growthRating
    riskRating
    valuationRating
    technicalRating
    macroRating
    marketCap
    sectorIds
    industryIds
    copiedFrom {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    portfolioType
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    copies {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
  }
}
Response
{
  "data": {
    "benchmarks": [
      {
        "id": "4",
        "owner": UserType,
        "name": "xyz789",
        "category": PortfolioCategoryType,
        "description": "xyz789",
        "private": false,
        "featured": true,
        "createdAt": "2007-12-03T10:15:30Z",
        "rebalanceFrequency": 987,
        "maxStocks": 123,
        "maxStocksCriteria": "MARKET_CAP",
        "maxStocksCriteriaOrder": "DESCENDING",
        "maxSectorConcentration": Decimal,
        "totalRating": [Decimal],
        "returnRating": [Decimal],
        "growthRating": [Decimal],
        "riskRating": [Decimal],
        "valuationRating": [Decimal],
        "technicalRating": [Decimal],
        "macroRating": [Decimal],
        "marketCap": [Decimal],
        "sectorIds": [123],
        "industryIds": [123],
        "copiedFrom": PortfolioType,
        "portfolioType": "FEATURED",
        "subscriptionviewSet": [SubscriptionViewType],
        "copies": [PortfolioType]
      }
    ]
  }
}
Queries

errors

Response

Returns [String]

Example

Query
query Errors {
  errors
}
Response
{"data": {"errors": ["abc123"]}}
Queries

industries

Response

Returns [IndustryType]

Example

Query
query Industries {
  industries {
    id
    name
    sector {
      id
      name
      industrySet {
        ...IndustryTypeFragment
      }
      stockSet {
        ...StockTypeFragment
      }
      sectorRatings {
        ...SectorRatingNodeConnectionFragment
      }
    }
    stockSet {
      id
      ticker
      name
      sector {
        ...SectorTypeFragment
      }
      industry {
        ...IndustryTypeFragment
      }
      marketCap
      price
      includeSearch
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      stockRatings {
        ...WatchlistItemsNodeConnectionFragment
      }
      watchlistItems {
        ...WatchlistItemsTypeFragment
      }
      ratingalertSet {
        ...RatingAlertTypeFragment
      }
      stockPriceData
      stockRatingsData
      stockIncomeAnnualData
      stockBalanceAnnualData
      stockCashFlowAnnualData
      stockDerivedAnnualData
      stockIncomeQuarterlyData
      stockBalanceQuarterlyData
      stockCashFlowQuarterlyData
      stockDerivedQuarterlyData
      stockIncomeTtmData
      stockBalanceTtmData
      stockCashFlowTtmData
      stockDerivedTtmData
      stockDescription
    }
    industryRatings {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...IndustryRatingNodeEdgeFragment
      }
      totalCount
      edgeCount
    }
  }
}
Response
{
  "data": {
    "industries": [
      {
        "id": "4",
        "name": "xyz789",
        "sector": SectorType,
        "stockSet": [StockType],
        "industryRatings": IndustryRatingNodeConnection
      }
    ]
  }
}
Queries

industryRatings

Description

Retrieves average industry ratings.

Response

Returns an IndustryRatingNodeConnection

Arguments
Name Description
ranges - GenericScalar Defines range of industry ratings to be returned.
orderBy - [String] Defines what rating is used to rank industries in response.
search - [String] Limit to industries where name contain search string.
offset - Int
before - String
after - String
first - Int
last - Int
industry_Name - String
industry_Name_Icontains - String
date - Date

Example

Query
query IndustryRatings(
  $ranges: GenericScalar,
  $orderBy: [String],
  $search: [String],
  $offset: Int,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $industry_Name: String,
  $industry_Name_Icontains: String,
  $date: Date
) {
  industryRatings(
    ranges: $ranges,
    orderBy: $orderBy,
    search: $search,
    offset: $offset,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    industry_Name: $industry_Name,
    industry_Name_Icontains: $industry_Name_Icontains,
    date: $date
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node {
        ...IndustryRatingNodeFragment
      }
      cursor
    }
    totalCount
    edgeCount
  }
}
Variables
{
  "ranges": GenericScalar,
  "orderBy": ["abc123"],
  "search": ["xyz789"],
  "offset": 987,
  "before": "xyz789",
  "after": "xyz789",
  "first": 123,
  "last": 987,
  "industry_Name": "xyz789",
  "industry_Name_Icontains": "abc123",
  "date": "2007-12-03"
}
Response
{
  "data": {
    "industryRatings": {
      "pageInfo": PageInfo,
      "edges": [IndustryRatingNodeEdge],
      "totalCount": 123,
      "edgeCount": 123
    }
  }
}
Queries

invoice

Response

Returns a GenericScalar

Arguments
Name Description
invoiceId - String Retrieves a specific invoice object.

Example

Query
query Invoice($invoiceId: String) {
  invoice(invoiceId: $invoiceId)
}
Variables
{"invoiceId": "xyz789"}
Response
{"data": {"invoice": GenericScalar}}
Queries

invoices

Description

Retrieves a list of invoices for user.

Response

Returns a GenericScalar

Example

Query
query Invoices {
  invoices
}
Response
{"data": {"invoices": GenericScalar}}
Queries

latestUnpaidInvoice

Description

Retrieves the latest unpaid invoice for the user along with the client secret to allow payment via Stripe Elements.

Response

Returns an UnpaidInvoiceType

Example

Query
query LatestUnpaidInvoice {
  latestUnpaidInvoice {
    clientSecret
    product
    amount
    currency
    interval
  }
}
Response
{
  "data": {
    "latestUnpaidInvoice": {
      "clientSecret": "abc123",
      "product": "abc123",
      "amount": 987,
      "currency": "xyz789",
      "interval": "abc123"
    }
  }
}
Queries

paymentMethods

Description

Retrieves a list of your registered payment methods.

Response

Returns a GenericScalar

Example

Query
query PaymentMethods {
  paymentMethods
}
Response
{"data": {"paymentMethods": GenericScalar}}
Queries

portfolio

Response

Returns a PortfolioType

Arguments
Name Description
id - Int

Example

Query
query Portfolio($id: Int) {
  portfolio(id: $id) {
    id
    owner {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    name
    category {
      id
      name
      displayName
      description
      include
      portfolioSet {
        ...PortfolioTypeFragment
      }
    }
    description
    private
    featured
    createdAt
    rebalanceFrequency
    maxStocks
    maxStocksCriteria
    maxStocksCriteriaOrder
    maxSectorConcentration
    totalRating
    returnRating
    growthRating
    riskRating
    valuationRating
    technicalRating
    macroRating
    marketCap
    sectorIds
    industryIds
    copiedFrom {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    portfolioType
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    copies {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    nextRebalanceDate
    previousRebalanceDate
    benchmarkId
    ranges
    holdings {
      id
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      grossMarginsRating
      operatingMarginsRating
      ebitdaMarginsRating
      netProfitMarginsRating
      operationalEfficiencyRating
      returnOnAssetsRating
      returnOnCapitalRating
      returnOnEquityRating
      revenueGrowthRating
      earningsGrowthRating
      revenueGrowthConsistencyRating
      earningsGrowthConsistencyRating
      leverageRating
      liquidityRating
      interestCoverageRating
      cashFlowCoverageRating
      salesMultiplesRating
      ebitdaMultiplesRating
      earningsMultiplesRating
      bookValueMultiplesRating
      dividendYieldRating
      momentumRating
      trendRating
      volatilityRating
      volumeRating
      stock {
        ...StockTypeFragment
      }
      date
    }
    portfolioValues
    cagr
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "portfolio": {
      "id": 4,
      "owner": UserType,
      "name": "abc123",
      "category": PortfolioCategoryType,
      "description": "abc123",
      "private": false,
      "featured": false,
      "createdAt": "2007-12-03T10:15:30Z",
      "rebalanceFrequency": 123,
      "maxStocks": 123,
      "maxStocksCriteria": "MARKET_CAP",
      "maxStocksCriteriaOrder": "DESCENDING",
      "maxSectorConcentration": Decimal,
      "totalRating": [Decimal],
      "returnRating": [Decimal],
      "growthRating": [Decimal],
      "riskRating": [Decimal],
      "valuationRating": [Decimal],
      "technicalRating": [Decimal],
      "macroRating": [Decimal],
      "marketCap": [Decimal],
      "sectorIds": [987],
      "industryIds": [123],
      "copiedFrom": PortfolioType,
      "portfolioType": "FEATURED",
      "subscriptionviewSet": [SubscriptionViewType],
      "copies": [PortfolioType],
      "nextRebalanceDate": "abc123",
      "previousRebalanceDate": "abc123",
      "benchmarkId": "4",
      "ranges": GenericScalar,
      "holdings": [PortfolioHoldingsType],
      "portfolioValues": GenericScalar,
      "cagr": 987.65
    }
  }
}
Queries

portfolioCategories

Response

Returns [PortfolioCategoryType]

Example

Query
query PortfolioCategories {
  portfolioCategories {
    id
    name
    displayName
    description
    include
    portfolioSet {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
  }
}
Response
{
  "data": {
    "portfolioCategories": [
      {
        "id": 4,
        "name": "xyz789",
        "displayName": "abc123",
        "description": "abc123",
        "include": false,
        "portfolioSet": [PortfolioType]
      }
    ]
  }
}
Queries

portfolioCategory

Response

Returns a PortfolioCategoryType

Arguments
Name Description
name - String
id - Int

Example

Query
query PortfolioCategory(
  $name: String,
  $id: Int
) {
  portfolioCategory(
    name: $name,
    id: $id
  ) {
    id
    name
    displayName
    description
    include
    portfolioSet {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
  }
}
Variables
{"name": "xyz789", "id": 123}
Response
{
  "data": {
    "portfolioCategory": {
      "id": "4",
      "name": "xyz789",
      "displayName": "xyz789",
      "description": "abc123",
      "include": false,
      "portfolioSet": [PortfolioType]
    }
  }
}
Queries

portfolioHoldings

Description

Retrieves portfolio holdings for a portfolio.

Response

Returns a PortfolioHoldingsNodeConnection

Arguments
Name Description
id - Int id of the portfolio
orderBy - [String] Defines what rating is used to rank stocks in response. - in front denotes ranking in descending order (e.g. -total_rating returns stock with highest total_rating first).
search - [String] Limit holdings where ticker or name contain search string.
holdingsPeriod - String
ratingsPeriod - String
anonymised - Boolean
offset - Int
before - String
after - String
first - Int
last - Int
stock_Ticker - String
stock_Ticker_Icontains - String
stock_Name - String
stock_Name_Icontains - String

Example

Query
query PortfolioHoldings(
  $id: Int,
  $orderBy: [String],
  $search: [String],
  $holdingsPeriod: String,
  $ratingsPeriod: String,
  $anonymised: Boolean,
  $offset: Int,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $stock_Ticker: String,
  $stock_Ticker_Icontains: String,
  $stock_Name: String,
  $stock_Name_Icontains: String
) {
  portfolioHoldings(
    id: $id,
    orderBy: $orderBy,
    search: $search,
    holdingsPeriod: $holdingsPeriod,
    ratingsPeriod: $ratingsPeriod,
    anonymised: $anonymised,
    offset: $offset,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    stock_Ticker: $stock_Ticker,
    stock_Ticker_Icontains: $stock_Ticker_Icontains,
    stock_Name: $stock_Name,
    stock_Name_Icontains: $stock_Name_Icontains
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node {
        ...PortfolioHoldingsNodeFragment
      }
      cursor
    }
    totalCount
    edgeCount
    averageRatings
    sectorCount
    industryCount
  }
}
Variables
{
  "id": 987,
  "orderBy": ["xyz789"],
  "search": ["xyz789"],
  "holdingsPeriod": "xyz789",
  "ratingsPeriod": "abc123",
  "anonymised": false,
  "offset": 123,
  "before": "xyz789",
  "after": "abc123",
  "first": 987,
  "last": 987,
  "stock_Ticker": "xyz789",
  "stock_Ticker_Icontains": "xyz789",
  "stock_Name": "abc123",
  "stock_Name_Icontains": "abc123"
}
Response
{
  "data": {
    "portfolioHoldings": {
      "pageInfo": PageInfo,
      "edges": [PortfolioHoldingsNodeEdge],
      "totalCount": 987,
      "edgeCount": 987,
      "averageRatings": GenericScalar,
      "sectorCount": GenericScalar,
      "industryCount": GenericScalar
    }
  }
}
Queries

portfolioMetrics

Description

Retrieves performance metrics for a portfolio.

Response

Returns a GenericScalar

Arguments
Name Description
id - Int id of the portfolio
benchmark - String Benchmark for comparison.
period - String Defines period of returns in years from latest available date. By default metrics provided for longest possible period available.

Example

Query
query PortfolioMetrics(
  $id: Int,
  $benchmark: String,
  $period: String
) {
  portfolioMetrics(
    id: $id,
    benchmark: $benchmark,
    period: $period
  )
}
Variables
{
  "id": 123,
  "benchmark": "abc123",
  "period": "abc123"
}
Response
{"data": {"portfolioMetrics": GenericScalar}}
Queries

portfolioReturn

Response

Returns a GenericScalar

Arguments
Name Description
id - Int

Example

Query
query PortfolioReturn($id: Int) {
  portfolioReturn(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"portfolioReturn": GenericScalar}}
Queries

portfolioReturnChart

Description

Retrieves periodic portfolio performance for a portfolio.

Response

Returns a GenericScalar

Arguments
Name Description
id - Int id of the portfolio
chartType - String The type of portfolio performance. Possible values are: "cumulative_return", "yearly_returns", "histogram", "drawdown", "rolling_beta" (requires benchmark), "rolling_volatility", "rolling_sharpe", "monthly_heatmap", "boxplot".
benchmark - String Benchmark for comparison.

Example

Query
query PortfolioReturnChart(
  $id: Int,
  $chartType: String,
  $benchmark: String
) {
  portfolioReturnChart(
    id: $id,
    chartType: $chartType,
    benchmark: $benchmark
  )
}
Variables
{
  "id": 987,
  "chartType": "xyz789",
  "benchmark": "abc123"
}
Response
{"data": {"portfolioReturnChart": GenericScalar}}
Queries

portfolioTrades

Description

Retrieves trade instructions for a portfolio on latest rebalance date.

Response

Returns a GenericScalar

Arguments
Name Description
id - Int id of the portfolio
date - Date
value - Float
valuePrevious - Float
allowFractional - Boolean Whether to allow for fractional shares (typically by specifying exact amount to be invested if broker allows).

Example

Query
query PortfolioTrades(
  $id: Int,
  $date: Date,
  $value: Float,
  $valuePrevious: Float,
  $allowFractional: Boolean
) {
  portfolioTrades(
    id: $id,
    date: $date,
    value: $value,
    valuePrevious: $valuePrevious,
    allowFractional: $allowFractional
  )
}
Variables
{
  "id": 987,
  "date": "2007-12-03",
  "value": 123.45,
  "valuePrevious": 987.65,
  "allowFractional": true
}
Response
{"data": {"portfolioTrades": GenericScalar}}
Queries

portfoliosForUser

Response

Returns [PortfolioType]

Arguments
Name Description
id - Int id of the portfolio

Example

Query
query PortfoliosForUser($id: Int) {
  portfoliosForUser(id: $id) {
    id
    owner {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    name
    category {
      id
      name
      displayName
      description
      include
      portfolioSet {
        ...PortfolioTypeFragment
      }
    }
    description
    private
    featured
    createdAt
    rebalanceFrequency
    maxStocks
    maxStocksCriteria
    maxStocksCriteriaOrder
    maxSectorConcentration
    totalRating
    returnRating
    growthRating
    riskRating
    valuationRating
    technicalRating
    macroRating
    marketCap
    sectorIds
    industryIds
    copiedFrom {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    portfolioType
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    copies {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    nextRebalanceDate
    previousRebalanceDate
    benchmarkId
    ranges
    holdings {
      id
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      grossMarginsRating
      operatingMarginsRating
      ebitdaMarginsRating
      netProfitMarginsRating
      operationalEfficiencyRating
      returnOnAssetsRating
      returnOnCapitalRating
      returnOnEquityRating
      revenueGrowthRating
      earningsGrowthRating
      revenueGrowthConsistencyRating
      earningsGrowthConsistencyRating
      leverageRating
      liquidityRating
      interestCoverageRating
      cashFlowCoverageRating
      salesMultiplesRating
      ebitdaMultiplesRating
      earningsMultiplesRating
      bookValueMultiplesRating
      dividendYieldRating
      momentumRating
      trendRating
      volatilityRating
      volumeRating
      stock {
        ...StockTypeFragment
      }
      date
    }
    portfolioValues
    cagr
  }
}
Variables
{"id": 123}
Response
{
  "data": {
    "portfoliosForUser": [
      {
        "id": 4,
        "owner": UserType,
        "name": "abc123",
        "category": PortfolioCategoryType,
        "description": "abc123",
        "private": false,
        "featured": false,
        "createdAt": "2007-12-03T10:15:30Z",
        "rebalanceFrequency": 987,
        "maxStocks": 123,
        "maxStocksCriteria": "MARKET_CAP",
        "maxStocksCriteriaOrder": "DESCENDING",
        "maxSectorConcentration": Decimal,
        "totalRating": [Decimal],
        "returnRating": [Decimal],
        "growthRating": [Decimal],
        "riskRating": [Decimal],
        "valuationRating": [Decimal],
        "technicalRating": [Decimal],
        "macroRating": [Decimal],
        "marketCap": [Decimal],
        "sectorIds": [123],
        "industryIds": [987],
        "copiedFrom": PortfolioType,
        "portfolioType": "FEATURED",
        "subscriptionviewSet": [SubscriptionViewType],
        "copies": [PortfolioType],
        "nextRebalanceDate": "xyz789",
        "previousRebalanceDate": "xyz789",
        "benchmarkId": 4,
        "ranges": GenericScalar,
        "holdings": [PortfolioHoldingsType],
        "portfolioValues": GenericScalar,
        "cagr": 123.45
      }
    ]
  }
}
Queries

products

Description

Retrieves a list of available SensaAI products.

Response

Returns [ProductType]

Arguments
Name Description
type - String
id - ID

Example

Query
query Products(
  $type: String,
  $id: ID
) {
  products(
    type: $type,
    id: $id
  ) {
    id
    subscriptionLevel
    name
    description
    type
    stripeProductIdTest
    stripeProductId
    priceSet {
      id
      price
      currency
      interval
      stripePriceIdTest
      stripePriceId
      product {
        ...ProductTypeFragment
      }
      subscriptionSet {
        ...SubscriptionTypeFragment
      }
    }
    subscriptionSet {
      id
      user {
        ...UserTypeFragment
      }
      product {
        ...ProductTypeFragment
      }
      price {
        ...PriceTypeFragment
      }
      gateway
      createdAt
      validUntil
      status
      statusUpdatedAt
      stripeSubscriptionId
      subscriptionpaymentSet {
        ...SubscriptionPaymentTypeFragment
      }
    }
    subscriptionpaymentSet {
      id
      subscription {
        ...SubscriptionTypeFragment
      }
      product {
        ...ProductTypeFragment
      }
      amount
      gatewayFee
      currency
      date
      status
      stripeInvoiceId
      commission
    }
    prices {
      id
      price
      currency
      interval
      stripePriceIdTest
      stripePriceId
      product {
        ...ProductTypeFragment
      }
      subscriptionSet {
        ...SubscriptionTypeFragment
      }
    }
    features {
      id
      name
      title
      category
      valueBoolean
      valueNumerical
    }
  }
}
Variables
{
  "type": "abc123",
  "id": "4"
}
Response
{
  "data": {
    "products": [
      {
        "id": 4,
        "subscriptionLevel": 123,
        "name": "abc123",
        "description": "abc123",
        "type": "xyz789",
        "stripeProductIdTest": "abc123",
        "stripeProductId": "xyz789",
        "priceSet": [PriceType],
        "subscriptionSet": [SubscriptionType],
        "subscriptionpaymentSet": [
          SubscriptionPaymentType
        ],
        "prices": [PriceType],
        "features": [ProductFeaturesType]
      }
    ]
  }
}
Queries

profile

Description

Retrieves profile data for user which API key is provided in query header.

Response

Returns a UserType

Example

Query
query Profile {
  profile {
    id
    email
    phoneNumber
    firstName
    lastName
    registeredAt
    stripeCustomerId
    referralId
    hasReferrals
    subscriptionData {
      stripeSubscriptionId
      stripePriceId
      product
      interval
      status
    }
  }
}
Response
{
  "data": {
    "profile": {
      "id": 4,
      "email": "abc123",
      "phoneNumber": "xyz789",
      "firstName": "xyz789",
      "lastName": "abc123",
      "registeredAt": "2007-12-03T10:15:30Z",
      "stripeCustomerId": "abc123",
      "referralId": "xyz789",
      "hasReferrals": false,
      "subscriptionData": SubscriptionDataType
    }
  }
}
Queries

publicPortfolios

Response

Returns [PortfolioType]

Arguments
Name Description
includeTypes - [String] List of portfolio types to include. Possible values are "featured" and "benchmark". By default, only featured portfolios are included.
portfolioIds - [ID] List of portfolio IDs to include.

Example

Query
query PublicPortfolios(
  $includeTypes: [String],
  $portfolioIds: [ID]
) {
  publicPortfolios(
    includeTypes: $includeTypes,
    portfolioIds: $portfolioIds
  ) {
    id
    owner {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    name
    category {
      id
      name
      displayName
      description
      include
      portfolioSet {
        ...PortfolioTypeFragment
      }
    }
    description
    private
    featured
    createdAt
    rebalanceFrequency
    maxStocks
    maxStocksCriteria
    maxStocksCriteriaOrder
    maxSectorConcentration
    totalRating
    returnRating
    growthRating
    riskRating
    valuationRating
    technicalRating
    macroRating
    marketCap
    sectorIds
    industryIds
    copiedFrom {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    portfolioType
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    copies {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
    nextRebalanceDate
    previousRebalanceDate
    benchmarkId
    ranges
    holdings {
      id
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      grossMarginsRating
      operatingMarginsRating
      ebitdaMarginsRating
      netProfitMarginsRating
      operationalEfficiencyRating
      returnOnAssetsRating
      returnOnCapitalRating
      returnOnEquityRating
      revenueGrowthRating
      earningsGrowthRating
      revenueGrowthConsistencyRating
      earningsGrowthConsistencyRating
      leverageRating
      liquidityRating
      interestCoverageRating
      cashFlowCoverageRating
      salesMultiplesRating
      ebitdaMultiplesRating
      earningsMultiplesRating
      bookValueMultiplesRating
      dividendYieldRating
      momentumRating
      trendRating
      volatilityRating
      volumeRating
      stock {
        ...StockTypeFragment
      }
      date
    }
    portfolioValues
    cagr
  }
}
Variables
{
  "includeTypes": ["xyz789"],
  "portfolioIds": ["4"]
}
Response
{
  "data": {
    "publicPortfolios": [
      {
        "id": 4,
        "owner": UserType,
        "name": "abc123",
        "category": PortfolioCategoryType,
        "description": "abc123",
        "private": false,
        "featured": true,
        "createdAt": "2007-12-03T10:15:30Z",
        "rebalanceFrequency": 123,
        "maxStocks": 123,
        "maxStocksCriteria": "MARKET_CAP",
        "maxStocksCriteriaOrder": "DESCENDING",
        "maxSectorConcentration": Decimal,
        "totalRating": [Decimal],
        "returnRating": [Decimal],
        "growthRating": [Decimal],
        "riskRating": [Decimal],
        "valuationRating": [Decimal],
        "technicalRating": [Decimal],
        "macroRating": [Decimal],
        "marketCap": [Decimal],
        "sectorIds": [123],
        "industryIds": [123],
        "copiedFrom": PortfolioType,
        "portfolioType": "FEATURED",
        "subscriptionviewSet": [SubscriptionViewType],
        "copies": [PortfolioType],
        "nextRebalanceDate": "abc123",
        "previousRebalanceDate": "xyz789",
        "benchmarkId": 4,
        "ranges": GenericScalar,
        "holdings": [PortfolioHoldingsType],
        "portfolioValues": GenericScalar,
        "cagr": 123.45
      }
    ]
  }
}
Queries

sectorRatings

Description

Retrieves average sector ratings.

Response

Returns a SectorRatingNodeConnection

Arguments
Name Description
ranges - GenericScalar Defines range of sector ratings to be returned.
orderBy - [String] Defines what rating is used to rank sectors in response.
search - [String] Limit to sectors where ticker or name contain search string.
offset - Int
before - String
after - String
first - Int
last - Int
sector_Name - String
sector_Name_Icontains - String
date - Date

Example

Query
query SectorRatings(
  $ranges: GenericScalar,
  $orderBy: [String],
  $search: [String],
  $offset: Int,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $sector_Name: String,
  $sector_Name_Icontains: String,
  $date: Date
) {
  sectorRatings(
    ranges: $ranges,
    orderBy: $orderBy,
    search: $search,
    offset: $offset,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    sector_Name: $sector_Name,
    sector_Name_Icontains: $sector_Name_Icontains,
    date: $date
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node {
        ...SectorRatingNodeFragment
      }
      cursor
    }
    totalCount
    edgeCount
  }
}
Variables
{
  "ranges": GenericScalar,
  "orderBy": ["abc123"],
  "search": ["abc123"],
  "offset": 987,
  "before": "abc123",
  "after": "xyz789",
  "first": 987,
  "last": 987,
  "sector_Name": "xyz789",
  "sector_Name_Icontains": "abc123",
  "date": "2007-12-03"
}
Response
{
  "data": {
    "sectorRatings": {
      "pageInfo": PageInfo,
      "edges": [SectorRatingNodeEdge],
      "totalCount": 987,
      "edgeCount": 987
    }
  }
}
Queries

sectors

Response

Returns [SectorType]

Example

Query
query Sectors {
  sectors {
    id
    name
    industrySet {
      id
      name
      sector {
        ...SectorTypeFragment
      }
      stockSet {
        ...StockTypeFragment
      }
      industryRatings {
        ...IndustryRatingNodeConnectionFragment
      }
    }
    stockSet {
      id
      ticker
      name
      sector {
        ...SectorTypeFragment
      }
      industry {
        ...IndustryTypeFragment
      }
      marketCap
      price
      includeSearch
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      stockRatings {
        ...WatchlistItemsNodeConnectionFragment
      }
      watchlistItems {
        ...WatchlistItemsTypeFragment
      }
      ratingalertSet {
        ...RatingAlertTypeFragment
      }
      stockPriceData
      stockRatingsData
      stockIncomeAnnualData
      stockBalanceAnnualData
      stockCashFlowAnnualData
      stockDerivedAnnualData
      stockIncomeQuarterlyData
      stockBalanceQuarterlyData
      stockCashFlowQuarterlyData
      stockDerivedQuarterlyData
      stockIncomeTtmData
      stockBalanceTtmData
      stockCashFlowTtmData
      stockDerivedTtmData
      stockDescription
    }
    sectorRatings {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...SectorRatingNodeEdgeFragment
      }
      totalCount
      edgeCount
    }
  }
}
Response
{
  "data": {
    "sectors": [
      {
        "id": 4,
        "name": "abc123",
        "industrySet": [IndustryType],
        "stockSet": [StockType],
        "sectorRatings": SectorRatingNodeConnection
      }
    ]
  }
}
Queries

stockByTicker

Description

Returns a specific stock object if exists for stock ticker input.

Response

Returns a StockType

Arguments
Name Description
ticker - String! Stock ticker. Letter case not important.
periods - Int

Example

Query
query StockByTicker(
  $ticker: String!,
  $periods: Int
) {
  stockByTicker(
    ticker: $ticker,
    periods: $periods
  ) {
    id
    ticker
    name
    sector {
      id
      name
      industrySet {
        ...IndustryTypeFragment
      }
      stockSet {
        ...StockTypeFragment
      }
      sectorRatings {
        ...SectorRatingNodeConnectionFragment
      }
    }
    industry {
      id
      name
      sector {
        ...SectorTypeFragment
      }
      stockSet {
        ...StockTypeFragment
      }
      industryRatings {
        ...IndustryRatingNodeConnectionFragment
      }
    }
    marketCap
    price
    includeSearch
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    stockRatings {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...WatchlistItemsNodeEdgeFragment
      }
      totalCount
      edgeCount
      averageRatings
      sectorCount
      industryCount
      id
    }
    watchlistItems {
      id
      stock {
        ...StockTypeFragment
      }
    }
    ratingalertSet {
      id
      user {
        ...UserTypeFragment
      }
      stock {
        ...StockTypeFragment
      }
      ratingType {
        ...RatingTypeTypeFragment
      }
      trigger
      value
      lastTriggeredAt
      isActive
      createdAt
      currentRating
    }
    stockPriceData
    stockRatingsData
    stockIncomeAnnualData
    stockBalanceAnnualData
    stockCashFlowAnnualData
    stockDerivedAnnualData
    stockIncomeQuarterlyData
    stockBalanceQuarterlyData
    stockCashFlowQuarterlyData
    stockDerivedQuarterlyData
    stockIncomeTtmData
    stockBalanceTtmData
    stockCashFlowTtmData
    stockDerivedTtmData
    stockDescription
  }
}
Variables
{"ticker": "xyz789", "periods": 123}
Response
{
  "data": {
    "stockByTicker": {
      "id": 123,
      "ticker": "xyz789",
      "name": "abc123",
      "sector": SectorType,
      "industry": IndustryType,
      "marketCap": 987.65,
      "price": Decimal,
      "includeSearch": true,
      "subscriptionviewSet": [SubscriptionViewType],
      "stockRatings": WatchlistItemsNodeConnection,
      "watchlistItems": [WatchlistItemsType],
      "ratingalertSet": [RatingAlertType],
      "stockPriceData": GenericScalar,
      "stockRatingsData": GenericScalar,
      "stockIncomeAnnualData": GenericScalar,
      "stockBalanceAnnualData": GenericScalar,
      "stockCashFlowAnnualData": GenericScalar,
      "stockDerivedAnnualData": GenericScalar,
      "stockIncomeQuarterlyData": GenericScalar,
      "stockBalanceQuarterlyData": GenericScalar,
      "stockCashFlowQuarterlyData": GenericScalar,
      "stockDerivedQuarterlyData": GenericScalar,
      "stockIncomeTtmData": GenericScalar,
      "stockBalanceTtmData": GenericScalar,
      "stockCashFlowTtmData": GenericScalar,
      "stockDerivedTtmData": GenericScalar,
      "stockDescription": GenericScalar
    }
  }
}
Queries

stockMetrics

Description

Retrieves performance metrics for a stock.

Response

Returns a GenericScalar

Arguments
Name Description
id - Int id of the stock
benchmark - String Benchmark for comparison.
period - String Defines period of returns in years from latest available date. By default metrics provided for longest possible period available.

Example

Query
query StockMetrics(
  $id: Int,
  $benchmark: String,
  $period: String
) {
  stockMetrics(
    id: $id,
    benchmark: $benchmark,
    period: $period
  )
}
Variables
{
  "id": 123,
  "benchmark": "xyz789",
  "period": "abc123"
}
Response
{"data": {"stockMetrics": GenericScalar}}
Queries

stockRatings

Description

Retrieves a stock ratings object or a list of stock ratings objects.

Response

Returns a StockRatingNodeConnection

Arguments
Name Description
ranges - GenericScalar Defines range of stock ratings to be returned. E.g. setting to ranges={return_rating:[8,10],growth_rating:[7,10]} will only return stocks with return_ratings equal to or above 8 and growth_rating equal to or above 7. Min is 0 and max is 10. By default, no ratings limits are applied.
dateRange - [String] Defines the date range for stock ratings. Provide two dates in the format "YYYY-MM-DD", e.g., ["2023-01-01", "2023-12-31"].
orderBy - [String] Defines what rating is used to rank stocks in response. - in front denotes ranking in descending order (e.g. -total_rating returns stock with the highest total_rating first).
search - [String] Limit to stocks where ticker or name contain the search string.
sectorIds - [Int] Limit to stocks in selected sectors
industryIds - [Int] Limit to stocks in selected industries
ticker - String
offset - Int
before - String
after - String
first - Int
last - Int
stock_Ticker - String
stock_Ticker_Icontains - String
stock_Name - String
stock_Name_Icontains - String
date - Date

Example

Query
query StockRatings(
  $ranges: GenericScalar,
  $dateRange: [String],
  $orderBy: [String],
  $search: [String],
  $sectorIds: [Int],
  $industryIds: [Int],
  $ticker: String,
  $offset: Int,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $stock_Ticker: String,
  $stock_Ticker_Icontains: String,
  $stock_Name: String,
  $stock_Name_Icontains: String,
  $date: Date
) {
  stockRatings(
    ranges: $ranges,
    dateRange: $dateRange,
    orderBy: $orderBy,
    search: $search,
    sectorIds: $sectorIds,
    industryIds: $industryIds,
    ticker: $ticker,
    offset: $offset,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    stock_Ticker: $stock_Ticker,
    stock_Ticker_Icontains: $stock_Ticker_Icontains,
    stock_Name: $stock_Name,
    stock_Name_Icontains: $stock_Name_Icontains,
    date: $date
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node {
        ...StockRatingNodeFragment
      }
      cursor
    }
    totalCount
    edgeCount
  }
}
Variables
{
  "ranges": GenericScalar,
  "dateRange": ["abc123"],
  "orderBy": ["xyz789"],
  "search": ["abc123"],
  "sectorIds": [987],
  "industryIds": [123],
  "ticker": "abc123",
  "offset": 123,
  "before": "xyz789",
  "after": "abc123",
  "first": 123,
  "last": 987,
  "stock_Ticker": "abc123",
  "stock_Ticker_Icontains": "xyz789",
  "stock_Name": "xyz789",
  "stock_Name_Icontains": "xyz789",
  "date": "2007-12-03"
}
Response
{
  "data": {
    "stockRatings": {
      "pageInfo": PageInfo,
      "edges": [StockRatingNodeEdge],
      "totalCount": 987,
      "edgeCount": 123
    }
  }
}
Queries

stockReturnChart

Description

Retrieves periodic performance for a stock.

Response

Returns a GenericScalar

Arguments
Name Description
id - Int id of the stock
chartType - String The type of portfolio performance. Possible values are: "cumulative_return", "yearly_returns", "histogram", "drawdown", "rolling_beta" (requires benchmark), "rolling_volatility", "rolling_sharpe", "monthly_heatmap", "boxplot".
benchmark - String Benchmark for comparison.

Example

Query
query StockReturnChart(
  $id: Int,
  $chartType: String,
  $benchmark: String
) {
  stockReturnChart(
    id: $id,
    chartType: $chartType,
    benchmark: $benchmark
  )
}
Variables
{
  "id": 987,
  "chartType": "xyz789",
  "benchmark": "abc123"
}
Response
{"data": {"stockReturnChart": GenericScalar}}
Queries

stocksSearch

Description

Retrieves a list of one or more stocks meeting search criteria. Search string used to search stock names and stock tickers. If a very broad search string is provided the result will be limited to the first 10 stocks meeting the search criteria.

Response

Returns [StockType]

Arguments
Name Description
search - String!

Example

Query
query StocksSearch($search: String!) {
  stocksSearch(search: $search) {
    id
    ticker
    name
    sector {
      id
      name
      industrySet {
        ...IndustryTypeFragment
      }
      stockSet {
        ...StockTypeFragment
      }
      sectorRatings {
        ...SectorRatingNodeConnectionFragment
      }
    }
    industry {
      id
      name
      sector {
        ...SectorTypeFragment
      }
      stockSet {
        ...StockTypeFragment
      }
      industryRatings {
        ...IndustryRatingNodeConnectionFragment
      }
    }
    marketCap
    price
    includeSearch
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    stockRatings {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...WatchlistItemsNodeEdgeFragment
      }
      totalCount
      edgeCount
      averageRatings
      sectorCount
      industryCount
      id
    }
    watchlistItems {
      id
      stock {
        ...StockTypeFragment
      }
    }
    ratingalertSet {
      id
      user {
        ...UserTypeFragment
      }
      stock {
        ...StockTypeFragment
      }
      ratingType {
        ...RatingTypeTypeFragment
      }
      trigger
      value
      lastTriggeredAt
      isActive
      createdAt
      currentRating
    }
    stockPriceData
    stockRatingsData
    stockIncomeAnnualData
    stockBalanceAnnualData
    stockCashFlowAnnualData
    stockDerivedAnnualData
    stockIncomeQuarterlyData
    stockBalanceQuarterlyData
    stockCashFlowQuarterlyData
    stockDerivedQuarterlyData
    stockIncomeTtmData
    stockBalanceTtmData
    stockCashFlowTtmData
    stockDerivedTtmData
    stockDescription
  }
}
Variables
{"search": "abc123"}
Response
{
  "data": {
    "stocksSearch": [
      {
        "id": 123,
        "ticker": "xyz789",
        "name": "abc123",
        "sector": SectorType,
        "industry": IndustryType,
        "marketCap": 987.65,
        "price": Decimal,
        "includeSearch": false,
        "subscriptionviewSet": [SubscriptionViewType],
        "stockRatings": WatchlistItemsNodeConnection,
        "watchlistItems": [WatchlistItemsType],
        "ratingalertSet": [RatingAlertType],
        "stockPriceData": GenericScalar,
        "stockRatingsData": GenericScalar,
        "stockIncomeAnnualData": GenericScalar,
        "stockBalanceAnnualData": GenericScalar,
        "stockCashFlowAnnualData": GenericScalar,
        "stockDerivedAnnualData": GenericScalar,
        "stockIncomeQuarterlyData": GenericScalar,
        "stockBalanceQuarterlyData": GenericScalar,
        "stockCashFlowQuarterlyData": GenericScalar,
        "stockDerivedQuarterlyData": GenericScalar,
        "stockIncomeTtmData": GenericScalar,
        "stockBalanceTtmData": GenericScalar,
        "stockCashFlowTtmData": GenericScalar,
        "stockDerivedTtmData": GenericScalar,
        "stockDescription": GenericScalar
      }
    ]
  }
}
Queries

subscriptions

Description

Retrieves a list of subscriptions for user.

Response

Returns [SubscriptionType]

Arguments
Name Description
type - String

Example

Query
query Subscriptions($type: String) {
  subscriptions(type: $type) {
    id
    user {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    product {
      id
      subscriptionLevel
      name
      description
      type
      stripeProductIdTest
      stripeProductId
      priceSet {
        ...PriceTypeFragment
      }
      subscriptionSet {
        ...SubscriptionTypeFragment
      }
      subscriptionpaymentSet {
        ...SubscriptionPaymentTypeFragment
      }
      prices {
        ...PriceTypeFragment
      }
      features {
        ...ProductFeaturesTypeFragment
      }
    }
    price {
      id
      price
      currency
      interval
      stripePriceIdTest
      stripePriceId
      product {
        ...ProductTypeFragment
      }
      subscriptionSet {
        ...SubscriptionTypeFragment
      }
    }
    gateway
    createdAt
    validUntil
    status
    statusUpdatedAt
    stripeSubscriptionId
    subscriptionpaymentSet {
      id
      subscription {
        ...SubscriptionTypeFragment
      }
      product {
        ...ProductTypeFragment
      }
      amount
      gatewayFee
      currency
      date
      status
      stripeInvoiceId
      commission
    }
  }
}
Variables
{"type": "xyz789"}
Response
{
  "data": {
    "subscriptions": [
      {
        "id": 4,
        "user": UserType,
        "product": ProductType,
        "price": PriceType,
        "gateway": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "validUntil": "2007-12-03T10:15:30Z",
        "status": "xyz789",
        "statusUpdatedAt": "2007-12-03T10:15:30Z",
        "stripeSubscriptionId": "xyz789",
        "subscriptionpaymentSet": [
          SubscriptionPaymentType
        ]
      }
    ]
  }
}
Queries

success

Response

Returns a Boolean

Example

Query
query Success {
  success
}
Response
{"data": {"success": true}}
Queries

utilisation

Description

Retrieves object showing user's API usage for the current subscription period.

Response

Returns a GenericScalar

Example

Query
query Utilisation {
  utilisation
}
Response
{"data": {"utilisation": GenericScalar}}
Queries

watchlist

Description

Retrieves a specific watchlist object.

Response

Returns a WatchlistType

Arguments
Name Description
id - Int

Example

Query
query Watchlist($id: Int) {
  watchlist(id: $id) {
    id
    owner {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    name
    description
    private
    createdAt
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    watchlistItems {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...WatchlistItemNodeEdgeFragment
      }
    }
    stockCount
    avgTotalRating
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "watchlist": {
      "id": 4,
      "owner": UserType,
      "name": "abc123",
      "description": "abc123",
      "private": false,
      "createdAt": "2007-12-03T10:15:30Z",
      "subscriptionviewSet": [SubscriptionViewType],
      "watchlistItems": WatchlistItemNodeConnection,
      "stockCount": 987,
      "avgTotalRating": GenericScalar
    }
  }
}
Queries

watchlistItems

Description

Retrieves list of stocks in a watchlist.

Response

Returns a WatchlistItemsNodeConnection

Arguments
Name Description
watchlistId - Int id of the watchlist
orderBy - [String] Defines what rating is used to rank stocks in response. - in front denotes ranking in descending order (e.g. -total_rating returns stock with highest total_rating first). Other options are ticker or name. Default is ticker.
search - [String] Limit to stocks where ticker or name contain search string.
anonymised - Boolean
offset - Int
before - String
after - String
first - Int
last - Int
stock_Ticker - String
stock_Ticker_Icontains - String
stock_Name - String
stock_Name_Icontains - String

Example

Query
query WatchlistItems(
  $watchlistId: Int,
  $orderBy: [String],
  $search: [String],
  $anonymised: Boolean,
  $offset: Int,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int,
  $stock_Ticker: String,
  $stock_Ticker_Icontains: String,
  $stock_Name: String,
  $stock_Name_Icontains: String
) {
  watchlistItems(
    watchlistId: $watchlistId,
    orderBy: $orderBy,
    search: $search,
    anonymised: $anonymised,
    offset: $offset,
    before: $before,
    after: $after,
    first: $first,
    last: $last,
    stock_Ticker: $stock_Ticker,
    stock_Ticker_Icontains: $stock_Ticker_Icontains,
    stock_Name: $stock_Name,
    stock_Name_Icontains: $stock_Name_Icontains
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node {
        ...WatchlistItemsNodeFragment
      }
      cursor
    }
    totalCount
    edgeCount
    averageRatings
    sectorCount
    industryCount
    id
  }
}
Variables
{
  "watchlistId": 123,
  "orderBy": ["xyz789"],
  "search": ["xyz789"],
  "anonymised": true,
  "offset": 987,
  "before": "xyz789",
  "after": "abc123",
  "first": 987,
  "last": 123,
  "stock_Ticker": "xyz789",
  "stock_Ticker_Icontains": "abc123",
  "stock_Name": "abc123",
  "stock_Name_Icontains": "xyz789"
}
Response
{
  "data": {
    "watchlistItems": {
      "pageInfo": PageInfo,
      "edges": [WatchlistItemsNodeEdge],
      "totalCount": 987,
      "edgeCount": 123,
      "averageRatings": GenericScalar,
      "sectorCount": GenericScalar,
      "industryCount": GenericScalar,
      "id": 987
    }
  }
}
Queries

watchlistsForUser

Description

Retrieves a list of watchlists objects for user.

Response

Returns [WatchlistType]

Arguments
Name Description
id - Int

Example

Query
query WatchlistsForUser($id: Int) {
  watchlistsForUser(id: $id) {
    id
    owner {
      id
      email
      phoneNumber
      firstName
      lastName
      registeredAt
      stripeCustomerId
      referralId
      hasReferrals
      subscriptionData {
        ...SubscriptionDataTypeFragment
      }
    }
    name
    description
    private
    createdAt
    subscriptionviewSet {
      id
      user {
        ...UserTypeFragment
      }
      type
      stock {
        ...StockTypeFragment
      }
      portfolio {
        ...PortfolioTypeFragment
      }
      watchlist {
        ...WatchlistTypeFragment
      }
      timestamp
    }
    watchlistItems {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...WatchlistItemNodeEdgeFragment
      }
    }
    stockCount
    avgTotalRating
  }
}
Variables
{"id": 987}
Response
{
  "data": {
    "watchlistsForUser": [
      {
        "id": 4,
        "owner": UserType,
        "name": "abc123",
        "description": "abc123",
        "private": false,
        "createdAt": "2007-12-03T10:15:30Z",
        "subscriptionviewSet": [SubscriptionViewType],
        "watchlistItems": WatchlistItemNodeConnection,
        "stockCount": 123,
        "avgTotalRating": GenericScalar
      }
    ]
  }
}

Mutations

addToWatchlist

Response

Returns an AddToWatchlist

Arguments
Name Description
stockIds - [ID]
stockTickers - [String]
watchlistId - ID!

Example

Query
mutation AddToWatchlist(
  $stockIds: [ID],
  $stockTickers: [String],
  $watchlistId: ID!
) {
  addToWatchlist(
    stockIds: $stockIds,
    stockTickers: $stockTickers,
    watchlistId: $watchlistId
  ) {
    success
    errors
  }
}
Variables
{
  "stockIds": ["4"],
  "stockTickers": ["abc123"],
  "watchlistId": 4
}
Response
{
  "data": {
    "addToWatchlist": {
      "success": false,
      "errors": ["xyz789"]
    }
  }
}
Mutations

createPortfolio

Response

Returns a CreatePortfolio

Arguments
Name Description
spData - PortfolioInput

Example

Query
mutation CreatePortfolio($spData: PortfolioInput) {
  createPortfolio(spData: $spData) {
    success
    errors
    portfolio {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
  }
}
Variables
{"spData": PortfolioInput}
Response
{
  "data": {
    "createPortfolio": {
      "success": false,
      "errors": ["abc123"],
      "portfolio": PortfolioType
    }
  }
}
Mutations

createRatingAlert

Response

Returns a CreateRatingAlert

Arguments
Name Description
ratingTypeId - Int!
stockId - Int!
trigger - String!
userId - Int
value - Decimal!

Example

Query
mutation CreateRatingAlert(
  $ratingTypeId: Int!,
  $stockId: Int!,
  $trigger: String!,
  $userId: Int,
  $value: Decimal!
) {
  createRatingAlert(
    ratingTypeId: $ratingTypeId,
    stockId: $stockId,
    trigger: $trigger,
    userId: $userId,
    value: $value
  ) {
    success
    errors
    ratingAlert {
      id
      user {
        ...UserTypeFragment
      }
      stock {
        ...StockTypeFragment
      }
      ratingType {
        ...RatingTypeTypeFragment
      }
      trigger
      value
      lastTriggeredAt
      isActive
      createdAt
      currentRating
    }
  }
}
Variables
{
  "ratingTypeId": 987,
  "stockId": 987,
  "trigger": "abc123",
  "userId": 987,
  "value": Decimal
}
Response
{
  "data": {
    "createRatingAlert": {
      "success": false,
      "errors": ["abc123"],
      "ratingAlert": RatingAlertType
    }
  }
}
Mutations

createWatchlist

Response

Returns a CreateWatchlist

Arguments
Name Description
description - String
name - String
private - Boolean

Example

Query
mutation CreateWatchlist(
  $description: String,
  $name: String,
  $private: Boolean
) {
  createWatchlist(
    description: $description,
    name: $name,
    private: $private
  ) {
    success
    errors
    watchlist {
      id
      owner {
        ...UserTypeFragment
      }
      name
      description
      private
      createdAt
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      watchlistItems {
        ...WatchlistItemNodeConnectionFragment
      }
      stockCount
      avgTotalRating
    }
  }
}
Variables
{
  "description": "xyz789",
  "name": "abc123",
  "private": false
}
Response
{
  "data": {
    "createWatchlist": {
      "success": true,
      "errors": ["abc123"],
      "watchlist": WatchlistType
    }
  }
}
Mutations

deletePortfolio

Response

Returns a DeletePortfolio

Arguments
Name Description
id - ID

Example

Query
mutation DeletePortfolio($id: ID) {
  deletePortfolio(id: $id) {
    success
    errors
    portfolio {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deletePortfolio": {
      "success": true,
      "errors": ["abc123"],
      "portfolio": PortfolioType
    }
  }
}
Mutations

deleteRatingAlert

Response

Returns a DeleteRatingAlert

Arguments
Name Description
alertId - Int!

Example

Query
mutation DeleteRatingAlert($alertId: Int!) {
  deleteRatingAlert(alertId: $alertId) {
    success
    errors
  }
}
Variables
{"alertId": 123}
Response
{
  "data": {
    "deleteRatingAlert": {
      "success": true,
      "errors": ["abc123"]
    }
  }
}
Mutations

deleteRatingAlerts

Response

Returns a DeleteRatingAlerts

Arguments
Name Description
alertIds - [ID]!

Example

Query
mutation DeleteRatingAlerts($alertIds: [ID]!) {
  deleteRatingAlerts(alertIds: $alertIds) {
    success
    errors
  }
}
Variables
{"alertIds": [4]}
Response
{
  "data": {
    "deleteRatingAlerts": {
      "success": true,
      "errors": ["xyz789"]
    }
  }
}
Mutations

deleteWatchlist

Response

Returns a DeleteWatchlist

Arguments
Name Description
id - ID!

Example

Query
mutation DeleteWatchlist($id: ID!) {
  deleteWatchlist(id: $id) {
    success
    errors
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteWatchlist": {
      "success": true,
      "errors": ["xyz789"]
    }
  }
}
Mutations

editRatingAlert

Response

Returns an EditRatingAlert

Arguments
Name Description
alertId - Int!
ratingTypeId - Int
trigger - String
value - Decimal

Example

Query
mutation EditRatingAlert(
  $alertId: Int!,
  $ratingTypeId: Int,
  $trigger: String,
  $value: Decimal
) {
  editRatingAlert(
    alertId: $alertId,
    ratingTypeId: $ratingTypeId,
    trigger: $trigger,
    value: $value
  ) {
    success
    errors
    ratingAlert {
      id
      user {
        ...UserTypeFragment
      }
      stock {
        ...StockTypeFragment
      }
      ratingType {
        ...RatingTypeTypeFragment
      }
      trigger
      value
      lastTriggeredAt
      isActive
      createdAt
      currentRating
    }
  }
}
Variables
{
  "alertId": 123,
  "ratingTypeId": 987,
  "trigger": "xyz789",
  "value": Decimal
}
Response
{
  "data": {
    "editRatingAlert": {
      "success": true,
      "errors": ["xyz789"],
      "ratingAlert": RatingAlertType
    }
  }
}
Mutations

removeFromWatchlist

Response

Returns a RemoveFromWatchlist

Arguments
Name Description
stockIds - [ID]
watchlistId - ID!

Example

Query
mutation RemoveFromWatchlist(
  $stockIds: [ID],
  $watchlistId: ID!
) {
  removeFromWatchlist(
    stockIds: $stockIds,
    watchlistId: $watchlistId
  ) {
    success
    errors
  }
}
Variables
{"stockIds": ["4"], "watchlistId": 4}
Response
{
  "data": {
    "removeFromWatchlist": {
      "success": false,
      "errors": ["xyz789"]
    }
  }
}
Mutations

updatePortfolio

Response

Returns an UpdatePortfolio

Arguments
Name Description
portfolioId - ID
spData - PortfolioInput!

Example

Query
mutation UpdatePortfolio(
  $portfolioId: ID,
  $spData: PortfolioInput!
) {
  updatePortfolio(
    portfolioId: $portfolioId,
    spData: $spData
  ) {
    success
    errors
    portfolio {
      id
      owner {
        ...UserTypeFragment
      }
      name
      category {
        ...PortfolioCategoryTypeFragment
      }
      description
      private
      featured
      createdAt
      rebalanceFrequency
      maxStocks
      maxStocksCriteria
      maxStocksCriteriaOrder
      maxSectorConcentration
      totalRating
      returnRating
      growthRating
      riskRating
      valuationRating
      technicalRating
      macroRating
      marketCap
      sectorIds
      industryIds
      copiedFrom {
        ...PortfolioTypeFragment
      }
      portfolioType
      subscriptionviewSet {
        ...SubscriptionViewTypeFragment
      }
      copies {
        ...PortfolioTypeFragment
      }
      nextRebalanceDate
      previousRebalanceDate
      benchmarkId
      ranges
      holdings {
        ...PortfolioHoldingsTypeFragment
      }
      portfolioValues
      cagr
    }
  }
}
Variables
{"portfolioId": 4, "spData": PortfolioInput}
Response
{
  "data": {
    "updatePortfolio": {
      "success": true,
      "errors": ["xyz789"],
      "portfolio": PortfolioType
    }
  }
}
Mutations

updateWatchlist

Response

Returns an UpdateWatchlist

Arguments
Name Description
description - String
name - String
watchlistId - ID!

Example

Query
mutation UpdateWatchlist(
  $description: String,
  $name: String,
  $watchlistId: ID!
) {
  updateWatchlist(
    description: $description,
    name: $name,
    watchlistId: $watchlistId
  ) {
    success
    errors
  }
}
Variables
{
  "description": "abc123",
  "name": "abc123",
  "watchlistId": "4"
}
Response
{
  "data": {
    "updateWatchlist": {
      "success": true,
      "errors": ["xyz789"]
    }
  }
}

Types

AddToWatchlist

Fields
Field Name Description
success - Boolean
errors - [String]
Example
{"success": true, "errors": ["xyz789"]}
Types

BenchmarkType

Fields
Field Name Description
id - ID!
owner - UserType! User id of portfolio owner
name - String! Name of the portfolio
category - PortfolioCategoryType
description - String
private - Boolean! Indicates whether portfolio is private or accessible for other users
featured - Boolean! Indicates whether portfolio should be shown in the featured portfolios section
createdAt - DateTime!
rebalanceFrequency - Int!
maxStocks - Int
maxStocksCriteria - PortfoliosPortfolioMaxStocksCriteriaChoices!
maxStocksCriteriaOrder - PortfoliosPortfolioMaxStocksCriteriaOrderChoices!
maxSectorConcentration - Decimal!
totalRating - [Decimal!]
returnRating - [Decimal!]
growthRating - [Decimal!]
riskRating - [Decimal!]
valuationRating - [Decimal!]
technicalRating - [Decimal!]
macroRating - [Decimal!]
marketCap - [Decimal!]
sectorIds - [Int!]
industryIds - [Int!]
copiedFrom - PortfolioType
portfolioType - PortfoliosPortfolioPortfolioTypeChoices
subscriptionviewSet - [SubscriptionViewType!]!
copies - [PortfolioType!]!
Example
{
  "id": 4,
  "owner": UserType,
  "name": "xyz789",
  "category": PortfolioCategoryType,
  "description": "abc123",
  "private": false,
  "featured": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "rebalanceFrequency": 123,
  "maxStocks": 987,
  "maxStocksCriteria": "MARKET_CAP",
  "maxStocksCriteriaOrder": "DESCENDING",
  "maxSectorConcentration": Decimal,
  "totalRating": [Decimal],
  "returnRating": [Decimal],
  "growthRating": [Decimal],
  "riskRating": [Decimal],
  "valuationRating": [Decimal],
  "technicalRating": [Decimal],
  "macroRating": [Decimal],
  "marketCap": [Decimal],
  "sectorIds": [123],
  "industryIds": [123],
  "copiedFrom": PortfolioType,
  "portfolioType": "FEATURED",
  "subscriptionviewSet": [SubscriptionViewType],
  "copies": [PortfolioType]
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CreatePortfolio

Fields
Field Name Description
success - Boolean
errors - [String]
portfolio - PortfolioType
Example
{
  "success": true,
  "errors": ["xyz789"],
  "portfolio": PortfolioType
}
Types

CreateRatingAlert

Fields
Field Name Description
success - Boolean
errors - [String]
ratingAlert - RatingAlertType
Example
{
  "success": true,
  "errors": ["abc123"],
  "ratingAlert": RatingAlertType
}
Types

CreateWatchlist

Fields
Field Name Description
success - Boolean
errors - [String]
watchlist - WatchlistType
Example
{
  "success": false,
  "errors": ["xyz789"],
  "watchlist": WatchlistType
}
Types

Date

Description

The Date scalar type represents a Date value as specified by iso8601.

Example
"2007-12-03"
Types

DateTime

Description

The DateTime scalar type represents a DateTime value as specified by iso8601.

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

Decimal

Description

The Decimal scalar type represents a python Decimal.

Example
Decimal
Types

DeletePortfolio

Fields
Field Name Description
success - Boolean
errors - [String]
portfolio - PortfolioType
Example
{
  "success": false,
  "errors": ["abc123"],
  "portfolio": PortfolioType
}
Types

DeleteRatingAlert

Fields
Field Name Description
success - Boolean
errors - [String]
Example
{"success": false, "errors": ["xyz789"]}
Types

DeleteRatingAlerts

Fields
Field Name Description
success - Boolean
errors - [String]
Example
{"success": true, "errors": ["abc123"]}
Types

DeleteWatchlist

Fields
Field Name Description
success - Boolean
errors - [String]
Example
{"success": false, "errors": ["abc123"]}
Types

EditRatingAlert

Fields
Field Name Description
success - Boolean
errors - [String]
ratingAlert - RatingAlertType
Example
{
  "success": false,
  "errors": ["abc123"],
  "ratingAlert": RatingAlertType
}
Types

Float

Description

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

Example
123.45
Types

GenericScalar

Description

The GenericScalar scalar type represents a generic GraphQL scalar value that could be: String, Boolean, Int, Float, List or Object.

Example
GenericScalar
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

IndustryRatingNode

Fields
Field Name Description
id - ID! The ID of the object
totalRating - Decimal
returnRating - Decimal
growthRating - Decimal
riskRating - Decimal
valuationRating - Decimal
technicalRating - Decimal
macroRating - Decimal
grossMarginsRating - Decimal
operatingMarginsRating - Decimal
ebitdaMarginsRating - Decimal
netProfitMarginsRating - Decimal
operationalEfficiencyRating - Decimal
returnOnAssetsRating - Decimal
returnOnCapitalRating - Decimal
returnOnEquityRating - Decimal
revenueGrowthRating - Decimal
earningsGrowthRating - Decimal
revenueGrowthConsistencyRating - Decimal
earningsGrowthConsistencyRating - Decimal
leverageRating - Decimal
liquidityRating - Decimal
interestCoverageRating - Decimal
cashFlowCoverageRating - Decimal
salesMultiplesRating - Decimal
ebitdaMultiplesRating - Decimal
earningsMultiplesRating - Decimal
bookValueMultiplesRating - Decimal
dividendYieldRating - Decimal
momentumRating - Decimal
trendRating - Decimal
volatilityRating - Decimal
volumeRating - Decimal
industry - IndustryType!
date - Date!
Example
{
  "id": 4,
  "totalRating": Decimal,
  "returnRating": Decimal,
  "growthRating": Decimal,
  "riskRating": Decimal,
  "valuationRating": Decimal,
  "technicalRating": Decimal,
  "macroRating": Decimal,
  "grossMarginsRating": Decimal,
  "operatingMarginsRating": Decimal,
  "ebitdaMarginsRating": Decimal,
  "netProfitMarginsRating": Decimal,
  "operationalEfficiencyRating": Decimal,
  "returnOnAssetsRating": Decimal,
  "returnOnCapitalRating": Decimal,
  "returnOnEquityRating": Decimal,
  "revenueGrowthRating": Decimal,
  "earningsGrowthRating": Decimal,
  "revenueGrowthConsistencyRating": Decimal,
  "earningsGrowthConsistencyRating": Decimal,
  "leverageRating": Decimal,
  "liquidityRating": Decimal,
  "interestCoverageRating": Decimal,
  "cashFlowCoverageRating": Decimal,
  "salesMultiplesRating": Decimal,
  "ebitdaMultiplesRating": Decimal,
  "earningsMultiplesRating": Decimal,
  "bookValueMultiplesRating": Decimal,
  "dividendYieldRating": Decimal,
  "momentumRating": Decimal,
  "trendRating": Decimal,
  "volatilityRating": Decimal,
  "volumeRating": Decimal,
  "industry": IndustryType,
  "date": "2007-12-03"
}
Types

IndustryRatingNodeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [IndustryRatingNodeEdge]! Contains the nodes in this connection.
totalCount - Int
edgeCount - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [IndustryRatingNodeEdge],
  "totalCount": 987,
  "edgeCount": 123
}
Types

IndustryRatingNodeEdge

Description

A Relay edge containing a IndustryRatingNode and its cursor.

Fields
Field Name Description
node - IndustryRatingNode The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": IndustryRatingNode,
  "cursor": "xyz789"
}
Types

IndustryType

Fields
Field Name Description
id - ID!
name - String
sector - SectorType
stockSet - [StockType!]!
industryRatings - IndustryRatingNodeConnection!
Arguments
offset - Int
before - String
after - String
first - Int
last - Int
industry_Name - String
industry_Name_Icontains - String
date - Date
Example
{
  "id": 4,
  "name": "xyz789",
  "sector": SectorType,
  "stockSet": [StockType],
  "industryRatings": IndustryRatingNodeConnection
}
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
987
Types

Node

Description

An object with an ID

Fields
Field Name Description
id - ID! The ID of the object
Possible Types
Node Types

WatchlistItemsNode

IndustryRatingNode

SectorRatingNode

WatchlistItemNode

PortfolioHoldingsNode

StockRatingNode
Example
{"id": "4"}
Types

PageInfo

Description

The Relay compliant PageInfo type, containing data necessary to paginate this connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": false,
  "hasPreviousPage": false,
  "startCursor": "abc123",
  "endCursor": "abc123"
}
Types

PortfolioCategoryType

Fields
Field Name Description
id - ID!
name - String!
displayName - String! Display name of the category
description - String
include - Boolean! Indicates whether this category should be included in the portfolio categories list
portfolioSet - [PortfolioType!]!
Example
{
  "id": "4",
  "name": "abc123",
  "displayName": "xyz789",
  "description": "abc123",
  "include": true,
  "portfolioSet": [PortfolioType]
}
Types

PortfolioHoldingsNode

Fields
Field Name Description
id - ID! The ID of the object
totalRating - Decimal
returnRating - Decimal
growthRating - Decimal
riskRating - Decimal
valuationRating - Decimal
technicalRating - Decimal
macroRating - Decimal
grossMarginsRating - Decimal
operatingMarginsRating - Decimal
ebitdaMarginsRating - Decimal
netProfitMarginsRating - Decimal
operationalEfficiencyRating - Decimal
returnOnAssetsRating - Decimal
returnOnCapitalRating - Decimal
returnOnEquityRating - Decimal
revenueGrowthRating - Decimal
earningsGrowthRating - Decimal
revenueGrowthConsistencyRating - Decimal
earningsGrowthConsistencyRating - Decimal
leverageRating - Decimal
liquidityRating - Decimal
interestCoverageRating - Decimal
cashFlowCoverageRating - Decimal
salesMultiplesRating - Decimal
ebitdaMultiplesRating - Decimal
earningsMultiplesRating - Decimal
bookValueMultiplesRating - Decimal
dividendYieldRating - Decimal
momentumRating - Decimal
trendRating - Decimal
volatilityRating - Decimal
volumeRating - Decimal
stock - StockType
date - Date!
Example
{
  "id": "4",
  "totalRating": Decimal,
  "returnRating": Decimal,
  "growthRating": Decimal,
  "riskRating": Decimal,
  "valuationRating": Decimal,
  "technicalRating": Decimal,
  "macroRating": Decimal,
  "grossMarginsRating": Decimal,
  "operatingMarginsRating": Decimal,
  "ebitdaMarginsRating": Decimal,
  "netProfitMarginsRating": Decimal,
  "operationalEfficiencyRating": Decimal,
  "returnOnAssetsRating": Decimal,
  "returnOnCapitalRating": Decimal,
  "returnOnEquityRating": Decimal,
  "revenueGrowthRating": Decimal,
  "earningsGrowthRating": Decimal,
  "revenueGrowthConsistencyRating": Decimal,
  "earningsGrowthConsistencyRating": Decimal,
  "leverageRating": Decimal,
  "liquidityRating": Decimal,
  "interestCoverageRating": Decimal,
  "cashFlowCoverageRating": Decimal,
  "salesMultiplesRating": Decimal,
  "ebitdaMultiplesRating": Decimal,
  "earningsMultiplesRating": Decimal,
  "bookValueMultiplesRating": Decimal,
  "dividendYieldRating": Decimal,
  "momentumRating": Decimal,
  "trendRating": Decimal,
  "volatilityRating": Decimal,
  "volumeRating": Decimal,
  "stock": StockType,
  "date": "2007-12-03"
}
Types

PortfolioHoldingsNodeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [PortfolioHoldingsNodeEdge]! Contains the nodes in this connection.
totalCount - Int
edgeCount - Int
averageRatings - GenericScalar
sectorCount - GenericScalar
industryCount - GenericScalar
Example
{
  "pageInfo": PageInfo,
  "edges": [PortfolioHoldingsNodeEdge],
  "totalCount": 987,
  "edgeCount": 987,
  "averageRatings": GenericScalar,
  "sectorCount": GenericScalar,
  "industryCount": GenericScalar
}
Types

PortfolioHoldingsNodeEdge

Description

A Relay edge containing a PortfolioHoldingsNode and its cursor.

Fields
Field Name Description
node - PortfolioHoldingsNode The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": PortfolioHoldingsNode,
  "cursor": "abc123"
}
Types

PortfolioHoldingsType

Fields
Field Name Description
id - ID!
totalRating - Decimal
returnRating - Decimal
growthRating - Decimal
riskRating - Decimal
valuationRating - Decimal
technicalRating - Decimal
macroRating - Decimal
grossMarginsRating - Decimal
operatingMarginsRating - Decimal
ebitdaMarginsRating - Decimal
netProfitMarginsRating - Decimal
operationalEfficiencyRating - Decimal
returnOnAssetsRating - Decimal
returnOnCapitalRating - Decimal
returnOnEquityRating - Decimal
revenueGrowthRating - Decimal
earningsGrowthRating - Decimal
revenueGrowthConsistencyRating - Decimal
earningsGrowthConsistencyRating - Decimal
leverageRating - Decimal
liquidityRating - Decimal
interestCoverageRating - Decimal
cashFlowCoverageRating - Decimal
salesMultiplesRating - Decimal
ebitdaMultiplesRating - Decimal
earningsMultiplesRating - Decimal
bookValueMultiplesRating - Decimal
dividendYieldRating - Decimal
momentumRating - Decimal
trendRating - Decimal
volatilityRating - Decimal
volumeRating - Decimal
stock - StockType
date - Date!
Example
{
  "id": 4,
  "totalRating": Decimal,
  "returnRating": Decimal,
  "growthRating": Decimal,
  "riskRating": Decimal,
  "valuationRating": Decimal,
  "technicalRating": Decimal,
  "macroRating": Decimal,
  "grossMarginsRating": Decimal,
  "operatingMarginsRating": Decimal,
  "ebitdaMarginsRating": Decimal,
  "netProfitMarginsRating": Decimal,
  "operationalEfficiencyRating": Decimal,
  "returnOnAssetsRating": Decimal,
  "returnOnCapitalRating": Decimal,
  "returnOnEquityRating": Decimal,
  "revenueGrowthRating": Decimal,
  "earningsGrowthRating": Decimal,
  "revenueGrowthConsistencyRating": Decimal,
  "earningsGrowthConsistencyRating": Decimal,
  "leverageRating": Decimal,
  "liquidityRating": Decimal,
  "interestCoverageRating": Decimal,
  "cashFlowCoverageRating": Decimal,
  "salesMultiplesRating": Decimal,
  "ebitdaMultiplesRating": Decimal,
  "earningsMultiplesRating": Decimal,
  "bookValueMultiplesRating": Decimal,
  "dividendYieldRating": Decimal,
  "momentumRating": Decimal,
  "trendRating": Decimal,
  "volatilityRating": Decimal,
  "volumeRating": Decimal,
  "stock": StockType,
  "date": "2007-12-03"
}
Types

PortfolioInput

Fields
Input Field Description
owner - Int
name - String
description - String
private - Boolean
rebalanceFrequency - Int
maxStocks - Int
maxStocksCriteria - String
maxStocksCriteriaOrder - String
maxSectorConcentration - Decimal
ranges - GenericScalar
sectorIds - [Int]
industryIds - [Int]
copiedFrom - Int
Example
{
  "owner": 987,
  "name": "abc123",
  "description": "abc123",
  "private": false,
  "rebalanceFrequency": 123,
  "maxStocks": 123,
  "maxStocksCriteria": "xyz789",
  "maxStocksCriteriaOrder": "xyz789",
  "maxSectorConcentration": Decimal,
  "ranges": GenericScalar,
  "sectorIds": [123],
  "industryIds": [123],
  "copiedFrom": 987
}
Types

PortfolioType

Description

An object with info for a portfolio

Fields
Field Name Description
id - ID!
owner - UserType! User id of portfolio owner
name - String! Name of the portfolio
category - PortfolioCategoryType
description - String
private - Boolean! Indicates whether portfolio is private or accessible for other users
featured - Boolean! Indicates whether portfolio should be shown in the featured portfolios section
createdAt - DateTime!
rebalanceFrequency - Int!
maxStocks - Int
maxStocksCriteria - PortfoliosPortfolioMaxStocksCriteriaChoices!
maxStocksCriteriaOrder - PortfoliosPortfolioMaxStocksCriteriaOrderChoices!
maxSectorConcentration - Decimal!
totalRating - [Decimal!]
returnRating - [Decimal!]
growthRating - [Decimal!]
riskRating - [Decimal!]
valuationRating - [Decimal!]
technicalRating - [Decimal!]
macroRating - [Decimal!]
marketCap - [Decimal!]
sectorIds - [Int!]
industryIds - [Int!]
copiedFrom - PortfolioType
portfolioType - PortfoliosPortfolioPortfolioTypeChoices
subscriptionviewSet - [SubscriptionViewType!]!
copies - [PortfolioType!]!
nextRebalanceDate - String
previousRebalanceDate - String
benchmarkId - ID
ranges - GenericScalar
holdings - [PortfolioHoldingsType]
portfolioValues - GenericScalar
cagr - Float
Example
{
  "id": "4",
  "owner": UserType,
  "name": "xyz789",
  "category": PortfolioCategoryType,
  "description": "abc123",
  "private": true,
  "featured": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "rebalanceFrequency": 123,
  "maxStocks": 987,
  "maxStocksCriteria": "MARKET_CAP",
  "maxStocksCriteriaOrder": "DESCENDING",
  "maxSectorConcentration": Decimal,
  "totalRating": [Decimal],
  "returnRating": [Decimal],
  "growthRating": [Decimal],
  "riskRating": [Decimal],
  "valuationRating": [Decimal],
  "technicalRating": [Decimal],
  "macroRating": [Decimal],
  "marketCap": [Decimal],
  "sectorIds": [987],
  "industryIds": [123],
  "copiedFrom": PortfolioType,
  "portfolioType": "FEATURED",
  "subscriptionviewSet": [SubscriptionViewType],
  "copies": [PortfolioType],
  "nextRebalanceDate": "xyz789",
  "previousRebalanceDate": "xyz789",
  "benchmarkId": 4,
  "ranges": GenericScalar,
  "holdings": [PortfolioHoldingsType],
  "portfolioValues": GenericScalar,
  "cagr": 123.45
}
Types

PortfoliosPortfolioMaxStocksCriteriaChoices

Description

An enumeration.

Values
Enum Value Description

MARKET_CAP

 Market Cap

TOTAL_RATING

 Total Rating

RETURN_RATING

 Return Rating

GROWTH_RATING

 Growth Rating

RISK_RATING

 Risk Rating

VALUATION_RATING

 Valuation Rating

TECHNICAL_RATING

 Technical Rating

MACRO_RATING

 Macro Rating
Example
"MARKET_CAP"
Types

PortfoliosPortfolioMaxStocksCriteriaOrderChoices

Description

An enumeration.

Values
Enum Value Description

DESCENDING

 Descending

ASCENDING

 Ascending
Example
"DESCENDING"
Types

PortfoliosPortfolioPortfolioTypeChoices

Description

An enumeration.

Values
Enum Value Description

FEATURED

 Featured

BENCHMARK

 Benchmark

RATING_RANGE

 Rating Range

TOP_RATED

 Top Rated

BOTTOM_RATED

 Bottom Rated
Example
"FEATURED"
Types

PriceType

Fields
Field Name Description
id - ID!
price - Int!
currency - String!
interval - String
stripePriceIdTest - String
stripePriceId - String
product - ProductType!
subscriptionSet - [SubscriptionType!]!
Example
{
  "id": "4",
  "price": 123,
  "currency": "abc123",
  "interval": "abc123",
  "stripePriceIdTest": "abc123",
  "stripePriceId": "abc123",
  "product": ProductType,
  "subscriptionSet": [SubscriptionType]
}
Types

ProductFeaturesType

Fields
Field Name Description
id - Int
name - String
title - String
category - String
valueBoolean - Boolean
valueNumerical - Int
Example
{
  "id": 987,
  "name": "abc123",
  "title": "abc123",
  "category": "xyz789",
  "valueBoolean": false,
  "valueNumerical": 987
}
Types

ProductType

Fields
Field Name Description
id - ID!
subscriptionLevel - Int
name - String!
description - String
type - String!
stripeProductIdTest - String
stripeProductId - String
priceSet - [PriceType!]!
subscriptionSet - [SubscriptionType!]!
subscriptionpaymentSet - [SubscriptionPaymentType!]!
prices - [PriceType]
features - [ProductFeaturesType]
Example
{
  "id": "4",
  "subscriptionLevel": 123,
  "name": "abc123",
  "description": "xyz789",
  "type": "xyz789",
  "stripeProductIdTest": "abc123",
  "stripeProductId": "xyz789",
  "priceSet": [PriceType],
  "subscriptionSet": [SubscriptionType],
  "subscriptionpaymentSet": [SubscriptionPaymentType],
  "prices": [PriceType],
  "features": [ProductFeaturesType]
}
Types

RatingAlertType

Fields
Field Name Description
id - ID!
user - UserType! User id of alert owner
stock - StockType
ratingType - RatingTypeType!
trigger - String!
value - Decimal!
lastTriggeredAt - DateTime
isActive - Boolean!
createdAt - DateTime!
currentRating - Decimal
Example
{
  "id": "4",
  "user": UserType,
  "stock": StockType,
  "ratingType": RatingTypeType,
  "trigger": "abc123",
  "value": Decimal,
  "lastTriggeredAt": "2007-12-03T10:15:30Z",
  "isActive": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "currentRating": Decimal
}
Types

RatingTypeType

Fields
Field Name Description
id - ID!
name - String!
displayName - String!
description - String
include - Boolean!
ratingalertSet - [RatingAlertType!]!
Example
{
  "id": 4,
  "name": "abc123",
  "displayName": "abc123",
  "description": "xyz789",
  "include": true,
  "ratingalertSet": [RatingAlertType]
}
Types

RemoveFromWatchlist

Fields
Field Name Description
success - Boolean
errors - [String]
Example
{"success": false, "errors": ["abc123"]}
Types

SectorRatingNode

Fields
Field Name Description
id - ID! The ID of the object
totalRating - Decimal
returnRating - Decimal
growthRating - Decimal
riskRating - Decimal
valuationRating - Decimal
technicalRating - Decimal
macroRating - Decimal
grossMarginsRating - Decimal
operatingMarginsRating - Decimal
ebitdaMarginsRating - Decimal
netProfitMarginsRating - Decimal
operationalEfficiencyRating - Decimal
returnOnAssetsRating - Decimal
returnOnCapitalRating - Decimal
returnOnEquityRating - Decimal
revenueGrowthRating - Decimal
earningsGrowthRating - Decimal
revenueGrowthConsistencyRating - Decimal
earningsGrowthConsistencyRating - Decimal
leverageRating - Decimal
liquidityRating - Decimal
interestCoverageRating - Decimal
cashFlowCoverageRating - Decimal
salesMultiplesRating - Decimal
ebitdaMultiplesRating - Decimal
earningsMultiplesRating - Decimal
bookValueMultiplesRating - Decimal
dividendYieldRating - Decimal
momentumRating - Decimal
trendRating - Decimal
volatilityRating - Decimal
volumeRating - Decimal
sector - SectorType!
date - Date!
Example
{
  "id": 4,
  "totalRating": Decimal,
  "returnRating": Decimal,
  "growthRating": Decimal,
  "riskRating": Decimal,
  "valuationRating": Decimal,
  "technicalRating": Decimal,
  "macroRating": Decimal,
  "grossMarginsRating": Decimal,
  "operatingMarginsRating": Decimal,
  "ebitdaMarginsRating": Decimal,
  "netProfitMarginsRating": Decimal,
  "operationalEfficiencyRating": Decimal,
  "returnOnAssetsRating": Decimal,
  "returnOnCapitalRating": Decimal,
  "returnOnEquityRating": Decimal,
  "revenueGrowthRating": Decimal,
  "earningsGrowthRating": Decimal,
  "revenueGrowthConsistencyRating": Decimal,
  "earningsGrowthConsistencyRating": Decimal,
  "leverageRating": Decimal,
  "liquidityRating": Decimal,
  "interestCoverageRating": Decimal,
  "cashFlowCoverageRating": Decimal,
  "salesMultiplesRating": Decimal,
  "ebitdaMultiplesRating": Decimal,
  "earningsMultiplesRating": Decimal,
  "bookValueMultiplesRating": Decimal,
  "dividendYieldRating": Decimal,
  "momentumRating": Decimal,
  "trendRating": Decimal,
  "volatilityRating": Decimal,
  "volumeRating": Decimal,
  "sector": SectorType,
  "date": "2007-12-03"
}
Types

SectorRatingNodeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [SectorRatingNodeEdge]! Contains the nodes in this connection.
totalCount - Int
edgeCount - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [SectorRatingNodeEdge],
  "totalCount": 987,
  "edgeCount": 987
}
Types

SectorRatingNodeEdge

Description

A Relay edge containing a SectorRatingNode and its cursor.

Fields
Field Name Description
node - SectorRatingNode The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": SectorRatingNode,
  "cursor": "xyz789"
}
Types

SectorType

Fields
Field Name Description
id - ID!
name - String
industrySet - [IndustryType!]!
stockSet - [StockType!]!
sectorRatings - SectorRatingNodeConnection!
Arguments
offset - Int
before - String
after - String
first - Int
last - Int
sector_Name - String
sector_Name_Icontains - String
date - Date
Example
{
  "id": 4,
  "name": "xyz789",
  "industrySet": [IndustryType],
  "stockSet": [StockType],
  "sectorRatings": SectorRatingNodeConnection
}
Types

StockRatingNode

Fields
Field Name Description
id - ID! The ID of the object
totalRating - Float
returnRating - Float
growthRating - Float
riskRating - Float
valuationRating - Float
technicalRating - Float
macroRating - Float
grossMarginsRating - Decimal
operatingMarginsRating - Decimal
ebitdaMarginsRating - Decimal
netProfitMarginsRating - Decimal
operationalEfficiencyRating - Decimal
returnOnAssetsRating - Decimal
returnOnCapitalRating - Decimal
returnOnEquityRating - Decimal
revenueGrowthRating - Decimal
earningsGrowthRating - Decimal
revenueGrowthConsistencyRating - Decimal
earningsGrowthConsistencyRating - Decimal
leverageRating - Decimal
liquidityRating - Decimal
interestCoverageRating - Decimal
cashFlowCoverageRating - Decimal
salesMultiplesRating - Decimal
ebitdaMultiplesRating - Decimal
earningsMultiplesRating - Decimal
bookValueMultiplesRating - Decimal
dividendYieldRating - Decimal
momentumRating - Decimal
trendRating - Decimal
volatilityRating - Decimal
volumeRating - Decimal
stock - StockType
date - Date!
Example
{
  "id": "4",
  "totalRating": 123.45,
  "returnRating": 123.45,
  "growthRating": 123.45,
  "riskRating": 123.45,
  "valuationRating": 987.65,
  "technicalRating": 987.65,
  "macroRating": 987.65,
  "grossMarginsRating": Decimal,
  "operatingMarginsRating": Decimal,
  "ebitdaMarginsRating": Decimal,
  "netProfitMarginsRating": Decimal,
  "operationalEfficiencyRating": Decimal,
  "returnOnAssetsRating": Decimal,
  "returnOnCapitalRating": Decimal,
  "returnOnEquityRating": Decimal,
  "revenueGrowthRating": Decimal,
  "earningsGrowthRating": Decimal,
  "revenueGrowthConsistencyRating": Decimal,
  "earningsGrowthConsistencyRating": Decimal,
  "leverageRating": Decimal,
  "liquidityRating": Decimal,
  "interestCoverageRating": Decimal,
  "cashFlowCoverageRating": Decimal,
  "salesMultiplesRating": Decimal,
  "ebitdaMultiplesRating": Decimal,
  "earningsMultiplesRating": Decimal,
  "bookValueMultiplesRating": Decimal,
  "dividendYieldRating": Decimal,
  "momentumRating": Decimal,
  "trendRating": Decimal,
  "volatilityRating": Decimal,
  "volumeRating": Decimal,
  "stock": StockType,
  "date": "2007-12-03"
}
Types

StockRatingNodeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [StockRatingNodeEdge]! Contains the nodes in this connection.
totalCount - Int
edgeCount - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [StockRatingNodeEdge],
  "totalCount": 123,
  "edgeCount": 987
}
Types

StockRatingNodeEdge

Description

A Relay edge containing a StockRatingNode and its cursor.

Fields
Field Name Description
node - StockRatingNode The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": StockRatingNode,
  "cursor": "abc123"
}
Types

StockType

Fields
Field Name Description
id - Int!
ticker - String
name - String
sector - SectorType
industry - IndustryType
marketCap - Float
price - Decimal Latest closing price
includeSearch - Boolean!
subscriptionviewSet - [SubscriptionViewType!]!
stockRatings - WatchlistItemsNodeConnection!
Arguments
offset - Int
before - String
after - String
first - Int
last - Int
stock_Ticker - String
stock_Ticker_Icontains - String
stock_Name - String
stock_Name_Icontains - String
watchlistItems - [WatchlistItemsType!]!
ratingalertSet - [RatingAlertType!]!
stockPriceData - GenericScalar
stockRatingsData - GenericScalar
stockIncomeAnnualData - GenericScalar
stockBalanceAnnualData - GenericScalar
stockCashFlowAnnualData - GenericScalar
stockDerivedAnnualData - GenericScalar
stockIncomeQuarterlyData - GenericScalar
stockBalanceQuarterlyData - GenericScalar
stockCashFlowQuarterlyData - GenericScalar
stockDerivedQuarterlyData - GenericScalar
stockIncomeTtmData - GenericScalar
stockBalanceTtmData - GenericScalar
stockCashFlowTtmData - GenericScalar
stockDerivedTtmData - GenericScalar
stockDescription - GenericScalar
Example
{
  "id": 123,
  "ticker": "abc123",
  "name": "xyz789",
  "sector": SectorType,
  "industry": IndustryType,
  "marketCap": 123.45,
  "price": Decimal,
  "includeSearch": false,
  "subscriptionviewSet": [SubscriptionViewType],
  "stockRatings": WatchlistItemsNodeConnection,
  "watchlistItems": [WatchlistItemsType],
  "ratingalertSet": [RatingAlertType],
  "stockPriceData": GenericScalar,
  "stockRatingsData": GenericScalar,
  "stockIncomeAnnualData": GenericScalar,
  "stockBalanceAnnualData": GenericScalar,
  "stockCashFlowAnnualData": GenericScalar,
  "stockDerivedAnnualData": GenericScalar,
  "stockIncomeQuarterlyData": GenericScalar,
  "stockBalanceQuarterlyData": GenericScalar,
  "stockCashFlowQuarterlyData": GenericScalar,
  "stockDerivedQuarterlyData": GenericScalar,
  "stockIncomeTtmData": GenericScalar,
  "stockBalanceTtmData": GenericScalar,
  "stockCashFlowTtmData": GenericScalar,
  "stockDerivedTtmData": GenericScalar,
  "stockDescription": GenericScalar
}
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

SubscriptionDataType

Fields
Field Name Description
stripeSubscriptionId - String
stripePriceId - String
product - String
interval - String
status - String
Example
{
  "stripeSubscriptionId": "xyz789",
  "stripePriceId": "xyz789",
  "product": "xyz789",
  "interval": "abc123",
  "status": "xyz789"
}
Types

SubscriptionPaymentType

Fields
Field Name Description
id - ID!
subscription - SubscriptionType
product - ProductType
amount - Int!
gatewayFee - Int
currency - String!
date - DateTime!
status - String!
stripeInvoiceId - String
commission - Float
Example
{
  "id": 4,
  "subscription": SubscriptionType,
  "product": ProductType,
  "amount": 987,
  "gatewayFee": 987,
  "currency": "xyz789",
  "date": "2007-12-03T10:15:30Z",
  "status": "abc123",
  "stripeInvoiceId": "abc123",
  "commission": 123.45
}
Types

SubscriptionType

Fields
Field Name Description
id - ID!
user - UserType!
product - ProductType
price - PriceType
gateway - String
createdAt - DateTime!
validUntil - DateTime
status - String
statusUpdatedAt - DateTime
stripeSubscriptionId - String
subscriptionpaymentSet - [SubscriptionPaymentType!]!
Example
{
  "id": "4",
  "user": UserType,
  "product": ProductType,
  "price": PriceType,
  "gateway": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "validUntil": "2007-12-03T10:15:30Z",
  "status": "abc123",
  "statusUpdatedAt": "2007-12-03T10:15:30Z",
  "stripeSubscriptionId": "abc123",
  "subscriptionpaymentSet": [SubscriptionPaymentType]
}
Types

SubscriptionViewType

Fields
Field Name Description
id - ID!
user - UserType!
type - String!
stock - StockType
portfolio - PortfolioType
watchlist - WatchlistType
timestamp - DateTime!
Example
{
  "id": 4,
  "user": UserType,
  "type": "abc123",
  "stock": StockType,
  "portfolio": PortfolioType,
  "watchlist": WatchlistType,
  "timestamp": "2007-12-03T10:15:30Z"
}
Types

UnpaidInvoiceType

Fields
Field Name Description
clientSecret - String
product - String
amount - Int
currency - String
interval - String
Example
{
  "clientSecret": "xyz789",
  "product": "xyz789",
  "amount": 987,
  "currency": "xyz789",
  "interval": "xyz789"
}
Types

UpdatePortfolio

Fields
Field Name Description
success - Boolean
errors - [String]
portfolio - PortfolioType
Example
{
  "success": false,
  "errors": ["xyz789"],
  "portfolio": PortfolioType
}
Types

UpdateWatchlist

Fields
Field Name Description
success - Boolean
errors - [String]
Example
{"success": false, "errors": ["xyz789"]}
Types

UserType

Description

User type object

Fields
Field Name Description
id - ID!
email - String!
phoneNumber - String!
firstName - String!
lastName - String!
registeredAt - DateTime!
stripeCustomerId - String
referralId - String!
hasReferrals - Boolean
subscriptionData - SubscriptionDataType
Example
{
  "id": 4,
  "email": "xyz789",
  "phoneNumber": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "registeredAt": "2007-12-03T10:15:30Z",
  "stripeCustomerId": "abc123",
  "referralId": "xyz789",
  "hasReferrals": true,
  "subscriptionData": SubscriptionDataType
}
Types

WatchlistItemNode

Fields
Field Name Description
id - ID! The ID of the object
watchlist - WatchlistType!
stock - StockType
createdAt - DateTime!
Example
{
  "id": "4",
  "watchlist": WatchlistType,
  "stock": StockType,
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

WatchlistItemNodeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [WatchlistItemNodeEdge]! Contains the nodes in this connection.
Example
{
  "pageInfo": PageInfo,
  "edges": [WatchlistItemNodeEdge]
}
Types

WatchlistItemNodeEdge

Description

A Relay edge containing a WatchlistItemNode and its cursor.

Fields
Field Name Description
node - WatchlistItemNode The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": WatchlistItemNode,
  "cursor": "abc123"
}
Types

WatchlistItemsNode

Fields
Field Name Description
id - ID! The ID of the object
totalRating - Float
returnRating - Float
growthRating - Float
riskRating - Float
valuationRating - Float
technicalRating - Float
macroRating - Float
grossMarginsRating - Decimal
operatingMarginsRating - Decimal
ebitdaMarginsRating - Decimal
netProfitMarginsRating - Decimal
operationalEfficiencyRating - Decimal
returnOnAssetsRating - Decimal
returnOnCapitalRating - Decimal
returnOnEquityRating - Decimal
revenueGrowthRating - Decimal
earningsGrowthRating - Decimal
revenueGrowthConsistencyRating - Decimal
earningsGrowthConsistencyRating - Decimal
leverageRating - Decimal
liquidityRating - Decimal
interestCoverageRating - Decimal
cashFlowCoverageRating - Decimal
salesMultiplesRating - Decimal
ebitdaMultiplesRating - Decimal
earningsMultiplesRating - Decimal
bookValueMultiplesRating - Decimal
dividendYieldRating - Decimal
momentumRating - Decimal
trendRating - Decimal
volatilityRating - Decimal
volumeRating - Decimal
stock - StockType
date - Date!
Example
{
  "id": "4",
  "totalRating": 987.65,
  "returnRating": 123.45,
  "growthRating": 123.45,
  "riskRating": 987.65,
  "valuationRating": 123.45,
  "technicalRating": 987.65,
  "macroRating": 123.45,
  "grossMarginsRating": Decimal,
  "operatingMarginsRating": Decimal,
  "ebitdaMarginsRating": Decimal,
  "netProfitMarginsRating": Decimal,
  "operationalEfficiencyRating": Decimal,
  "returnOnAssetsRating": Decimal,
  "returnOnCapitalRating": Decimal,
  "returnOnEquityRating": Decimal,
  "revenueGrowthRating": Decimal,
  "earningsGrowthRating": Decimal,
  "revenueGrowthConsistencyRating": Decimal,
  "earningsGrowthConsistencyRating": Decimal,
  "leverageRating": Decimal,
  "liquidityRating": Decimal,
  "interestCoverageRating": Decimal,
  "cashFlowCoverageRating": Decimal,
  "salesMultiplesRating": Decimal,
  "ebitdaMultiplesRating": Decimal,
  "earningsMultiplesRating": Decimal,
  "bookValueMultiplesRating": Decimal,
  "dividendYieldRating": Decimal,
  "momentumRating": Decimal,
  "trendRating": Decimal,
  "volatilityRating": Decimal,
  "volumeRating": Decimal,
  "stock": StockType,
  "date": "2007-12-03"
}
Types

WatchlistItemsNodeConnection

Fields
Field Name Description
pageInfo - PageInfo! Pagination data for this connection.
edges - [WatchlistItemsNodeEdge]! Contains the nodes in this connection.
totalCount - Int
edgeCount - Int
averageRatings - GenericScalar
sectorCount - GenericScalar
industryCount - GenericScalar
id - Int
Example
{
  "pageInfo": PageInfo,
  "edges": [WatchlistItemsNodeEdge],
  "totalCount": 987,
  "edgeCount": 123,
  "averageRatings": GenericScalar,
  "sectorCount": GenericScalar,
  "industryCount": GenericScalar,
  "id": 123
}
Types

WatchlistItemsNodeEdge

Description

A Relay edge containing a WatchlistItemsNode and its cursor.

Fields
Field Name Description
node - WatchlistItemsNode The item at the end of the edge
cursor - String! A cursor for use in pagination
Example
{
  "node": WatchlistItemsNode,
  "cursor": "abc123"
}
Types

WatchlistItemsType

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

WatchlistType

Fields
Field Name Description
id - ID!
owner - UserType!
name - String!
description - String
private - Boolean!
createdAt - DateTime!
subscriptionviewSet - [SubscriptionViewType!]!
watchlistItems - WatchlistItemNodeConnection
Arguments
offset - Int
before - String
after - String
first - Int
last - Int
watchlist - ID
stock_Ticker - String
stock_Ticker_Icontains - String
stock_Name - String
stock_Name_Icontains - String
stockCount - Int
avgTotalRating - GenericScalar
Example
{
  "id": "4",
  "owner": UserType,
  "name": "abc123",
  "description": "xyz789",
  "private": true,
  "createdAt": "2007-12-03T10:15:30Z",
  "subscriptionviewSet": [SubscriptionViewType],
  "watchlistItems": WatchlistItemNodeConnection,
  "stockCount": 987,
  "avgTotalRating": GenericScalar
}
Documentation by Anvil SpectaQL