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

NAME

cryp-exchange - Interact with cryptoexchanges using a common interface

VERSION

This document describes version 0.012 of cryp-exchange (from Perl distribution App-cryp-exchange), released on 2021-05-26.

SYNOPSIS

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

; equivalent to exchange/indodax/default
[exchange/indodax]
api_key    = S6WBYR6Q-TVMTSFOA-YWK6GSNT-H0JMEK6Z-YDF5ML9Y
api_secret = e16064aa7fb477b267fe774df62194f33583c7f46a09ad931ca2e097aeaa9c9296e1c3b2734bab71

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

[exchange/coinbase-pro]
api_key        = 2171d01f1de2518c94a11870a6df22d0
api_secret     = 9B8T2nPFMRUiUIKA82txjaO09iNnJXBMVMdkDgJ0i2YambYKQY8DZAS54ERZE0sE2lzYrpTWfpU7/110xfesZluY
api_passphrase = gdllszgwO774NN

General

To list supported exchanges:

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

To list pairs supported by an exchange:

% cryp-exchange pairs indodax

To list accounts:

% cryp-exchange accounts
% cryp-exchange accounts -l
% cryp-exchange accounts -I coinbase-pro -l ;# only accounts on coinbase-pro
% cryp-exchange accounts -X coinbase-pro -l ;# all accounts except those on coinbase-pro

To view ticker (last 24h price and volume information):

% cryp-exchange ticker coinbase-pro  BTC/USD

To get order book:

% cryp-exchange orderbook coinbase-pro

Balance

To get account balance:

% cryp-exchange balance coinbase-pro
% cryp-exchange balance indodax/wifey

Order

To create a limit order:

# buy 100USD worth of BTC at 7000USD/BTC
% cryp-exchange create-limit-order coinbase-pro BTC/USD buy 7500 --quote-size 100

# buy 0.5BTC at 7000USD/BTC
% cryp-exchange create-limit-order coinbase-pro BTC/USD buy 7500 --base-size 0.5

To get information about an order:

% cryp-exchange get-order coinbase-pro BTC/USD buy 6327a864-d2c8-4e3e-8de3-dd71921b7cd0

To list open orders:

# list all open orders
% cryp-exchange open-orders coinbase-pro

# list open orders for a specific pair only
% cryp-exchange open-orders coinbase-pro BTC/USD

To cancel an order:

% cryp-exchange cancel-order coinbase-pro BTC/USD buy 6327a864-d2c8-4e3e-8de3-dd71921b7cd0

DESCRIPTION

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

cryp-exchange is a multi-cryptoexchange CLI. This distribution provides common interface (as CLI as well as driver modules) to interact with different cryptocurrency exchanges including:

  • common set of subcommands (API methods)

    Along with common terminology, arguments, error behavior, and result format.

  • standardized currency codes and pair formats

    Following CryptoCurrency::Catalog.

SUBCOMMANDS

accounts

List exchange accounts.

balance

List account balance.

cancel-order

Cancel an order.

create-limit-order

Create a limit order.

exchanges

List supported exchanges.

get-order

Get information about an order.

open-orders

List open orders.

orderbook

Get order book on an exchange.

pairs

List pairs supported by exchange.

ticker

Get a pair's ticker (last 24h price & volume information).

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

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, -C

Do not use any configuration file.

--no-env

Do not read environment for default options.

--page-result

Filter output through a pager.

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

--view-result

View output using a viewer.

Options for subcommand accounts

--detail, -l

Options for subcommand balance

--account=s*

Options for subcommand cancel-order

--account=s*
--buy*

Alias for --type=buy.

See --type.

--order-id=s*
--pair=s*
--sell*

Alias for --type=sell.

See --type.

--type=s*

Valid values:

["buy","sell"]

Options for subcommand create-limit-order

--account=s*
--base-size=s

Order amount, denominated in base currency (first currency of the pair).

--buy*

Alias for --type=buy.

See --type.

--pair=s*
--price=s*
--quote-size=s

Order amount, denominated in quote currency (second currency of the pair).

--sell*

Alias for --type=sell.

See --type.

--type=s*

Valid values:

["buy","sell"]

Options for subcommand exchanges

--detail, -l

Options for subcommand get-order

--account=s*
--buy*

Alias for --type=buy.

See --type.

--order-id=s*
--pair=s*
--sell*

Alias for --type=sell.

See --type.

--type=s*

Valid values:

["buy","sell"]

Options for subcommand open-orders

--account=s*
--pair=s

Options for subcommand orderbook

--account=s*
--buy

Alias for --type=buy.

See --type.

--pair=s*
--sell

Alias for --type=sell.

See --type.

--type=s

Valid values:

["buy","sell"]

Options for subcommand pairs

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

Options for subcommand ticker

--account=s*
--pair=s*

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.

You can also 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.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

[plugin=DumpArgs]
-event=before_validate_args
-prio=99

[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

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 accounts

detail (see --detail)

Configuration for subcommand balance

account (see --account)

Configuration for subcommand cancel-order

account (see --account)
order_id (see --order-id)
pair (see --pair)
type (see --type)

Configuration for subcommand create-limit-order

account (see --account)
base_size (see --base-size)
pair (see --pair)
price (see --price)
quote_size (see --quote-size)
type (see --type)

Configuration for subcommand exchanges

detail (see --detail)

Configuration for subcommand get-order

account (see --account)
order_id (see --order-id)
pair (see --pair)
type (see --type)

Configuration for subcommand open-orders

account (see --account)
pair (see --pair)

Configuration for subcommand orderbook

account (see --account)
pair (see --pair)
type (see --type)

Configuration for subcommand pairs

account (see --account)
detail (see --detail)
native (see --native)

Configuration for subcommand ticker

account (see --account)
pair (see --pair)

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://github.com/perlancar/perl-App-cryp-exchange/issues

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.

CryptoCurrency::Catalog

CryptoExchange::Catalog

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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