indodax - CLI for Indodax.com
This document describes version 0.024 of indodax (from Perl distribution App-indodax), released on 2018-06-12.
First, create an account at https://bitcoin.co.id, create the trade API key then insert the API key and secret key in ~/.config/indodax.conf. Since the configuration file contains the API secret key, please make sure that the permission of the file is set so that unauthorized users cannot read it (e.g. chmod it to 0600).
# In ~/.config/indodax.conf key = ... secret = ...
To list available pairs:
% indodax pairs
To show ticker:
% indodax ticker ;# default pair: btc_idr % indodax ticker --pair eth_idr
To show latest trades:
% indodax trades
To show your balance:
% indodax balance
To show transaction history (Rupiah deposits & withdrawals):
% indodax tx-history
To show your trade history:
% indodax trade-history % indodax trade-history --time-from 2017-05-31 % indodax trade-history --trade-id-from 1200000 --trade-id-to 1200100
To show your open/pending orders:
% indodax open-orders
To create a new order:
# buy Rp 1.500.000-worth of bitcoin at Rp 34.000.000/BTC % indodax trade buy 34000000 --idr 1500000 # sell 0.01 bitcoin at Rp 38.000.000/BTC (create-order is alias for trade) % indodax create-order sell 38000000 --btc 0.01
Cancel an existing order:
% indodax cancel-order sell 2345678 ;# btc_idr % indodax cancel-order sell 345678 --pair bch_idr
Cancelling multiple orders in one go:
% indodax cancel-all-orders % indodax cancel-orders --type buy % indodax cancel-orders --type buy --pair btc_idr % indodax cancel-orders --currency idr
For other available commands, see the help message or documentation:
% indodax -h
DEPRECATION WARNING: This script is being deprecated in favor of App::cryp::Exchange::indodax and cryp-exchange, but as the latter does not have as many as subcommands as this script, this script is still being maintained.
Show current balances.
Cancel all existing open orders.
Cancel an existing open order.
Cancel one or more open orders matching criteria.
Create a new order.
Show depth.
Show in which open orders your currency is being held.
Show balance, server timestamp, and some other information.
Show open orders.
List available pairs.
Show price history, which can be used to draw candlestick chart.
The function will return an array of records. Each record is an array with the following data:
[timestamp-in-unix-epoch, open, high, low, close]
Perform private API (TAPI) request.
Calculate your profit.
Perform public API request.
Show ticker.
Show history of trades.
Show total amount of trades.
Show latest trades.
Show history of deposits and withdrawals.
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
Set configuration profile to use.
Shortcut for --log-level=debug.
Choose output format, e.g. json, text.
Default value:
undef
Display help message and exit.
Set output format to json.
Set log level.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Do not use any configuration file.
Do not read environment for default options.
Shortcut for --log-level=error.
List available subcommands.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Display program's version and exit.
Also show the value of all assets in IDR, using current prices information.
Alias for --type buy.
See --type.
--type
Pair.
"btc_idr"
Valid values:
["btc_idr","act_idr","ada_idr","bcd_idr","bch_idr","btg_idr","eth_idr","etc_idr","ignis_idr","ltc_idr","nxt_idr","stq_idr","ten_idr","trx_idr","waves_idr","xlm_idr","xrp_idr","xzc_idr","bts_btc","dash_btc","doge_btc","eth_btc","ltc_btc","nxt_btc","ten_btc","xem_btc","xlm_btc","xrp_btc"]
Alias for --type sell.
["buy","sell"]
Filter by currency.
["act","ada","bcd","bch","btc","btg","bts","dash","doge","etc","eth","idr","ignis","ltc","nxt","stq","ten","trx","waves","xem","xlm","xrp","xzc"]
Filter by pair.
Filter by type (buy/sell).
Currency name.
"idr"
"day"
["day","all"]
Each value is a name-value pair, use key=value syntax. Can be specified multiple times.
See --arg.
--arg
Filter by beginning time.
Filter by ending time.
"GET"
Filter by beginning trade ID.
Filter by ending trade ID.
Market.
["idr","btc"]
Filter by transaction type (deposit/withdraw).
["deposit","withdraw"]
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C indodax indodax
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete indodax 'p/*/`indodax`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/indodax.conf, ~/indodax.conf, or /etc/indodax.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].
[subcommand=NAME]
[SOMESECTION subcommand=NAME]
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
[subcommand=SUBCOMMAND_NAME profile=SOMENAME]
[SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
format (see --format) log_level (see --log-level) naked_res (see --naked-res)
key (see --key) secret (see --secret) with_idr_estimates (see --with-idr-estimates)
key (see --key) secret (see --secret)
key (see --key) order_id (see --order-id) pair (see --pair) secret (see --secret) type (see --type)
currency (see --currency) key (see --key) pair (see --pair) secret (see --secret) type (see --type)
btc (see --btc) idr (see --idr) key (see --key) pair (see --pair) price (see --price) secret (see --secret) type (see --type)
pair (see --pair) type (see --type)
currency (see --currency) key (see --key) secret (see --secret)
key (see --key) pair (see --pair) secret (see --secret) type (see --type)
period (see --period)
args (see --arg)
key (see --key) pair (see --pair) secret (see --secret) time_from (see --time-from) time_to (see --time-to)
args (see --arg) method (see --method) uri (see --uri)
pair (see --pair)
key (see --key) pair (see --pair) secret (see --secret) time_from (see --time-from) time_to (see --time-to) trade_id_from (see --trade-id-from) trade_id_to (see --trade-id-to)
key (see --key) market (see --market) secret (see --secret) time_from (see --time-from) time_to (see --time-to)
currency (see --currency) key (see --key) secret (see --secret) txtype (see --txtype)
Specify additional command-line options.
~/.config/indodax.conf
~/indodax.conf
/etc/indodax.conf
Please visit the project's homepage at https://metacpan.org/release/App-indodax.
Source repository is at https://github.com/perlancar/perl-App-indodax.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-indodax
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2018, 2017 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::indodax, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::indodax
CPAN shell
perl -MCPAN -e shell install App::indodax
For more information on module installation, please visit the detailed CPAN module installation guide.