{"id":13772909,"url":"https://github.com/fanatid/bitcoin-faucet-api","last_synced_at":"2025-03-15T12:14:39.289Z","repository":{"id":29016513,"uuid":"32543717","full_name":"fanatid/bitcoin-faucet-api","owner":"fanatid","description":"Bitcoin faucet service","archived":false,"fork":false,"pushed_at":"2015-12-07T07:49:50.000Z","size":60,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-14T14:55:19.537Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fanatid.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":"2015-03-19T20:10:08.000Z","updated_at":"2025-02-07T17:37:11.000Z","dependencies_parsed_at":"2022-09-05T20:51:02.112Z","dependency_job_id":null,"html_url":"https://github.com/fanatid/bitcoin-faucet-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fanatid%2Fbitcoin-faucet-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fanatid%2Fbitcoin-faucet-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fanatid%2Fbitcoin-faucet-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fanatid%2Fbitcoin-faucet-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fanatid","download_url":"https://codeload.github.com/fanatid/bitcoin-faucet-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243725633,"owners_count":20337670,"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":[],"created_at":"2024-08-03T17:01:09.076Z","updated_at":"2025-03-15T12:14:39.270Z","avatar_url":"https://github.com/fanatid.png","language":"JavaScript","funding_links":[],"categories":["List of content"],"sub_categories":["Utilities"],"readme":"# bitcoin-faucet-api\n\n[![build status](https://img.shields.io/travis/fanatid/bitcoin-faucet-api.svg?branch=master\u0026style=flat-square)](http://travis-ci.org/fanatid/bitcoin-faucet-api)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n[![Dependency status](https://img.shields.io/david/fanatid/bitcoin-faucet-api.svg?style=flat-square)](https://david-dm.org/fanatid/bitcoin-faucet-api#info=dependencies)\n\n  * [Requirements](#requirements)\n  * [Installation](#installation)\n  * [API](#api)\n  * [License](#license)\n\n## Requirements\n\n  * [node.js](https://nodejs.org/) (tested only with latest version)\n\n## Installation\n\n  Clone repository:\n\n    $ git clone https://github.com/fanatid/bitcoin-faucet-api.git \u0026\u0026 cd bitcoin-faucet-api\n\n  Install dependencides:\n\n    $ npm install\n\n  Compile to es5 from es6 with babel:\n\n    $ npm run compile\n\n  Copy defeault config and edit:\n\n    $ cp config/default.yml config/local.yml \u0026\u0026 vim config/local.yml\n\n  Run faucet-api:\n\n    $ ./bin/faucet-api.js -c config/api-my.yml\n\n## API\n\n  * [preload](#preload)\n  * [withdrawal](#withdrawal)\n  * [donation](#donation)\n  * [status](#status)\n  * [version](#version)\n\n#### preload\n\n  **url**\n\n    /v1/preload\n\n  **query**\n\n| param | description       |\n|:------|:------------------|\n| name  | preload type name |\n\n  **result**\n\n    {\n      \"status\": \"success\",\n      \"data\": {\n        \"mnemonic\": \"prepare wait latin vivid distance ice barrel chapter link dynamic lecture december\",\n        \"passphrase\": \"7da79e82\",\n        \"seed\": \"749cba292bf5cc52358703610e4788f0fd6ed8b8cfaacf594e6a2e36a72f3d165917b310065616ca6c114c24ccb7dc518ba67c41de029e17efa8dd48dc4d81db\",\n        \"privateKeyHDRoot\": \"tprv8ZgxMBicQKsPf2dRcXnaM3t7J9RZoWPrnNRcogorUTjUMGaWXXad94ou9Mv4F6WWMs9QuE9c9VU3e5UJJELfvvaCPq88pu5oJGC4YtHancZ\",\n        \"privateKeyWIF\": \"cNbmTJj7HrEXPGQ84XxpCw4Dgv9dBiF8NDXGxSLtD2tJaz6Dz9QK\", // chain always is m/0/0/0\n        \"address\": \"mypDQozM9mRUjp4ucHHj21NkvVcJaHKzXJ\",\n        \"unspent\": [{\n          \"txId\": \"6577fc98d3d6851d3e4bf857dc68d6b08acce1313f4d7ff23dda8698b0a35803\",\n          \"outputIndex\": 6,\n          \"satoshis\": 25000,\n          \"script\": \"76a914c8b5f43e596d395de9c30b3ce1d89e2a7a27172e88ac\"\n        }, {\n          \"txId\": \"6577fc98d3d6851d3e4bf857dc68d6b08acce1313f4d7ff23dda8698b0a35803\",\n          \"outputIndex\": 7,\n          \"satoshis\": 25000,\n          \"script\": \"76a914c8b5f43e596d395de9c30b3ce1d89e2a7a27172e88ac\"\n        }]\n      }\n    }\n\n#### withdrawal\n\n  **url**\n\n    /v1/withdrawal\n\n  **query**\n\n| param    | description                   |\n|:---------|:------------------------------|\n| address  | bitcoin address               |\n| satoshis | withdrawal amount in satoshis |\n\n  **result**\n\n    {\n      \"status\": \"success\",\n      \"data\": {\n        \"address\": \"moeApce3EQcKbGptsiB9Lg8RnXHzvNZrHb\",\n        \"txId\": \"906ecb5cc79261a1b02206bbc2ea49b9444e73572f6c19692ec29f32a08a2035\",\n        \"outputIndex\": 0,\n        \"satoshis\": 1000000,\n        \"script\": \"76a914591e5ffc8e07032b02b0be154cded1ff88d0fcc888ac\"\n      }\n    }\n\n#### donation\n\n  **url**\n\n    /v1/donation\n\n  **result**\n\n    {\n      \"status\": \"success\",\n      \"data\": {\n        \"address\": \"moioSiDRH5rtNz9jgYLPaDC1Ek8HMu4zpE\"\n      }\n    }\n\n#### status\n\n  **url**\n\n    /status\n\n  **result**\n\n    {\n      \"status\": \"success\",\n      \"insight\": {\n        \"url\": http://test-insight.bitpay.com/api\"\n      },\n      \"wallet\": {\n        \"network\": \"testnet\",\n        \"utxosCount\": 28,\n        \"balance\": 511915368\n      },\n      \"faucet\": {\n        \"withdrawal\": {\n          \"max\": 1000000\n        },\n        \"preload\": {\n          \"types\": [{\n            \"name\": \"100k\",\n            \"count\": 100,\n            \"values\": [100000]\n          }, {\n            \"name\": \"2x25k\",\n            \"count\": 100,\n            \"values\": [25000, 25000]\n          }]\n        }\n      }\n    }\n\n#### version\n\n  **url**\n\n    /version\n\n  **result**\n\n    {\n      \"status\": \"success\",\n      \"version\": \"0.1.0\"\n    }\n\n## License\n\nThis software is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffanatid%2Fbitcoin-faucet-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffanatid%2Fbitcoin-faucet-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffanatid%2Fbitcoin-faucet-api/lists"}