For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference pools.v1 PoolsService

CreatePool

||View as Markdown|

Example request

1 {
2   "pool_config": {
3     "url": "example",
4     "username": "example",
5     "password": {
6       "value": "example"
7     },
8     "pool_name": "example"
9   }
10 }

Example response

1 {
2   "pool": {
3     "pool_id": 42,
4     "url": "example",
5     "username": "example",
6     "pool_name": "example"
7   }
8 }

Creates a new mining pool configuration

CreatePoolRequest

Request

This endpoint expects an object.

pool_configobject

Pool configuration details for the new pool Must contain all required connection information

CreatePoolResponse

Response

This endpoint returns an object.

poolobject

The newly created pool with system-assigned ID and default values