view release on metacpan or  search on metacpan

script/cryp-arbit  view on Meta::CPAN

=item B<--db-name>=I<s>*

=item B<--db-password>=I<s>

=item B<--db-username>=I<s>

=item B<--frequency>=I<s>

How many seconds to wait between rounds (in seconds).

Default value:

 30

A round consists of checking prices and then creating arbitraging order pairs.


=item B<--loop>

Shortcut for --rounds -1.

See C<--rounds>.

=item B<--max-order-age>=I<s>

How long should we wait for orders to be completed before cancelling them (in seconds).

Default value:

 86400

Sometimes because of rapid trading and price movement, our order might not be
filled immediately. This setting sets a limit on how long should an order be
left open. After this limit is reached, we cancel the order. The imbalance of
the arbitrage transaction will be recorded.


=item B<--max-order-pairs-per-round>=I<s>

Maximum number of order pairs to create per round.

=item B<--max-order-quote-size>=I<s>

What is the maximum amount of a single order.

Default value:

 100

A single order will be limited to not be above this value (in quote currency,
which if fiat will be converted to USD). This is the amount for the buying
(because an arbitrage transaction is comprised of a pair of orders, where one
order is a selling order at a higher quote currency size than the buying order).

For example if you are arbitraging BTC against USD and IDR, and set this option
to 75, then orders will not be above 75 USD. If you are arbitraging LTC against
BTC and set this to 0.03 then orders will not be above 0.03 BTC.

Suggestion: If you set this option too high, a few orders can use up your
inventory (and you might not be getting optimal profit percentage). Also, large
orders can take a while (or too long) to fill. If you set this option too low,
you will hit the exchanges' minimum order size and no orders can be created.
Since we want smaller risk of orders not getting filled quickly, we want small
order sizes. The optimum number range a little above the exchanges' minimum
order size.


=item B<--min-account-balances-json>=I<s>

What are the minimum account balances (JSON-encoded).

See C<--min-account-balances>.

=item B<--min-account-balances>=I<s>

What are the minimum account balances.

=item B<--min-net-profit-margin>=I<s>

Minimum net profit margin that will trigger an arbitrage trading, in percentage.

Default value:

 0

Below this percentage number, no order pairs will be sent to the exchanges to do
the arbitrage. Note that the net profit margin already takes into account
trading fees and forex spread (see Glossary section for more details and
illustration).

Suggestion: If you set this option too high, there might not be any order pairs
possible. If you set this option too low, you will be getting too thin profits.
Run `cryp-arbit opportunities` or `cryp-arbit arbit --dry-run` for a while to
see what the average percentage is and then decide at which point you want to
perform arbitrage.


=item B<--quote-currencies-json>=I<s>

The currencies to exchange (buy/sell) the target currencies (JSON-encoded).

See C<--quote-currency>.

=item B<--quote-currency>=I<s@>

The currencies to exchange (buy/sell) the target currencies.

You can have fiat currencies as the quote currencies, to buy/sell the target
(base) currencies during arbitrage. For example, to arbitrage LTC against USD
and IDR, `base_currencies` is ['BTC'] and `quote_currencies` is ['USD', 'IDR'].

You can also arbitrage cryptocurrencies against other cryptocurrency (usually
BTC, "the USD of cryptocurrencies"). For example, to arbitrage XMR and LTC
against BTC, `base_currencies` is ['XMR', 'LTC'] and `quote_currencies` is
['BTC'].


Can be specified multiple times.

=item B<--rounds>=I<s>

How many rounds.

Default value:

 1

-1 means unlimited.


=item B<--strategy>=I<s>

Which strategy to use for arbitration.

Default value:

 "merge_order_book"

Strategy is implemented in a `App::cryp::arbit::Strategy::*` perl module.


=back

=head2 Options for subcommand check-orders

=over

=item B<--db-name>=I<s>*

=item B<--db-password>=I<s>

=item B<--db-username>=I<s>

=item B<--max-order-age>=I<s>

script/cryp-arbit  view on Meta::CPAN

cryptoexchanges. If not specified, all accounts listed on the configuration file
will be included. Note that it's possible to include two or more accounts on the
same cryptoexchange.


Can be specified multiple times.

=item B<--base-currencies-json>=I<s>

Target (crypto)currencies to arbitrate (JSON-encoded).

See C<--base-currency>.

=item B<--base-currency>=I<s@>

Target (crypto)currencies to arbitrate.

If not specified, will list all supported pairs on all the exchanges and include
the base cryptocurrencies that are listed on at least 2 different exchanges (for
arbitrage possibility).


Can be specified multiple times.

=item B<--db-name>=I<s>*

=item B<--db-password>=I<s>

=item B<--db-username>=I<s>

=item B<--ignore-balance>

Ignore account balances.

=item B<--ignore-min-order-size>

Ignore minimum order size limitation from exchanges.

=item B<--max-order-pairs-per-round>=I<s>

Maximum number of order pairs to create per round.

=item B<--max-order-quote-size>=I<s>

What is the maximum amount of a single order.

Default value:

 100

A single order will be limited to not be above this value (in quote currency,
which if fiat will be converted to USD). This is the amount for the buying
(because an arbitrage transaction is comprised of a pair of orders, where one
order is a selling order at a higher quote currency size than the buying order).

For example if you are arbitraging BTC against USD and IDR, and set this option
to 75, then orders will not be above 75 USD. If you are arbitraging LTC against
BTC and set this to 0.03 then orders will not be above 0.03 BTC.

Suggestion: If you set this option too high, a few orders can use up your
inventory (and you might not be getting optimal profit percentage). Also, large
orders can take a while (or too long) to fill. If you set this option too low,
you will hit the exchanges' minimum order size and no orders can be created.
Since we want smaller risk of orders not getting filled quickly, we want small
order sizes. The optimum number range a little above the exchanges' minimum
order size.


=item B<--min-account-balances-json>=I<s>

What are the minimum account balances (JSON-encoded).

See C<--min-account-balances>.

=item B<--min-account-balances>=I<s>

What are the minimum account balances.

=item B<--min-net-profit-margin>=I<s>

Minimum net profit margin that will trigger an arbitrage trading, in percentage.

Default value:

 0

Below this percentage number, no order pairs will be sent to the exchanges to do
the arbitrage. Note that the net profit margin already takes into account
trading fees and forex spread (see Glossary section for more details and
illustration).

Suggestion: If you set this option too high, there might not be any order pairs
possible. If you set this option too low, you will be getting too thin profits.
Run `cryp-arbit opportunities` or `cryp-arbit arbit --dry-run` for a while to
see what the average percentage is and then decide at which point you want to
perform arbitrage.


=item B<--quote-currencies-json>=I<s>

The currencies to exchange (buy/sell) the target currencies (JSON-encoded).

See C<--quote-currency>.

=item B<--quote-currency>=I<s@>

The currencies to exchange (buy/sell) the target currencies.

You can have fiat currencies as the quote currencies, to buy/sell the target
(base) currencies during arbitrage. For example, to arbitrage LTC against USD
and IDR, `base_currencies` is ['BTC'] and `quote_currencies` is ['USD', 'IDR'].

You can also arbitrage cryptocurrencies against other cryptocurrency (usually
BTC, "the USD of cryptocurrencies"). For example, to arbitrage XMR and LTC
against BTC, `base_currencies` is ['XMR', 'LTC'] and `quote_currencies` is
['BTC'].


Can be specified multiple times.

=item B<--strategy>=I<s>

Which strategy to use for arbitration.

Default value:

 "merge_order_book"

Strategy is implemented in a `App::cryp::arbit::Strategy::*` perl module.


=back

=head2 Options for subcommand order-pairs

=over

=item B<--db-name>=I<s>*

=item B<--db-password>=I<s>

=item B<--db-username>=I<s>

=item B<--open>

=item B<--time-end>=I<s>

=item B<--time-start>=I<s>

=back

=head2 Options for subcommand profit-report

=over