NAME

btcindo - CLI for bitcoin.co.id

VERSION

This document describes version 0.004 of btcindo (from Perl distribution App-btcindo), released on 2017-06-03.

SYNOPSIS

First, create an account at bitcoin.co.id, create the trade API key then insert the API key and secret key in ~/.config/btcindo.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/btcindo.conf
key = ...
secret = ...

To show a ticker:

% btcindo ticker

To show latest trades:

% btcindo trades

To show your balance:

% btcindo balance

To show transaction history (Rupiah deposits & withdrawals):

% btcindo tx-history

To show your trade history:

% btcindo trade-history
% btcindo trade-history --time-from 2017-05-31
% btcindo trade-history --trade-id-from 1200000 --trade-id-to 1200100

To show your open/pending orders:

% btcindo open-orders

To create a new order:

# buy Rp 1.500.000-worth of bitcoin at Rp 34.000.000/BTC
% btcindo trade buy 34000000 --idr 1500000

# sell 0.01 bitcoin at Rp 38.000.000/BTC (create-order is alias for trade)
% btcindo create-order sell 38000000 --btc 0.01

Cancel an existing order:

% btcindo cancel-order sell 2345678

For other available commands, see the help message or documentation:

% btcindo -h

SUBCOMMANDS

balance

Show current balances.

cancel-order

Cancel an existing open order.

create-order

Create a new order.

depth

Show depth.

info

Show balance, server timestamp, and some other information.

open-orders

Show open orders.

price-history

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]

ticker

Show ticker.

trade

Create a new order.

trade-history

Show history of trades.

trades

Show latest trades.

tx-history

Show history of deposits and withdrawals.

OPTIONS

* marks required options.

Common options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--format=s

Choose output format, e.g. json, text.

Default value:

undef

--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]

--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--subcommands

List available subcommands.

--version, -v

Display program's version and exit.

Options for subcommand balance

--hold

Show held balance instead of available-to-trade balance.

--key=s*

--secret=s*

Options for subcommand cancel-order

--buy*

Alias for --type buy.

See --type.

--key=s*

--order-id=i*

--secret=s*

--sell*

Alias for --type sell.

See --type.

--type=s*

Valid values:

["buy","sell"]

Options for subcommand create-order

--btc=f

--buy*

Alias for --type buy.

See --type.

--idr=i

--key=s*

--pair=s

Pair.

Default value:

"btc_idr"

--price=i*

--secret=s*

--sell*

Alias for --type sell.

See --type.

--type=s*

Valid values:

["buy","sell"]

Options for subcommand depth

--type=s

Filter by type (buy/sell).

Valid values:

["buy","sell"]

Options for subcommand info

--key=s*

--secret=s*

Options for subcommand open-orders

--key=s*

--pair=s

Pair.

Default value:

"btc_idr"

--secret=s*

Options for subcommand price-history

--period=s

Default value:

"day"

Valid values:

["day","all"]

Options for subcommand trade

--btc=f

--buy*

Alias for --type buy.

See --type.

--idr=i

--key=s*

--pair=s

Pair.

Default value:

"btc_idr"

--price=i*

--secret=s*

--sell*

Alias for --type sell.

See --type.

--type=s*

Valid values:

["buy","sell"]

Options for subcommand trade-history

--key=s*

--pair=s

Pair.

Default value:

"btc_idr"

--secret=s*

--time-from=s

Filter by beginning time.

--time-to=s

Filter by ending time.

--trade-id-from=i

Filter by beginning trade ID.

--trade-id-to=i

Filter by ending trade ID.

Options for subcommand trades

--type=s

Filter by type (buy/sell).

Valid values:

["buy","sell"]

Options for subcommand tx-history

--key=s*

--secret=s*

--txtype=s

Filter by currency.

Valid values:

["btc","bts","crave","doge","drk","eth","idr","ltc","nbt","nem","nxt","sdc","str","xpy","xrp"]

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C btcindo btcindo

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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immediately have tab completion.

tcsh

To activate tcsh completion for this script, put:

complete btcindo 'p/*/`btcindo`/'

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).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

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/btcindo.conf, ~/btcindo.conf, or /etc/btcindo.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [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.

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.

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.

List of available configuration parameters:

Common for all subcommands

format (see --format)
naked_res (see --naked-res)

Configuration for subcommand 'balance'

hold (see --hold)
key (see --key)
secret (see --secret)

Configuration for subcommand 'cancel-order'

key (see --key)
order_id (see --order-id)
secret (see --secret)
type (see --type)

Configuration for subcommand 'create-order'

btc (see --btc)
idr (see --idr)
key (see --key)
pair (see --pair)
price (see --price)
secret (see --secret)
type (see --type)

Configuration for subcommand 'depth'

type (see --type)

Configuration for subcommand 'info'

key (see --key)
secret (see --secret)

Configuration for subcommand 'open-orders'

key (see --key)
pair (see --pair)
secret (see --secret)

Configuration for subcommand 'price-history'

period (see --period)

Configuration for subcommand 'ticker'

Configuration for subcommand 'trade'

btc (see --btc)
idr (see --idr)
key (see --key)
pair (see --pair)
price (see --price)
secret (see --secret)
type (see --type)

Configuration for subcommand 'trade-history'

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)

Configuration for subcommand 'trades'

type (see --type)

Configuration for subcommand 'tx-history'

key (see --key)
secret (see --secret)
txtype (see --txtype)

ENVIRONMENT

BTCINDO_OPT => str

Specify additional command-line options.

FILES

~/.config/btcindo.conf

~/btcindo.conf

/etc/btcindo.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-btcindo.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-btcindo.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-btcindo

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 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.

cpanm App::btcindo

perl -MCPAN -e shell
install App::btcindo