/ 
Finance-BlockIO-0.02
River stage zero No dependents
/ Finance::BlockIO

NAME

Finance::BlockIO - Perl wrapper to JSON-based Block.io API

VERSION

Version 0.01

SYNOPSIS

use Finance::BlockIO;

my $api_key = "gobbledegook";

my $response = get_new_address($api_key, "foo");

DESCRIPTION

Finance::BlockIO provides a bare interface to the Block.io JSON-based API, using WWW::Curl::Simple to make requests and returning a Perl data structure created from any JSON response received.

You'll probably need an API key (and therefore an account) at Block.io in order to actually use this.

This documentation is not a replacement for the actual API documentation, which can be found at https://block.io/api/detailed/curl.

SUBROUTINES

get_new_address

my $response = get_new_address(
                            $api_key,       # REQUIRED
                            $label);        # Optional

Returns a brand new address. Can optionally specify a label for this address.

get_my_addresses

my $response = get_my_addresses(
                            $api_key);      # REQUIRED

Returns all addresses associated with $api_key.

get_address_by_label

my $response = get_address_by_label(
                            $api_key,       # REQUIRED
                            $label);        # REQUIRED

Returns an address with a label $label associated with $api_key.

get_balance

my $response = get_balance( $api_key);      # REQUIRED

Returns the combined balance of all addresses associated with $api_key.

get_address_balance

my $response = get_balance( $api_key,       # REQUIRED
                            $address,       # REQUIRED unless $label
                            $label);        # REQUIRED unless $address

Returns the balance of an address associated with $api_key, the address being specified by either $address or $label.

get_address_received

my $response = get_balance( $api_key,       # REQUIRED
                            $address,       # REQUIRED unless $label
                            $label);        # REQUIRED unless $address

Returns the amount received by an address associated with $api_key, the address being specified by either $address or $label.

withdraw

my $response = withdraw($api_key,           # REQUIRED
                        $amount,            # REQUIRED
                        $pin,               # REQUIRED
                        $payment_address,   # REQUIRED unless $to_user_ids
                        $to_user_id,        # REQUIRED unless $payment_address
                        $from_user_ids);    # Optional

Requests payment to be sent from the account associated with $api_key to either an address specified by $payment_address or a Block.io user specified by $to_user_id, in an amount specified by $amount and (optionally) from user IDs associated with $api_key specified in a string $from_user_ids.

create_user

my $response = create_user( $api_key,       # REQUIRED
                            $label);        # Optional

Creates a new user associated with $api_key, optionally with a label specified by $label.

get_users

my $response = get_users(   $api_key);      # REQUIRED

Returns a list of users associated with $api_key.

get_user_balance

my $response = get_user_balance(
                            $api_key,       # REQUIRED
                            $user_id);      # REQUIRED

Get the balance of $user_id associated with $api_key.

get_user_address

my $response = get_user_address(
                            $api_key,       # REQUIRED
                            $user_id);      # REQUIRED

Get the address of $user_id associated with $api_key.

get_user_received

my $response = get_user_received(
                            $api_key,       # REQUIRED
                            $user_id);      # REQUIRED

Get the amount received by $user_id associated with $api_key.

withdraw_from_user

See withdraw; as far as I can tell, this is just another name for it.

get_current_price

AUTHOR

Ryan Northrup, <northrup at cpan.org>

BUGS

Please report any bugs or feature requests to bug-finance-blockio at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Finance-BlockIO. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Finance::BlockIO

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Ryan Northrup.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.