cryp-exchange - Interact with cryptoexchanges
This document describes version 0.002 of cryp-exchange (from Perl distribution App-cryp-exchange), released on 2018-04-12.
Create configuration in ~/.config/cryp-exchange.conf (or ~/.config/cryp.conf so configuration can be shared with the other cryp-* family of scripts):
cryp-*
[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
Early release. More functionality will be added in the future.
This utility (and the corresponding backend modules) provide a common interface to interact with various cryptocurrency exchanges: common set of subcommands (methods) with common arguments and result format, standardized currency codes (following CryptoCurrency::Catalog) and pair formats (e.g. BTC/USD).
BTC/USD
Get order book on an exchange.
List exchange accounts.
List supported exchanges.
List pairs supported by exchange.
* 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.
Alias for --type=buy.
See --type.
--type
Alias for --type=sell.
Valid values:
["buy","sell"]
This script has shell tab completion capability with support for several shells.
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.
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).
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/cryp.conf, ~/.config/cryp-exchange.conf, ~/cryp.conf, ~/cryp-exchange.conf, /etc/cryp.conf, or /etc/cryp-exchange.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)
exchange (see --exchange) pair (see --pair) type (see --type)
detail (see --detail)
detail (see --detail) exchange (see --exchange) native (see --native)
Specify additional command-line options.
~/.config/cryp.conf
~/.config/cryp-exchange.conf
~/cryp.conf
~/cryp-exchange.conf
/etc/cryp.conf
/etc/cryp-exchange.conf
Please visit the project's homepage at https://metacpan.org/release/App-cryp-exchange.
Source repository is at https://github.com/perlancar/perl-App-cryp-exchange.
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.
The other cryp-* scripts in the family.
perlancar <perlancar@cpan.org>
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.
To install App::cryp::exchange, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::cryp::exchange
CPAN shell
perl -MCPAN -e shell install App::cryp::exchange
For more information on module installation, please visit the detailed CPAN module installation guide.