> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Minerstat

The Minerstat connector lets your AI agent act in each user's Minerstat account. Each user connects their own Minerstat API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 10 tools.

**Authentication:** API Key
**Categories:** Analytics
**Tools:** 10: 10 read, 0 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=MINERSTAT)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Minerstat connection

   In **AgentKit > Connections**, create a Minerstat connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'minerstat'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Minerstat:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'minerstat_algorithms_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "minerstat"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Minerstat:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="minerstat_algorithms_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Minerstat credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'minerstat_algorithm_get',
  toolInput: {
    slug: '<slug>',
  },
  connector: 'minerstat',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="minerstat_algorithm_get",
    tool_input={
        "slug": "<slug>",
    },
    connection_name="minerstat",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `minerstat_algorithm_get`

Get Algorithm · Read-only

Get one mining algorithm by slug, with the coins that use it and the hardware that supports it.
Returns the algorithm with its coins[] and hardware[] lists.
Use this when you know the algorithm slug. Use List Algorithms to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `slug` (`string`, required): Minerstat algorithm slug, from List Algorithms. Example: sha256.

Example input: `{"slug":"<slug>"}`

### `minerstat_algorithms_list`

List Algorithms · Read-only

List proof-of-work mining algorithms.
Returns results[] with each algorithm's slug, name and counts of coins and hardware benchmarks.
Use this to find an algorithm slug. Use Get Algorithm for its coins and hardware.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum algorithms to return. Capped by plan: 20 on Free, 500 on Developer, 1,000 on Enterprise. Example: 50.
- `offset` (`integer`, optional): Rows to skip, for paging together with limit. Example: 50.

Example input: `{}`

### `minerstat_coin_get`

Get Coin · Read-only

Get one coin by slug, with every list field plus website, block explorer, consensus type and supply.
Returns generatedAt, dataUpdatedAt, confidence and a coin object.
Use this when you know the coin slug. Use List Coins to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `slug` (`string`, required): Minerstat coin slug, from List Coins. Example: bitcoin.

Example input: `{"slug":"<slug>"}`

### `minerstat_coin_history_list`

List Coin History · Read-only

List historical network snapshots for one coin, newest first, up to 100 points per call.
Returns snapshots with network hashrate, difficulty, reward and price over time.
Use this for trends. Use Get Coin for the current values.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `slug` (`string`, required): Minerstat coin slug, from List Coins. Example: bitcoin.
- `limit` (`integer`, optional): Points to return, up to 100 (Free plan: 20). Example: 30.
- `offset` (`integer`, optional): Points to skip, for paging. Example: 30.

Example input: `{"slug":"<slug>"}`

### `minerstat_coins_list`

List Coins · Read-only

List active mineable coins with market, network and data-freshness fields, optionally filtered by algorithm.
Returns results[] with slug, symbol, name, algorithm, networkHashrate, difficulty, reward, price and confidence, plus offset, limit and count.
Use this to find a coin slug. Use Get Coin for one coin's full details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `algorithm` (`string`, optional): Algorithm slug to filter by, from List Algorithms. Example: scrypt.
- `limit` (`integer`, optional): Maximum coins to return. Capped by plan: 20 on Free, 500 on Developer, 1,000 on Enterprise. Example: 50.
- `offset` (`integer`, optional): Rows to skip, for paging together with limit. Example: 50.
- `verified` (`boolean`, optional): Set true to return only coins with a confidence score of 70 or more. Example: true.

Example input: `{}`

### `minerstat_hardware_get`

Get Hardware · Read-only

Get one mining device by slug, with release info and the full manufacturer spec sheet.
Returns a hardware object with slug, name, manufacturer, type, releaseDate, defaultPowerWatts and specs[].
Use this when you know the hardware slug. Use List Hardware to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `slug` (`string`, required): Minerstat hardware slug, from List Hardware. Example: nvidia-geforce-rtx-4090.

Example input: `{"slug":"<slug>"}`

### `minerstat_hardware_list`

List Hardware · Read-only

List mining hardware in the Minerstat catalog, optionally filtered by type.
Returns results[] with slug, name, manufacturer, type, power and release date.
Use this to find a hardware slug. Use Get Hardware for one device's specs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum devices to return. Capped by plan: 20 on Free, 500 on Developer, 1,000 on Enterprise. Example: 50.
- `offset` (`integer`, optional): Rows to skip, for paging together with limit. Example: 50.
- `type` (`string`, optional): Hardware type: ASIC, GPU, CPU or FPGA. Example: GPU. One of: `ASIC`, `GPU`, `CPU`, `FPGA`.

Example input: `{}`

### `minerstat_pool_get`

Get Pool · Read-only

Get one mining pool by slug, with per-coin fees, payout schemes and minimum payouts.
Returns the pool object with its per-coin entries.
Use this when you know the pool slug. Use List Pools to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `slug` (`string`, required): Minerstat pool slug, from List Pools. Example: f2pool.

Example input: `{"slug":"<slug>"}`

### `minerstat_pools_list`

List Pools · Read-only

List mining pools with fees, payout schemes and liveness.
Returns results[] with slug, name, website, defaultFee and coin counts.
Use this to find a pool slug. Use Get Pool for per-coin fees and minimum payouts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum pools to return. Capped by plan: 20 on Free, 500 on Developer, 1,000 on Enterprise. Example: 50.
- `offset` (`integer`, optional): Rows to skip, for paging together with limit. Example: 50.

Example input: `{}`

### `minerstat_profitability_list`

List Profitability · Read-only

Rank coins by expected mining profit for a device (preset mode: hardware) or your own hashrate (manual mode: hashrate, algorithm and power), given an electricity price.
Returns results[] with coin, coinsPerDay, revenuePerDay, electricityPerDay, profitPerDay and profitMargin, all in USD.
Use this to decide what to mine. Needs a Minerstat Enterprise plan; other plans are refused.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `algorithm` (`string`, optional): Manual mode: algorithm slug of the hashrate, from List Algorithms. Example: etchash.
- `electricity` (`number`, optional): Electricity price in USD per kWh (default 0.10). Example: 0.08.
- `hardware` (`string`, optional): Hardware slug for preset mode, from List Hardware. Leave empty and use hashrate, algorithm and power for manual mode. Example: nvidia-geforce-rtx-4090.
- `hashrate` (`number`, optional): Manual mode: your hashrate in hashes per second (H/s), together with algorithm. Example: 120000000.
- `limit` (`integer`, optional): Maximum results, up to 100 (default 25). Example: 10.
- `pool_fee` (`number`, optional): Pool fee as a fraction of revenue, 0 to 0.2. Example: 0.01 for 1%.
- `power` (`number`, optional): Manual mode: power draw in watts. Example: 300.
- `quantity` (`integer`, optional): Number of devices (default 1). Example: 4.
- `verified_only` (`boolean`, optional): Set true to rank only high-confidence coins. Example: true.
- `window` (`string`, optional): Reward basis: current (default), 6h, 24h or 3d, averaging revenue per hash over that window. Example: 24h. One of: `current`, `6h`, `24h`, `3d`.

Example input: `{}`

## Related

Other Analytics connectors ([all 177](/agentkit/connectors/?category=analytics)):

- [Google Sheets](/agentkit/connectors/googlesheets/): Scalekit connector, OAuth, 48 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [AWS Redshift](/agentkit/connectors/redshift/): Scalekit connector, Trusted identity provider, 10 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
