{"id":21461511,"url":"https://github.com/zix99/bitdo2","last_synced_at":"2025-08-11T00:17:09.811Z","repository":{"id":99391211,"uuid":"113104930","full_name":"zix99/bitdo2","owner":"zix99","description":"Multi-market watcher and auto-trader","archived":false,"fork":false,"pushed_at":"2019-02-23T22:35:33.000Z","size":306,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-27T07:46:49.422Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/zix99.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}},"created_at":"2017-12-04T23:00:11.000Z","updated_at":"2022-06-16T14:09:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"dce0a2c6-004d-478e-83b7-8dbbbc3d6148","html_url":"https://github.com/zix99/bitdo2","commit_stats":{"total_commits":125,"total_committers":1,"mean_commits":125.0,"dds":0.0,"last_synced_commit":"d54818d45d26bffc7950df987f7f4ce5e6c94e7d"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/zix99/bitdo2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zix99%2Fbitdo2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zix99%2Fbitdo2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zix99%2Fbitdo2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zix99%2Fbitdo2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zix99","download_url":"https://codeload.github.com/zix99/bitdo2/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zix99%2Fbitdo2/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268003704,"owners_count":24179296,"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-31T02:00:08.723Z","response_time":66,"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-11-23T07:09:29.710Z","updated_at":"2025-08-11T00:17:09.744Z","avatar_url":"https://github.com/zix99.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BitDo2\n\n[![Build Status](https://travis-ci.org/zix99/bitdo2.svg?branch=master)](https://travis-ci.org/zix99/bitdo2)\n[![npm](https://img.shields.io/npm/v/bitdo2.svg)](https://www.npmjs.com/package/bitdo2)\n[![npm](https://img.shields.io/npm/l/bitdo2.svg)](https://www.npmjs.com/package/bitdo2)\n\n\u003e NOTE: BitDo2 is still under development, and can't execute rules quite yet.  It can display and track your holding history to a local database.  Please wait a little bit longer until it can execute rules.\n\nA cryptocurrency automated trader (not an intelligent trader!) and set of utilities.\n\nThe intention of this is to provide a configurable platform for performing\nautomated trades at preset points.\n\n## Installing\n\nMake sure to use at least node 6.x. You can always find the version of node I'm using in the [.nvmrc](.nvmrc) file.\n\nIf you get an error about installing/loading the exchanges or plugins, make sure you're running an up-to-date version of `npm`. You\ncan update npm by running `npm update -g npm`.\n\n```bash\nnpm install -g bitdo2\n```\n\n## Configuration\n\nYou will need a file `bitdo.conf` that contains your exchange configuration.\n\nIt should look something like this (Fill in your own secrets):\n```yaml\nexchanges:\n  gdax:\n    passphrase: xxx\n    key: yyy\n    b64secret: zzz\n  bittrex:\n    apikey: www\n    apisecret: ddd\n  robinhood:\n    username: xxx\n    password: yyy\nverbose: false\n```\n\n# Usage\n\nAlong with being a platform library, there are several utilities you can use that ship with bitdo2.\n\n## Using as a Library\n\nBy default, you can use bitdo2 as a library in your own applications.  It exports the common exchange abstraction,\nso you can operate on various exchanges without having to worry about their specific APIs.\n\neg.\n```js\nconst bitdo2 = require('bitdo2');\nbitdo2.createExchange('gdax', {... config ...});\n\nOR\n\nbitdo2.createFromConfig({\n  gdax: {\n    ...\n  },\n  bittrex: {\n    ...\n  }\n});\n```\n\n## UI\n\nRun: `bitdo-ui`\n\nMake sure you have configuration in the current directory.\n\nYou will be presented with a UI showing your current holdings and orders.\n\n## Watch\n\nRun: `bitdo-watch --help`\n\nWatches prices or orders for completion or failure cases. Meant to be chained with something else, eg:\n\n```bash\n# Watch an order and alert\nbitdo-watch -p gdax:BTC-USD --crosses 20000 --timeout 1d \u0026\u0026 notify-send \"Bitcoin crossed 20000!\" || notify-send \"Bitcoin didnt cross after a day\"\n\n# Trigger an order when a price dips below a value\nbitdo-watch -p gdax:BTC-USD --below 18000 --timeout 1d \u0026\u0026 bitdo-order buy -p gdax:BTC-USD --price 18000 --amount 0.1 || echo \"Order timed out\"\n\n# And can even be chained for more complex scenarios (Crosses below, then back up)\nbitdo-watch -p gdax:BTC-USD --below 18000 \u0026\u0026 bitdo-watch -p gdax:BTC-USD --above 18500 || bitdo-order ...\n```\n\n## Order\n\nRun: `bitdo-order --help`\n\nThis allows you to execute buy/sell/trail orders via command line on any configured exchanges.\n\n**DO SO AT YOUR OWN RISK!**\n\n## Recorder\n\nRun: `bitdo-recorder`\n\nThis will (by default) poll your holdings in exchanges and write them to a sqlite DB so you can track them over time.\n\nUses *Sequelize* to write to DB, so can use any database it supports (mysql, postgres, etc)\n\n# Plugins\n\nThere are two abstracted parts of bitdo2 that support plugins: *exchanges* and *plugins*\n\n## Exchanges\n\nAlthough bitdo2 comes with a set of exchanges builtin (though internally, they're just plugins), you\ncan extend this by creating a global package (or installing a global package) with the name `bitdo-exchange-XXX`,\nwhere `XXX` is the name of your exchange.\n\nWhen loading, bitdo will search for a local exchange first, and if one is not found, will check the global\npackages.\n\nIf you want to implement a new exchange, look at the [plugin constract](exchanges/index.js) for required\nmethods and contracts.\n\n## Plugins\n\nSome pieces of bitdo use plugins to extend the application without needing to pull the dependencies into\nthe main app.\n\nSimilar to the exchange, these plugins will first be loaded internally, and then searched for in the global\nnode modules with the pattern `bitdo-plugin-XXX`.\n\nTo develop a plugin look at [plugin contract](plugins/index.js)\n\n# License\n\nCopyright (c) 2017 Christopher LaPointe\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzix99%2Fbitdo2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzix99%2Fbitdo2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzix99%2Fbitdo2/lists"}