{"id":18895664,"url":"https://github.com/binance/binance-cli","last_synced_at":"2025-10-10T11:35:02.652Z","repository":{"id":40471239,"uuid":"462208045","full_name":"binance/binance-cli","owner":"binance","description":"Simple CLI to Binance API","archived":false,"fork":false,"pushed_at":"2024-08-21T07:17:32.000Z","size":193,"stargazers_count":32,"open_issues_count":1,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-15T01:13:56.853Z","etag":null,"topics":["binance-api","cli","command-line","futures","market-data","spot"],"latest_commit_sha":null,"homepage":"","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/binance.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-02-22T08:38:11.000Z","updated_at":"2025-04-06T13:13:57.000Z","dependencies_parsed_at":"2024-11-08T08:30:52.143Z","dependency_job_id":"5aa6a6ba-46d2-4a2c-990a-d0636e58be89","html_url":"https://github.com/binance/binance-cli","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binance%2Fbinance-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/binance","download_url":"https://codeload.github.com/binance/binance-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248986315,"owners_count":21194025,"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":["binance-api","cli","command-line","futures","market-data","spot"],"created_at":"2024-11-08T08:29:16.947Z","updated_at":"2025-10-10T11:34:57.598Z","avatar_url":"https://github.com/binance.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Binance CLI\n\nA simple CLI that interacts with the Binance API\n\n\n## Installation\n\n```bash\n\n# download the code\ngit clone git@github.com:binance/binance-cli.git\ncd binance-cli\nnpm install -g\n\n```\n## Usage\n\n\n```bash\n\n# Display help command\nbinance-cli -h\n\n# Set the API key and secret as global variables\n# For SPOT\nexport BINANCE_API_KEY=\u003cthe_api_key\u003e\nexport BINANCE_API_SECRET=\u003cthe_api_secret\u003e\n\n# For Futures\nexport BINANCE_FUTURES_API_KEY=\u003cthe_api_key\u003e\nexport BINANCE_FUTURES_API_SECRET=\u003cthe_api_secret\u003e\n\n# It's possible to change the base URL to connect to testnet\n# For SPOT\nexport SERVER=https://testnet.binance.vision\n\n# For Futures\nexport FUTURES_SERVER=https://testnet.binancefuture.com\n# then the command request will be sent to the testnet.\n```\n\n\n\n### SPOT\n\n#### Market Data\n\n##### Get Server Time\n```bash\nbinance-cli t\nbinance-cli time\n```\n\n##### Get Exchange Infomation\n```bash\nbinance-cli i\n# get BTCUSDT pair's filters. jq is required.\nbinance-cli i | jq '.symbols[] | select(.symbol == \"BNBUSDT\") |.filters'\n```\n\n##### Get Order Book\n```bash\n# binance-cli book \u003csymbol\u003e\n# binance-cli book -l \u003climit\u003e \u003csymbol\u003e\nbinance-cli book bnbusdt\nbinance-cli book --limit 10 bnbusdt\n```\n\n##### Get Trades\n```bash\n# binance-cli trades \u003csymbol\u003e\nbinance-cli trades bnbusdt\nbinance-cli trades -l 10 bnbusdt\n```\n\n##### Get Aggregate Trades List\n```bash\n# binance-cli at \u003csymbol\u003e\nbinance-cli at bnbusdt\n\n# get aggregate Trades List with parameters\n# binance-cli at \u003csymbol\u003e\nbinance-cli at --limit 10 --startTime 1595937694913 --endTime 1595937794913 bnbusdt\n```\n\n##### Get Klines Data\n```bash\n# binance-cli k \u003csymbol\u003e \u003cinterval\u003e\nbinance-cli k bnbusdt 1m\nbinance-cli k -l 1 bnbusdt 1m\n\n```\n##### Get Average Price\n```bash\n# binance-cli ap \u003csymbol\u003e\nbinance-cli ap bnbusdt\n```\n\n##### Get 24hr Ticker\n```bash\n# binance-cli ticker -s \u003csymbol\u003e\nbinance-cli ticker -s bnbusdt\n```\n\n##### Get Ticker Price\n```bash\nbinance-cli price\n# or with a symbol\nbinance-cli price -s bnbusdt\n```\n\n##### Get Order Book Ticker\n```bash\n# binance-cli bt\n# binance-cli bt -s \u003csymbol\u003e\nbinance-cli bt -s bnbusdt\n```\n\n#### Listen To Streams\n```bash\n# binance-cli listen \u003cstream\u003e \u003cstream\u003e \u003clistenKey\u003e\nbinance-cli listen bnbusdt@depth bnbusdt@bookTicker\n```\n\n#### User Data And Trade\n\n##### Buy\n```bash\n# place a limit buy order on BNBUSDT with price=350 and qty=0.05\nbinance-cli buy -s BNBUSDT -t LIMIT -q 0.05 -p 350 -f GTC\n```\n\n##### Sell\n```bash\n# place a limit sell order on BNBUSDT with price=500 and qty=0.03\nbinance-cli sell -s bnbusdt -t limit -q 0.03 -p 500 -f GTC\n```\n\n##### Get Order Details\n```bash\nbinance-cli get bnbusdt -i 12345\nbinance-cli get bnbusdt -c my_order_123\n```\n\n##### Cancel An Order\n```bash\nbinance-cli cancel bnbusdt -i 12345\nbinance-cli cancel bnbusdt -c my_order_123\n```\n\n##### Cancel All Open Orders\n```bash\nbinance-cli cancel_all bnbusdt\n```\n\n\n\n### UM Futures\n\n#### Market Data\n\n##### Get Server Time\n```bash\nbinance-cli um_t\nbinance-cli um_time\n```\n\n##### Get Exchange Infomation\n```bash\nbinance-cli um_i\n# get BTCUSDT pair's filters. jq is required.\nbinance-cli um_info | jq '.symbols[] | select(.symbol == \"BNBUSDT\") |.filters'\n\n```\n\n##### Get Order Book\n\n```bash\n# binance-cli um_book \u003csymbol\u003e\n# binance-cli um_book -l \u003climit\u003e \u003csymbol\u003e\nbinance-cli um_book bnbusdt\nbinance-cli um_book --limit 10 bnbusdt\n```\n\n##### Get Trades\n```bash\n# binance-cli um_trades \u003csymbol\u003e\nbinance-cli um_trades bnbusdt\nbinance-cli um_trades -l 10 bnbusdt\n```\n\n##### Get Aggregate Trades List\n```bash\n# binance-cli um_at \u003csymbol\u003e\nbinance-cli um_at bnbusdt\n\n# get aggregate Trades List with parameters\n# binance-cli um_at \u003csymbol\u003e\nbinance-cli um_at --limit 10 --startTime 1595937694913 --endTime 1595937794913 bnbusdt\n```\n\n##### Get Klines Data\n```bash\n# binance-cli um_k \u003csymbol\u003e \u003cinterval\u003e\nbinance-cli um_k bnbusdt 1m\nbinance-cli um_k -l 1 bnbusdt 1m\n```\n\n##### Get 24hr Ticker\n```bash\n# binance-cli um_ticker -s \u003csymbol\u003e\nbinance-cli um_ticker -s bnbusdt\n```\n\n##### Get Ticker Price\n```bash\nbinance-cli um_price\n# or with a symbol\nbinance-cli um_price -s bnbusdt\n```\n\n##### Get Order Book Ticker\n```bash\n# binance-cli um_bt\n# binance-cli um_bt -s \u003csymbol\u003e\nbinance-cli um_bt -s bnbusdt\n```\n\n#### User Data And Trade\n\n##### Buy\n```bash\n# place a limit buy order on BNBUSDT with price=350 and qty=0.05\nbinance-cli um_buy -s BNBUSDT -t LIMIT -q 0.05 -p 350 -f GTC\n```\n\n##### Sell\n```bash\n# place a limit sell order on BNBUSDT with price=600 and qty=0.03\nbinance-cli um_sell -s bnbusdt -t limit -q 0.03 -p 600 -f GTC\n```\n\n##### Get Order Details\n```bash\nbinance-cli um_get bnbusdt -i 12345\nbinance-cli um_get bnbusdt -c my_order_123\n```\n\n##### Cancel An Order\n```bash\nbinance-cli um_cancel bnbusdt -i 12345\nbinance-cli um_cancel bnbusdt -c my_order_123\n```\n\n##### Cancel All Open Orders\n```bash\nbinance-cli um_cancel_all bnbusdt\n```\n\n\n\n### CM Futures\n\n#### Market Data\n\n##### Get Server Time\n```bash\nbinance-cli cm_t\nbinance-cli cm_time\n```\n\n##### Get Exchange Infomation\n```bash\nbinance-cli cm_i\n# get BTCUSDT pair's filters. jq is required.\nbinance-cli cm_info | jq '.symbols[] | select(.symbol == \"BNBUSD_PERP\") |.filters'\n```\n##### Get Order Book\n```bash\n# binance-cli cm_book \u003csymbol\u003e\n# binance-cli cm_book -l \u003climit\u003e \u003csymbol\u003e\nbinance-cli cm_book BNBUSD_PERP\nbinance-cli cm_book --limit 10 BNBUSD_PERP\n```\n\n##### Get Trades\n```bash\n# binance-cli cm_t \u003csymbol\u003e\nbinance-cli cm_trades BNBUSD_PERP\nbinance-cli cm_trades -l 10 BNBUSD_PERP\n```\n\n##### Get Aggregate Trades List\n```bash\n# binance-cli cm_at \u003csymbol\u003e\nbinance-cli cm_at BNBUSD_PERP\n\n# get aggregate Trades List with parameters\n# binance-cli cm_at \u003csymbol\u003e\nbinance-cli cm_at --limit 10 --startTime 1701367424920 --endTime 1702037809993 BNBUSD_PERP\n```\n\n##### Get Klines Data\n```bash\n# binance-cli cm_k \u003csymbol\u003e \u003cinterval\u003e\nbinance-cli cm_k BNBUSD_PERP 1m\nbinance-cli cm_k -l 1 BNBUSD_PERP 1m\n\n```\n\n##### Get 24hr Ticker\n```bash\n# binance-cli cm_ticker -s \u003csymbol\u003e\nbinance-cli cm_ticker -s BNBUSD_PERP\n```\n\n##### Get Ticker Price\n```bash\nbinance-cli cm_price\n# or with a symbol\nbinance-cli cm_price -s BNBUSD_PERP\n```\n\n##### Get Order Book Ticker\n```bash\n# binance-cli cm_bt\n# binance-cli cm_bt -s \u003csymbol\u003e\nbinance-cli cm_bt -s BNBUSD_PERP\n```\n\n#### User Data And Trade\n\n##### Buy\n```bash\n# place a limit buy order on BNBUSDT with price=350 and qty=1\nbinance-cli cm_buy -s BNBUSD_PERP -t LIMIT -q 1 -p 350 -f GTC\n```\n\n##### Sell\n```bash\n# place a limit sell order on BNBUSDT with price=600 and qty=1\nbinance-cli cm_sell -s BNBUSD_PERP -t limit -q 1 -p 600 -f GTC\n```\n\n##### Get Order Details\n```bash\nbinance-cli cm_get BNBUSD_PERP -i 12345\nbinance-cli cm_get BNBUSD_PERP -c my_order_123\n```\n\n##### Cancel An Order\n```bash\nbinance-cli cm_cancel BNBUSD_PERP -i 12345\nbinance-cli cm_cancel BNBUSD_PERP -c my_order_123\n```\n\n##### Cancel All Open Orders\n```bash\nbinance-cli cm_cancel_all BNBUSD_PERP\n```\n\n### Annex\n\nUse `--help` to consult all the available commands\n```bash\nbinance-cli --help\n```\n\n## LICENSE\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinance%2Fbinance-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinance%2Fbinance-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinance%2Fbinance-cli/lists"}