NAME

Finance::Alpaca::Struct::Calendar - A Single Calendar Date Object

SYNOPSIS

    use Finance::Alpaca;
    my @days = $camelid->calendar(
        start => Time::Moment->now,
        end   => Time::Moment->now->plus_days(14)
    );
    for my $day (@days) {
        say sprintf '%s the market opens at %s Eastern',
            $day->date, $day->open;
    }

DESCRIPTION

The calendar endpoint serves the full list of market days from 1970 to 2029. It can also be queried by specifying a start and/or end time to narrow down the results. In addition to the dates, the response also contains the specific open and close times for the market days, taking into account early closures.

Properties

A calendar day contains the following properties:

    $day->date();

date - Date string in "%Y-%m-%d" format

open - The time the market opens at on this date in "%H:%M" format

close - The time the market closes at on this date in "%H:%M" format

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.

AUTHOR

Sanko Robinson <sanko@cpan.org>