{"id":22362998,"url":"https://github.com/mining-pool/mining-pool-api","last_synced_at":"2026-03-19T22:34:12.950Z","repository":{"id":119755992,"uuid":"242524982","full_name":"mining-pool/mining-pool-api","owner":"mining-pool","description":"Documents for unifying API on mining pool softwares (for different daemons). ","archived":false,"fork":false,"pushed_at":"2020-06-14T14:19:33.000Z","size":5,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T15:17:37.659Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mining-pool.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-23T13:47:23.000Z","updated_at":"2023-05-26T20:47:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"90d72326-57de-43bb-a121-8aaac1c72837","html_url":"https://github.com/mining-pool/mining-pool-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mining-pool/mining-pool-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fmining-pool-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fmining-pool-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fmining-pool-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fmining-pool-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mining-pool","download_url":"https://codeload.github.com/mining-pool/mining-pool-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining-pool%2Fmining-pool-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266913680,"owners_count":24005579,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-12-04T17:13:00.817Z","updated_at":"2026-03-19T22:34:07.908Z","avatar_url":"https://github.com/mining-pool.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Design\n\n## Objects\n\nmigrated to [objects page](./objects.md)\n\n## Paths\n\n### Path `/`\n\nGET\n\nfetch a table about all paths' status (available or not)\n\n```javascript\n{\n    \"path1\": true, // response of path1\n    \"path2\": false, // response of path2\n                 // ...\n    \"pathN\": {}, // response of pathN\n}\n```\n\n### Path `/config`\n\nmigrated to [config page](./config.md)\n\n### Path `/pool`\n\nmigrated to [pool page](./pool.md)\n\n### Path `/miner`\n\nmigrated to [miner page](./miner.md)\n\n#### Path `/payments`\n\nTODO\n\n#### Path \"/algorithm\"\n\nWe are recommend to deploy different algorithm stratum port with different\nmining pool instance, so it means the frontend page have to deal with\nmulti-api-server circumstance.\n\n-   GET\n\nGet all algorithms\n\n-   POST\n\nPOST on '/algorithm' is meaning for being compatible multi-algorithms coins\n\n```json\n{\n    \"name\": \"scrypt\",\n    \"variant\": \"ltc-origin\",\n    \"blobType\": \"\"\n}\n```\n\n#### Path \"/lucky\"\n\nthe lucky table\n\nlucky = 1 / effort\n\nMore lucky means more benefit when same hashrate\n\n-   GET\n\n```json\n{\n    \"1d\": 0.99,\n    \"7d\": 1.01,\n    \"1m\": 1.11\n}\n```\n\n-   POST\n\ne.g.\n\nrequest with body, aiming to fetch luckies between these 14 days.\n\n```json\n{\n    \"start\": \"1-Jan-2020\",\n    \"end\": \"10-Jan-2020\"\n}\n```\n\npool returns a list\n\n```json\n[\"1.1\", \"1.11\", \"0.9\", \"0.98\", \"0.7\", \"1.5\", \"1.11\", \"0.9\", \"0.98\", \"1\"]\n```\n\n#### Path \"/effort\"\n\nthe effort table\n\neffort = 1 / lucky\n\nMore lucky means more benefit when same hashrate\n\n-   GET\n\n```json\n{\n    \"1d\": 1.01,\n    \"7d\": 0.99,\n    \"1m\": 0.91\n}\n```\n\n-   POST\n\ne.g.\n\nrequest with body, aiming to fetch efforts between these 14 days.\n\n```json\n{\n    \"start\": \"1-Jan-2020\",\n    \"end\": \"10-Jan-2020\"\n}\n```\n\npool returns a list\n\n```json\n[\"1.1\", \"1.11\", \"0.9\", \"0.98\", \"0.7\", \"1.5\", \"1.11\", \"0.9\", \"0.98\", \"1\"]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmining-pool%2Fmining-pool-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmining-pool%2Fmining-pool-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmining-pool%2Fmining-pool-api/lists"}