File Coverage

lib/Finance/GDAX/API/UserAccount.pm

Criterion	Covered	Total	%
statement	14	18	77.7
branch			n/a
condition			n/a
subroutine	5	6	83.3
pod	1	1	100.0
total	20	25	80.0

package Finance::GDAX::API::UserAccount;
our $VERSION = '0.02';
use 5.20.0;
use warnings;
use Moose;
use Finance::GDAX::API;
use namespace::autoclean;

extends 'Finance::GDAX::API';

sub trailing_volume {
    my $self = shift;
    $self->method('GET');
    $self->path('/users/self/trailing-volume');
    return $self->send;
}

__PACKAGE__->meta->make_immutable;
1;

=head1 NAME

Finance::GDAX::API::UserAccount - Account Info

=head1 SYNOPSIS

  use Finance::GDAX::API::UserAccount;

  $account = Finance::GDAX::API::UserAccount->new;

  # List of trailing volume
  $trailing = $account->trailing_volume;

=head2 DESCRIPTION

Returns a list of hashes, representing the Trailing Volume on the account.

=head1 METHODS

=head2 C<trailing_volume>

From the GDAX API:

This request will return your 30-day trailing volume for all
products. This is a cached value that's calculated every day at
midnight UTC.

  [
    {
        "product_id": "BTC-USD",
        "exchange_volume": "11800.00000000",
        "volume": "100.00000000",
        "recorded_at": "1973-11-29T00:05:01.123456Z"
    },
    {
        "product_id": "LTC-USD",
        "exchange_volume": "51010.04100000",
        "volume": "2010.04100000",
        "recorded_at": "1973-11-29T00:05:02.123456Z"
    }
  ]

=cut


=head1 AUTHOR

Mark Rushing <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Home Grown Systems, SPC.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut