# Nonce

> Nonce documentation — guides, API reference, and concepts for managing Bitcoin mining farms, miner fleets, pools, and hashrate at scale.

## Docs

- [Actor](https://docs.nonce.app/api-guide/actor.md): Understanding the actor concept for tracking who performs actions
- [Authentication](https://docs.nonce.app/api-guide/authentication.md): Learn how to authenticate your API requests
- [Concepts](https://docs.nonce.app/api-guide/concepts.md): Key terminology and concepts in Nonce
- [Nonce API](https://docs.nonce.app/api-guide/index.md): Private API documentation for Nonce mining management platform
- [MCP Integration](https://docs.nonce.app/api-guide/mcp/index.md): Connect AI assistants to Nonce through Model Context Protocol
- [Permissions](https://docs.nonce.app/api-guide/mcp/permissions.md): MCP tools follow the same role-based permissions as the Nonce app
- [Available Tools](https://docs.nonce.app/api-guide/mcp/tools.md): MCP tools for managing mining operations through AI assistants
- [Rate Limits](https://docs.nonce.app/api-guide/rate-limits.md): API rate limiting information
- [Tasks](https://docs.nonce.app/api-guide/tasks.md): Understanding tasks, task batches, and task parameters in Nonce
- [List Granted Farm Metrics](https://docs.nonce.app/api-reference/private-api--cross-org/list-granted-farm-metrics.md)
- [List Granted Miners](https://docs.nonce.app/api-reference/private-api--cross-org/list-granted-miners.md)
- [Create Task Batch](https://docs.nonce.app/api-reference/private-api/create-task-batch.md): Create a batch task for specified miners with given task type and parameters. Only supports agent specific tasks
- [Get Current Workspace](https://docs.nonce.app/api-reference/private-api/get-current-workspace.md): Returns workspace information for the authenticated API key
- [Get Task Batch](https://docs.nonce.app/api-reference/private-api/get-task-batch.md): Returns the status and results of a task batch
- [List Agents](https://docs.nonce.app/api-reference/private-api/list-agents.md): Returns agents associated with the workspace
- [List Farms](https://docs.nonce.app/api-reference/private-api/list-farms.md): Returns farm information associated with the workspace. The information includes farm ID and name
- [List History](https://docs.nonce.app/api-reference/private-api/list-history.md): Returns historical performance data for a specific miner
- [List Metrics History](https://docs.nonce.app/api-reference/private-api/list-metrics-history.md): Returns historical farm metrics data, provides day-level granularity metrics includes hashrate, online miners and BTC earnings
- [List Miner Tasks](https://docs.nonce.app/api-reference/private-api/list-miner-tasks.md): Returns task history for a specific miner
- [List Miners](https://docs.nonce.app/api-reference/private-api/list-miners.md): Returns real-time mining status for all miners in the specified farm. The information includes hashrate, power consumption, temperature, mining status, hardware details, and error information
- [List My Grants](https://docs.nonce.app/api-reference/private-api/list-my-grants.md): Returns active authorization grants where the authenticated workspace is the grantee
- [List Pool Diffs](https://docs.nonce.app/api-reference/private-api/list-pool-diffs.md): Returns historical miner pool record if any diff detected
- [List Task Batches](https://docs.nonce.app/api-reference/private-api/list-task-batches.md): Returns a paginated list of task batches for the specified farm
- [Search Agents](https://docs.nonce.app/api-reference/private-api/search-agents.md): Search agents in the workspace with operator-object filters. Returns paginated agents filtered by optional farm_id / status criteria. Omit body for an unfiltered first-page list.
- [Search Miners](https://docs.nonce.app/api-reference/private-api/search-miners.md): Search miners in the farm with operator-object filters. Supports agent_id, sn, mac, and lifecycle_statuses criteria. `health_statuses` is deprecated — still accepted in the body for backward compatibility but ignored at runtime. Omit body for an unfiltered first-page list.
- [Search Task Batches](https://docs.nonce.app/api-reference/private-api/search-task-batches.md): Search task batches in the farm with operator-object filters. Supports status, task_name, actor_type, and created_at criteria. Omit body for an unfiltered first-page list.
- [Agent Hardware Requirements](https://docs.nonce.app/user-guide/agent-hardware-requirements.md): Minimum hardware specifications for running Nonce Agent at different scales
- [How Agent Scan Works](https://docs.nonce.app/user-guide/agent-scan-mechanism.md): Understand the Nonce Agent scan flow, expected timing, and the main factors that affect scan duration
- [Agent Scan Troubleshooting](https://docs.nonce.app/user-guide/agent-scan-troubleshooting.md): Troubleshoot cases where the Agent is installed but miner data does not appear
- [FAQ](https://docs.nonce.app/user-guide/faq.md): Frequently asked questions about Nonce
- [Create a Farm](https://docs.nonce.app/user-guide/onboarding/create-a-farm.md): Overview of the farm setup sub-steps in the setup wizard
- [Add Pool Observer Data (Optional)](https://docs.nonce.app/user-guide/onboarding/create-a-farm-add-pool-observer-data.md): Configure observer URL and primary pool records for pool-side validation
- [Enter Farm Basic Information](https://docs.nonce.app/user-guide/onboarding/create-a-farm-enter-basic-information.md): Configure farm name, region, and optional cost metadata
- [Scan Network to Discover Miners](https://docs.nonce.app/user-guide/onboarding/create-a-farm-scan-network-to-discover-miners.md): Add IP ranges and run discovery tasks to import miners into the farm
- [Select Miner Model and Quantity](https://docs.nonce.app/user-guide/onboarding/create-a-farm-select-miner-model-and-quantity.md): Add miner model, quantity, and efficiency values for farm estimation
- [Create a Workspace](https://docs.nonce.app/user-guide/onboarding/create-a-workspace.md): Create your first workspace to organize farms, miners, and Agents
- [Overview](https://docs.nonce.app/user-guide/onboarding/index.md): Overview of the getting started steps for your first workspace, farm, and miners
- [Install Nonce Agent](https://docs.nonce.app/user-guide/onboarding/install-nonce-agent.md): Install Nonce Agent on a Linux host and verify connectivity before miner discovery
- [Log in to Nonce](https://docs.nonce.app/user-guide/onboarding/log-in-to-nonce.md): Sign in to nonce.app to begin onboarding
- [Next Steps](https://docs.nonce.app/user-guide/onboarding/next-steps.md): Finish onboarding with team setup, farm expansion, and common troubleshooting references
- [View Farm Overview](https://docs.nonce.app/user-guide/onboarding/view-farm-overview.md): Review telemetry, miner status, and profitability after setup
- [Overclock/Underclock](https://docs.nonce.app/user-guide/operations/automation.md): Temperature-driven automatic power mode switching
- [Fan Abnormal](https://docs.nonce.app/user-guide/operations/fan-abnormal.md): Fan abnormality criteria and query method (coming soon)
- [Firmware](https://docs.nonce.app/user-guide/operations/firmware.md): Batch upgrade miner firmware
- [Overview](https://docs.nonce.app/user-guide/operations/index.md): Query problem miners, batch operations, overclock/underclock automation—operations handbook
- [Light](https://docs.nonce.app/user-guide/operations/light.md): Locate physical miner by flashing the indicator light
- [Low Hashrate](https://docs.nonce.app/user-guide/operations/low-hashrate.md): Select Low Hashrate status tag to query
- [Multiple Filters](https://docs.nonce.app/user-guide/operations/more.md): Combine filter conditions to locate problem miners
- [Offline](https://docs.nonce.app/user-guide/operations/offline.md): Select Offline in Status panel to locate offline miners
- [Overheated](https://docs.nonce.app/user-guide/operations/overheated.md): Locate overheated miners via Temperature panel or Overheated tag
- [Pool](https://docs.nonce.app/user-guide/operations/pool.md): Batch modify pool connections
- [Power](https://docs.nonce.app/user-guide/operations/power.md): Switch power mode: overclock, underclock, sleep, normal
- [Reboot](https://docs.nonce.app/user-guide/operations/reboot.md): Batch reboot miners
- [Scan](https://docs.nonce.app/user-guide/operations/scan.md): Manual and automatic scanning to add new miners to Nonce
- [Zero Hashrate](https://docs.nonce.app/user-guide/operations/zero-hashrate.md): Locate zero hashrate miners via Hashrate panel
- [Common Scenarios](https://docs.nonce.app/user-guide/permissions/common-scenarios.md): Choose the right role and farm scope for typical collaboration patterns
- [4 Concepts You Need First](https://docs.nonce.app/user-guide/permissions/core-concepts.md): Separate accounts, workspaces, roles, and farm scope before you go deeper
- [FAQ](https://docs.nonce.app/user-guide/permissions/faq.md): Troubleshoot missing pages, disabled buttons, and role changes that seem delayed
- [Permissions Overview](https://docs.nonce.app/user-guide/permissions/index.md): Understand accounts, roles, and farm scope in the simplest possible way
- [Invite Members and Assign Farms](https://docs.nonce.app/user-guide/permissions/invite-members-and-assign-farms.md): Grant access to new members in the safest order
- [Permission Matrix](https://docs.nonce.app/user-guide/permissions/permission-matrix.md): Compare Admin, Manager, Member, and Viewer across page visibility and allowed actions
- [Role Overview](https://docs.nonce.app/user-guide/permissions/role-overview.md): Decide whether someone should be Admin, Manager, Member, or Viewer
- [Supported Miners and Firmware](https://docs.nonce.app/user-guide/supported-miners-and-firmware.md): Compatible miner models and firmware versions supported by Nonce

## OpenAPI Specs

- [openapi](https://docs.nonce.app/api-reference/openapi.json)