NAME
App::cryp::exchange - Interact with cryptoexchanges using a common interface
VERSION
This document describes version 0.012 of App::cryp::exchange (from Perl distribution App-cryp-exchange), released on 2021-05-26.
SYNOPSIS
Please see included script cryp-exchange.
FUNCTIONS
accounts
Usage:
accounts(%args) -> [$status_code, $reason, $payload, \%result_meta]List exchange accounts.
This function is not exported.
Arguments ('*' denotes required arguments):
detail => bool
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
balance
Usage:
balance(%args) -> [$status_code, $reason, $payload, \%result_meta]List account balance.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
cancel_order
Usage:
cancel_order(%args) -> [$status_code, $reason, $payload, \%result_meta]Cancel an order.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
order_id* => str
pair* => str
type* => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
create_limit_order
Usage:
create_limit_order(%args) -> [$status_code, $reason, $payload, \%result_meta]Create a limit order.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
base_size => float
Order amount, denominated in base currency (first currency of the pair).
pair* => str
price* => float
quote_size => float
Order amount, denominated in quote currency (second currency of the pair).
type* => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
exchanges
Usage:
exchanges(%args) -> [$status_code, $reason, $payload, \%result_meta]List supported exchanges.
This function is not exported.
Arguments ('*' denotes required arguments):
detail => bool
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
get_order
Usage:
get_order(%args) -> [$status_code, $reason, $payload, \%result_meta]Get information about an order.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
order_id* => str
pair* => str
type* => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
open_orders
Usage:
open_orders(%args) -> [$status_code, $reason, $payload, \%result_meta]List open orders.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
pair => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
orderbook
Usage:
orderbook(%args) -> [$status_code, $reason, $payload, \%result_meta]Get order book on an exchange.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
pair* => str
type => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
pairs
Usage:
pairs(%args) -> [$status_code, $reason, $payload, \%result_meta]List pairs supported by exchange.
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
detail => bool
native => bool
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
ticker
Usage:
ticker(%args) -> [$status_code, $reason, $payload, \%result_meta]Get a pair's ticker (last 24h price & volume information).
This function is not exported.
Arguments ('*' denotes required arguments):
account* => cryptoexchange::account
pair* => str
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
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
Other App::cryp::* modules.
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.