API Docs
Objects

Objects

Miner

type Miner implements Node {
  id: ID!
  rowId: Int!
  updatedAt: Datetime!
  createdAt: Datetime!
  userId: Int!
  workerName: String!
  miningProfileName: MiningProfileName!
  deleted: Boolean
  user: User
  details1H: MinerDetail
  details24H: MinerDetail
  details(duration: IntervalInput!): MinerDetail
  workerTags(first: Int = 0, last: Int = 0, offset: Int = 0, before: Cursor, after: Cursor): TagSummariesConnection!
}
Fields
  • id (ID!) A globally unique identifier. Can be used in various places throughout the system to identify this single value.

  • rowId (Int!) Unique ID of the miner

  • updatedAt (Datetime!) Date and time when the miner was last updated.

  • createdAt (Datetime!) Date and time when the miner was originally created

  • userId (Int!) ID of the user for the miner

  • workerName (String!) Worker name

  • miningProfileName (MiningProfileName!) Coin name

    enum MiningProfileName {
      ARRR
      BTC
      DASH
      DCR
      KMD
      LBC
      SC
      SCP
      ZEC
      ZEN
      EQUI
      TBTC
      ETH
      TETH
    }
  • deleted (Boolean) Identifies if the miner is soft deleted

  • user (User) Reads a single User that is related to this Miner.

  • details1H (MinerDetail) Retrieves a worker details within an hour interval

  • details24H (MinerDetail) Retrieves a worker details within 24hr interval

  • details (MinerDetail) Gets workers details.

    • duration (IntervalInput!)

      type IntervalInput {
        seconds: Float
        minutes: Int
        hours: Int
        days: Int
        months: Int
        years: Int
      }
  • workerTags (TagSummariesConnection!) Reads and enables pagination through a set of TagSummary.

    • first (Int) Only read the first n values of the set.

    • last (Int) Only read the last n values of the set.

    • offset (Int) Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.

    • before (Cursor) Read all values in the set before (above) this cursor.

    • after (Cursor) Read all values in the set after (below) this cursor.

Interfaces

  • Node An object with a globally unique ID.

User

Public user information. Each user represents a stratum miner username.

type User implements Node {
  id: ID!
  rowId: Int!
  username: String!
  createdAt: Datetime!
  updatedAt: Datetime!
  miners(
    first: Int = 0
    last: Int = 0
    offset: Int = 0
    before: Cursor
    after: Cursor
    orderBy: [MinersOrderBy!] = [PRIMARY_KEY_ASC]
    condition: MinerCondition
    filter: MinerFilter
    includeArchived: IncludeArchivedOption = "NO"
  ): MinersConnection!
}
Fields
  • id (ID!) A globally unique identifier. Can be used in various places throughout the system to identify this single value.

  • rowId (Int!)

  • username (String!) The mining address of the user

  • createdAt (Datetime!)

  • updatedAt (Datetime!)

  • miners (MinersConnection!) Reads and enables pagination through a set of Miner.

    • first (Int) Only read the first n values of the set.

    • last (Int) Only read the last n values of the set.

    • offset (Int) Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.

    • before (Cursor) Read all values in the set before (above) this cursor.

    • after (Cursor) Read all values in the set after (below) this cursor.

    • orderBy (MinersOrderBy!) The method to use when ordering Miner.

      enum MinersOrderBy {
      NATURAL
      ID_ASC
      ID_DESC
      USER_ID_ASC
      USER_ID_DESC
      MINING_PROFILE_NAME_ASC
      MINING_PROFILE_NAME_DESC
      PRIMARY_KEY_ASC
      PRIMARY_KEY_DESC
      }
    • condition (MinerCondition) A condition to be used in determining which values should be returned by the collection.

      type MinerCondition {
      rowId: Int
      userId: Int
      miningProfileName: MiningProfileName
      }
       
    • filter (MinerFilter) A filter to be used in determining which values should be returned by the collection.

    • includeArchived (IncludeArchivedOption) Indicates whether archived items should be included in the results or not.

      enum IncludeArchivedOption {
        NO
        YES
        EXCLUSIVELY
        INHERIT
      }

MinerDetail

type MinerDetail {
  updatedAt: Datetime
  status: String
  hashrate: BigFloat
  validShares: BigInt
  staleShares: BigInt
  invalidShares: BigInt
  lowDiffShares: BigInt
  badShares: BigInt
  duplicateShares: BigInt
  revenue: BigFloat
  efficiency: BigFloat
}
Fields
  • updatedAt (Datetime) Date and time when the object was last updated

  • status (String) Represents the status of the miner can be Active, Warning, Dead

  • hashrate (BigFloat) Hashrate of a miner, it could variate based on the interval given

  • validShares (BigInt) Valid shares of a miner, it could variate based on the interval given

  • staleShares (BigInt) Stale shares of a miner, it could variate based on the interval given

  • invalidShares (BigInt) Invalid shares of a miner, it could variate based on the interval given

  • lowDiffShares (BigInt) Low diff shares of a miner, it could variate based on the interval given

  • badShares (BigInt) Bad shares of a miner, it could variate based on the interval given

  • duplicateShares (BigInt) Duplicate shares of a miner, it could variate based on the interval given

  • revenue (BigFloat) Revenue of a miner, it could variate based on the interval given

  • efficiency (BigFloat) Efficiency of a miner, it could variate based on the interval given

TagSummariesConnection

A connection to a list of TagSummary values.

type TagSummariesConnection {
  nodes: [TagSummary!]!
  edges: [TagSummariesEdge!]!
  pageInfo: PageInfo!
  totalCount: Int!
}
Fields
  • nodes ([TagSummary!]!)

A list of TagSummary objects.

type TagSummary {
  rowId: Int
  name: String
  color: String
  tagType: TagType
}
enum TagType {
  WORKER
}
  • edges ([TagSummariesEdge!]!)

A list of edges which contains the TagSummary and cursor to aid in pagination.

type TagSummariesEdge {
  cursor: Cursor
  node: TagSummary!
}
  • pageInfo (PageInfo!) Information to aid in pagination.

    type PageInfo {
      hasNextPage: Boolean!
      hasPreviousPage: Boolean!
      startCursor: Cursor
      endCursor: Cursor
    }
  • totalCount (Int!) The count of all TagSummary you could get from the connection.

MinersConnection

A connection to a list of Miner values.

type MinersConnection {
  nodes: [Miner!]!
  edges: [MinersEdge!]!
  pageInfo: PageInfo!
  totalCount: Int!
}
Fields
  • nodes ([Miner!]!) A list of Miner objects.

  • edges ([MinersEdge!]!)

A list of edges which contains the Miner and cursor to aid in pagination.

type MinersEdge {
  cursor: Cursor
  node: Miner!
}
Fields
  • cursor (Cursor) A cursor for use in pagination.

  • node (Miner!) The Miner at the end of the edge.

  • pageInfo (PageInfo!) Information to aid in pagination.

    type PageInfo {
      hasNextPage: Boolean!
      hasPreviousPage: Boolean!
      startCursor: Cursor
      endCursor: Cursor
    }
  • totalCount (Int!) The count of all Miner you could get from the connection.

Wallet

The public wallet type exposed to end users

type Wallet implements Node {
  id: ID!
  rowId: Int!
  address: String
  paymentIntervalHours: Int
  paymentThreshold: Float
  currencyProfileName: CurrencyProfileName!
  isFrozen: Boolean
  pendingBalance: BigFloat
  remainingFreezingTime: Float
}
Fields
  • id (ID!) A globally unique identifier. Can be used in various places throughout the system to identify this single value.

  • rowId (Int!)

  • address (String) Wallet address

  • paymentIntervalHours (Int) Wallet payment interval in hours

  • paymentThreshold (Float) Wallet payment threshold

  • currencyProfileName (CurrencyProfileName!) Wallet coin name

    enum CurrencyProfileName {
      ARRR
      BTC
      DASH
      DCR
      KMD
      LBC
      SC
      SCP
      ZEC
      ZEN
      USD
      TBTC
      ETH
      TETH
      USDT
    }
  • isFrozen (Boolean)

  • pendingBalance (BigFloat) Represents the pending amount for payment

  • remainingFreezingTime (Float)

Interfaces

  • Node An object with a globally unique ID.