Minerstat API reference

New to Corsair? See API access, authentication, and error handling.

Algorithms

get

algorithms.get Get one algorithm with its coins and benchmarked hardware Risk: read

await corsair.minerstat.api.algorithms.get({ slug: 'sha-256' });

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`algorithm`	`object`	Yes	—

algorithm full type

{
  slug: string,
  name: string,
  unit: string,
  coins: {
    slug: string,
    symbol: string,
    name?: string,
    algorithm?: string,
    networkHashrate?: number | null,
    difficulty?: number | null,
    blockReward?: number | null,
    blockTimeSeconds?: number | null,
    priceUsd?: number | null,
    marketCapUsd?: number | null,
    volume24hUsd?: number | null,
    confidence?: number | null,
    dataUpdatedAt?: string | null
  }[],
  hardware: {
    slug: string,
    name: string,
    type: ASIC | GPU | CPU | FPGA | string,
    hashrateHs: number,
    powerWatts: number | null
  }[]
}

list

algorithms.list List mining algorithms with coin counts Risk: read

await corsair.minerstat.api.algorithms.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`generatedAt`	`string`	No	—
`offset`	`number`	No	—
`limit`	`number`	No	—
`count`	`number`	Yes	—
`results`	`object[]`	Yes	—
`notice`	`string`	No	—

results full type

{
  slug: string,
  name: string,
  unit: string,
  coins: number
}[]

Coins

get

coins.get Get one coin by slug, with identity and supply fields Risk: read

await corsair.minerstat.api.coins.get({ slug: 'btc' });

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`generatedAt`	`string`	Yes	—
`dataUpdatedAt`	`string \| null`	Yes	—
`confidence`	`number`	Yes	—
`coin`	`object`	Yes	—

coin full type

{
  slug: string,
  symbol: string,
  name?: string,
  algorithm?: string,
  networkHashrate?: number | null,
  difficulty?: number | null,
  blockReward?: number | null,
  blockTimeSeconds?: number | null,
  priceUsd?: number | null,
  marketCapUsd?: number | null,
  volume24hUsd?: number | null,
  confidence?: number | null,
  dataUpdatedAt?: string | null,
  website: string | null,
  explorerUrl: string | null,
  consensusType: string | null,
  coinType: coin | pool | string,
  circulatingSupply: number | null,
  maxSupply: number | null
}

history

coins.history List network snapshots for one coin, newest first Risk: read

await corsair.minerstat.api.coins.history({ slug: 'btc' });

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`coin`	`string`	Yes	—
`symbol`	`string`	Yes	—
`offset`	`number`	Yes	—
`limit`	`number`	Yes	—
`count`	`number`	Yes	—
`results`	`object[]`	Yes	—

results full type

{
  t: string,
  difficulty: number | null,
  networkHashrate: number | null
}[]

list

coins.list List mineable coins with network, price and confidence data Risk: read

await corsair.minerstat.api.coins.list({});

Input

Name	Type	Required	Description
`algorithm`	`string`	No	—
`verified`	`boolean`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`generatedAt`	`string`	No	—
`offset`	`number`	Yes	—
`limit`	`number`	Yes	—
`count`	`number`	Yes	—
`results`	`object[]`	Yes	—
`notice`	`string`	No	—

results full type

{
  slug: string,
  symbol: string,
  name?: string,
  algorithm?: string,
  networkHashrate?: number | null,
  difficulty?: number | null,
  blockReward?: number | null,
  blockTimeSeconds?: number | null,
  priceUsd?: number | null,
  marketCapUsd?: number | null,
  volume24hUsd?: number | null,
  confidence?: number | null,
  dataUpdatedAt?: string | null
}[]

Hardware

get

hardware.get Get one hardware device by slug, with its spec sheet Risk: read

await corsair.minerstat.api.hardware.get({ slug: 'nvidia-geforce-rtx-4090' });

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`hardware`	`object`	Yes	—

hardware full type

{
  slug: string,
  name: string,
  manufacturer: string,
  type: ASIC | GPU | CPU | FPGA | string,
  defaultPowerWatts: number | null,
  releaseDate: string | null,
  specs: string[]
}

list

hardware.list List mining hardware (ASIC, GPU, CPU, FPGA) Risk: read

await corsair.minerstat.api.hardware.list({});

Input

Name	Type	Required	Description
`type`	`ASIC \| GPU \| CPU \| FPGA`	No	—
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`generatedAt`	`string`	No	—
`offset`	`number`	Yes	—
`limit`	`number`	Yes	—
`count`	`number`	Yes	—
`results`	`object[]`	Yes	—
`notice`	`string`	No	—

results full type

{
  slug: string,
  manufacturer: string,
  model: string,
  type: ASIC | GPU | CPU | FPGA | string,
  powerWatts: number | null,
  releaseDate: string | null
}[]

Pools

get

pools.get Get one pool with per-coin fees and payout schemes Risk: read

await corsair.minerstat.api.pools.get({ slug: 'f2pool' });

Input

Name	Type	Required	Description
`slug`	`string`	Yes	—

Output

Name	Type	Required	Description
`pool`	`object`	Yes	—

pool full type

{
  slug: string,
  name: string,
  website: string | null,
  type?: string,
  founded: string | null,
  coins: {
    coin: string,
    symbol: string,
    algorithm: string,
    fee: number | null,
    payoutScheme: string | null,
    minPayout: number | null
  }[]
}

list

pools.list List mining pools with fees and liveness Risk: read

await corsair.minerstat.api.pools.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—

Output

Name	Type	Required	Description
`generatedAt`	`string`	No	—
`offset`	`number`	Yes	—
`limit`	`number`	Yes	—
`count`	`number`	Yes	—
`results`	`object[]`	Yes	—
`notice`	`string`	No	—

results full type

{
  slug: string,
  name: string,
  website: string | null,
  type?: string,
  defaultFee: number | null,
  coins: number,
  lastOkAt: string | null
}[]

Profitability

rank

profitability.rank Rank coins by mining profit for hardware or a hashrate (Enterprise plan) Risk: read

await corsair.minerstat.api.profitability.rank({ hardware: 'nvidia-geforce-rtx-4090', electricity: 0.1 });

Input

Name	Type	Required	Description
`hardware`	`string`	No	—
`hashrate`	`number`	No	—
`algorithm`	`string`	No	—
`power`	`number`	No	—
`quantity`	`number`	No	—
`electricity`	`number`	No	—
`poolFee`	`number`	No	—
`verifiedOnly`	`boolean`	No	—
`limit`	`number`	No	—
`window`	`current \| 6h \| 24h \| 3d`	No	—

Requires the Enterprise plan. Use hardware for preset mode, or hashrate and algorithm for manual mode. Output

Name	Type	Required	Description
`hardware`	`object \| null`	Yes	—
`electricityPrice`	`number`	Yes	—
`currency`	`string`	Yes	—
`results`	`object[]`	Yes	—

hardware full type

{
  slug: string,
  name: string
} | null

results full type

{
  coin: {
    slug: string,
    symbol: string,
    name?: string,
    algorithm: string
  },
  coinsPerDay: number,
  revenuePerDay: number,
  electricityPerDay: number,
  profitPerDay: number,
  profitMargin: number | null,
  breakEvenElectricityPrice: number | null,
  confidenceScore: number
}[]

Overview

Plugins

Minerstat API reference

Algorithms

get

list

Coins

get

history

list

Hardware

get

list

Pools

get

list

Profitability

rank