/ 
App-cryp-exchange-0.001
River stage one • 2 direct dependents • 2 total dependents
/ cryp-exchange

NAME

cryp-exchange - Interact with cryptoexchanges

VERSION

This document describes version 0.001 of cryp-exchange (from Perl distribution App-cryp-exchange), released on 2018-04-04.

SYNOPSIS

Create configuration in ~/.config/cryp-exchange.conf (or ~/.config/cryp.conf so configuration can be shared with the other cryp-* family of scripts):

[exchange/bitcoin-indonesia]
api_key    = S6WBYR6Q-TVMTSFOA-YWK6GSNT-H0JMEK6Z-YDF5ML9Y
api_secret = e16064aa7fb477b267fe774df62194f33583c7f46a09ad931ca2e097aeaa9c9296e1c3b2734bab71

; if you have another account on the same exchange
[exchange/bitcoin-indonesia/wifey]
api_key    = EKSGJUOR-ROR9K24P-Q45UBWVG-GZHANPQV-UY4Z1WBM
api_secret = 71100dc13ffe4d082239c06b5c36fd8f0548cd97056ffa2ee491ae4dfd4f996fb468ef3c70b12073

[exchange/gdax]
api_key        = 2171d01f1de2518c94a11870a6df22d0
api_secret     = 9B8T2nPFMRUiUIKA82txjaO09iNnJXBMVMdkDgJ0i2YambYKQY8DZAS54ERZE0sE2lzYrpTWfpU7/110xfesZluY
api_passphrase = gdllszgwO774NN

To list supported exchanges:

% cryp-exchange ls-exchanges
% cryp-exchange ls-exchanges -l

To list pairs offered in an exchange:

% cryp-exchange ls-pairs bitcoin-indonesia
% cryp-exchange ls-pairs gdax -l

To list accounts:

% cryp-exchange ls-accounts
% cryp-exchange ls-accounts -l
% cryp-exchange ls-accounts -I gdax -l ;# only accounts on gdax
% cryp-exchange ls-accounts -X gdax -l ;# all accounts except those on gdax

To get order book:

% cryp-exchange get-order-book gdax

DESCRIPTION

Early release. More functionality will be added in the future.

SUBCOMMANDS

get-order-book

Get order book on an exchange.

ls-accounts

List exchange accounts.

ls-exchanges

List supported exchanges.

ls-pairs

List pairs supported by exchange.

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.

--debug

Shortcut for --log-level=debug.

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

--log-level=s

Set log level.

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

--quiet

Shortcut for --log-level=error.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

Options for subcommand get-order-book

--buy

Alias for --type=buy.

See --type.

--exchange=s*
--pair=s*
--sell

Alias for --type=sell.

See --type.

--type=s

Valid values:

["buy","sell"]

Options for subcommand ls-accounts

--detail, -l

Options for subcommand ls-exchanges

--detail, -l

Options for subcommand ls-pairs

--detail, -l
--exchange=s*
--native

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C cryp-exchange cryp-exchange

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.

tcsh

To activate tcsh completion for this script, put:

complete cryp-exchange 'p/*/`cryp-exchange`/'

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/cryp.conf, ~/.config/cryp-exchange.conf, ~/cryp.conf, ~/cryp-exchange.conf, /etc/cryp.conf, or /etc/cryp-exchange.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)
log_level (see --log-level)
naked_res (see --naked-res)

Configuration for subcommand get-order-book

exchange (see --exchange)
pair (see --pair)
type (see --type)

Configuration for subcommand ls-accounts

detail (see --detail)

Configuration for subcommand ls-exchanges

detail (see --detail)

Configuration for subcommand ls-pairs

detail (see --detail)
exchange (see --exchange)
native (see --native)

ENVIRONMENT

CRYP_EXCHANGE_OPT => str

Specify additional command-line options.

FILES

~/.config/cryp.conf

~/.config/cryp-exchange.conf

~/cryp.conf

~/cryp-exchange.conf

/etc/cryp.conf

/etc/cryp-exchange.conf

HOMEPAGE

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

SOURCE

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

BUGS

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

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.

SEE ALSO

The other cryp-* scripts in the family.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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