view release on metacpan or  search on metacpan

lib/Finance/Alpaca/Struct/Trade.pm  view on Meta::CPAN

package Finance::Alpaca::Struct::Trade 0.9904 {
    use strictures 2;
    use feature 'signatures';
    no warnings 'experimental::signatures';
    #
    use Type::Library 0.008 -base, -declare => qw[Trade];
    use Type::Utils;
    use Types::Standard qw[ArrayRef Int Num Ref Str];
    use Types::TypeTiny 0.004 StringLike => { -as => "Stringable" };
    class_type Trade, { class => __PACKAGE__ };
    coerce( Trade, from Ref() => __PACKAGE__ . q[->new($_)] );
    #
    use Moo;
    use lib './lib';
    use Finance::Alpaca::Types;
    has timestamp  => ( is => 'ro', isa => Timestamp, required => 1, coerce => 1, init_arg => 't' );
    has exchange   => ( is => 'ro', isa => Str,       required => 1, coerce => 1, init_arg => 'x' );
    has tape       => ( is => 'ro', isa => Str,       required => 1, init_arg => 'z' );
    has price      => ( is => 'ro', isa => Num,       required => 1, init_arg => 'p' );
    has id         => ( is => 'ro', isa => Int,       required => 1, init_arg => 'i' );
    has size       => ( is => 'ro', isa => Int,       required => 1, init_arg => 's' );
    has conditions => ( is => 'ro', isa => ArrayRef [Str], required => 1, init_arg => 'c' );
    has symbol     => ( is => 'ro', isa => Str, predicate => 1, init_arg => 'S' );  # If from stream
}
1;
__END__

=encoding utf-8

=head1 NAME

Finance::Alpaca::Struct::Trade - A Single Trade Object

=head1 SYNOPSIS

    use Finance::Alpaca;
    my %trades = Finance::Alpaca->new( ... )->trades(
        symbol    => 'MSFT',
        start     => Time::Moment->now->with_day_of_week(2),
        end       => Time::Moment->now->with_hour(12)->with_day_of_week(3)
    );

    say $quotes[0]->ap;

=head1 DESCRIPTION

The quote API provides historical trade data for a given ticker symbol on a
specified date.

=head1 Properties

The following properties are contained in the object.

    $trade-timestamp;

=over

=item C<timestamp> - Timestamp with nanosecond precision as a Time::Moment object

=item C<exchange> - Exchange where the trade happened

=item C<price> - Trade price

=item C<size> - Trade size

=item C<conditions> - Trade conditions

=item C<id> - Trade ID

=item C<tape> - Tape

=item C<symbol> - Symbol; only provided if data is from a Finance::Alpaca::Stream session

=back

=head1 LICENSE

Copyright (C) Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under
the terms found in the Artistic License 2. Other copyrights, terms, and
conditions may apply to data transmitted through this module.