NAME
App::coinbasepro::lite - Thin CLI for Coinbase Pro API
VERSION
This document describes version 0.003 of App::coinbasepro::lite (from Perl distribution App-coinbasepro-lite), released on 2018-11-29.
SYNOPSIS
Please see included script coinbasepro-lite.
DESCRIPTION
This package offers a thin CLI for accessing Coinbase Pro API (public or private), mainly for debugging/testing.
FUNCTIONS
private
Usage:
private(%args) -> [status, msg, payload, meta]
Perform a public API request.
This function is not exported.
Arguments ('*' denotes required arguments):
args => hash
endpoint* => str
key* => str
method => str (default: "GET")
passphrase* => str
secret* => str
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
public
Usage:
public(%args) -> [status, msg, payload, meta]
Perform a public API request.
This function is not exported.
Arguments ('*' denotes required arguments):
args => hash
endpoint* => str
method => str (default: "GET")
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-coinbasepro-lite.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-coinbasepro-lite.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-coinbasepro-lite
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
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.