{"id":16564014,"url":"https://github.com/brndnmtthws/cgminer-rest","last_synced_at":"2025-09-06T11:45:23.788Z","repository":{"id":52362160,"uuid":"162054053","full_name":"brndnmtthws/cgminer-rest","owner":"brndnmtthws","description":"RESTful HTTP API wrapper for cgminer","archived":false,"fork":false,"pushed_at":"2021-04-30T13:16:37.000Z","size":9219,"stargazers_count":9,"open_issues_count":8,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-11T11:53:51.769Z","etag":null,"topics":["bitcoin-mining","cgminer","cgminer-api"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brndnmtthws.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-17T00:29:40.000Z","updated_at":"2024-08-12T19:44:06.000Z","dependencies_parsed_at":"2022-09-26T18:40:44.948Z","dependency_job_id":null,"html_url":"https://github.com/brndnmtthws/cgminer-rest","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brndnmtthws%2Fcgminer-rest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brndnmtthws%2Fcgminer-rest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brndnmtthws%2Fcgminer-rest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brndnmtthws%2Fcgminer-rest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brndnmtthws","download_url":"https://codeload.github.com/brndnmtthws/cgminer-rest/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221814971,"owners_count":16885086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin-mining","cgminer","cgminer-api"],"created_at":"2024-10-11T20:43:00.368Z","updated_at":"2024-10-28T10:05:10.269Z","avatar_url":"https://github.com/brndnmtthws.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/brndnmtthws/cgminer-rest.svg?branch=master)](https://travis-ci.org/brndnmtthws/cgminer-rest) [![Current Crates.io Version](https://img.shields.io/crates/v/cgminer-rest.svg)](https://crates.io/crates/cgminer-rest) [![Coverage Status](https://coveralls.io/repos/github/brndnmtthws/cgminer-rest/badge.svg?branch=master)](https://coveralls.io/github/brndnmtthws/cgminer-rest?branch=master) [![Dependabot Status](https://api.dependabot.com/badges/status?host=github\u0026repo=brndnmtthws/cgminer-rest)](https://dependabot.com)\n\n\n# cgminer-rest: a RESTful HTTP wrapper for the cgminer API\n\n![Demo](/demo.gif?raw=true)\n\nThis package provides a RESTful HTTP wrapper around the\n[cgminer](https://github.com/ckolivas/cgminer) API. Cgminer has a somewhat\nesoteric API, which isn't easy to use with standard HTTP-based tooling. Using\nthis tool, it's easy to interact with cgminer programmatically or using a UI,\nsuch as through a web browser.\n\n## Installing\n\nThe package can be installed from [crates.io](https://crates.io/) using the `cargo` tool:\n\n```ShellSession\n$ cargo install cgminer-rest\n...\n$ cgminer-rest\n```\n\nSee [`Rocket.toml`](Rocket.toml) for configuration details. Instructions on using `Rocket.toml` [can be found here](https://rocket.rs/v0.4/guide/configuration/#rockettoml).\n\n*Note: currently you must be running nightly rust. It is recommended that you use [rustup](https://github.com/rust-lang/rustup.rs) to manage your rust installation.*\n\n## Example\n\n## API\n\n### Endpoints\n\n    🛰  Mounting /:\n        =\u003e GET /version (version)\n        =\u003e GET /config (config)\n        =\u003e GET /summary (summary)\n        =\u003e GET /devs (devs)\n        =\u003e GET /devdetails (devdetails)\n        =\u003e GET /stats (stats)\n        =\u003e GET /coin (coin)\n        =\u003e GET /usbstats (usbstats)\n        =\u003e GET /lcd (lcd)\n        =\u003e GET /notify (notify)\n        =\u003e GET /privileged (privileged)\n        =\u003e PUT /restart (restart)\n        =\u003e PUT /check/\u003ccommand\u003e (check)\n        =\u003e PUT /debug (debug)\n        =\u003e PUT /hotplug (hotplug)\n        =\u003e GET /lockstats (lockstats)\n        =\u003e PUT /zero (zero)\n    🛰  Mounting /pools:\n        =\u003e GET /pools (pools)\n        =\u003e PUT /pools/\u003cid\u003e/switchto (switchpool)\n        =\u003e PUT /pools/\u003cid\u003e/enable (enablepool)\n        =\u003e PUT /pools/\u003cid\u003e/disable (disablepool)\n        =\u003e POST /pools (addpool)\n        =\u003e DELETE /pools/\u003cid\u003e (removepool)\n        =\u003e PUT /pools/\u003cid\u003e/quota (poolquota)\n    🛰  Mounting /pga:\n        =\u003e GET /pga/\u003cid\u003e (pga)\n        =\u003e GET /pga/count (pgacount)\n        =\u003e PUT /pga/\u003cid\u003e/enable (pgaenable)\n        =\u003e PUT /pga/\u003cid\u003e/disable (pgadisable)\n        =\u003e GET /pga/\u003cid\u003e/identify (pgaidentify)\n        =\u003e PUT /pga/\u003cid\u003e (pgaset)\n    🛰  Mounting /asc:\n        =\u003e GET /asc/\u003cid\u003e (asc)\n        =\u003e GET /asc/count (asccount)\n        =\u003e PUT /asc/\u003cid\u003e/enable (ascenable)\n        =\u003e PUT /asc/\u003cid\u003e/disable (ascdisable)\n        =\u003e GET /asc/\u003cid\u003e/identify (ascidentify)\n        =\u003e PUT /asc/\u003cid\u003e (ascset)\n\n## Project Goals\n\nThe goal of this project is to create a high quality API for working with\ncgminer-based ASICs, in order to enable development of better tooling for\nBitcoin mining (such as [dragon-rest](https://github.com/brndnmtthws/dragon-rest) and [mother-of-dragons](https://github.com/brndnmtthws/mother-of-dragons)).\n\nIf ASIC vendors adopt one canonical API for mining hardware, it will become\nmuch easier to build tooling that works well with many different types of\nmining hardware. Nearly all ASIC vendors already use cgminer underneath,\nhowever the cgminer API is esoteric and somewhat difficult to work with\ncompared to HTTP.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrndnmtthws%2Fcgminer-rest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrndnmtthws%2Fcgminer-rest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrndnmtthws%2Fcgminer-rest/lists"}