/ 
Finance-Nadex-0.12
River stage zero No dependents
/ Finance::Nadex::Contract

NAME

Finance::Nadex::Contract - Provides information about a contract available for trading on the North American Derivatives Exchange

VERSION

Version 0.01

SYNOPSIS

Container for information about contracts; used by Finance::Nadex; not meant to be instantiated directly in client code; certain methods in Finance::Nadex return an instance or list of Finance::Nadex::Contract objects; the accessor methods below can be used to retrieve information from the object instances; see Finance::Nadex for information about methods which retrieve positions

ACCESSORS

bid

Retrieves the current highest bid for the contract (example: "30.00")

bidsize

Retrieves the number of contracts bid at the current highest bid

contract

Retrieves the name of the contract (example: "GBP/USD >1.5120 (3PM)")

epic

Retrieves the unique identifier for the contract as created by the exchange (example: "NB.D.OPT-GBP-USD.1-1-15Jan15")

expirydate

Retrieves the date on which the contract will expire (example: "20-JAN-15")

offer

Retrieves the current lowest offer for the contract (example: "20.50")

offersize

Retrieves the number of contracts offered at the current lowest offer

type

Retrieves the type of contract: one of 'binary', 'spread', or 'event'

AUTHOR

mhandisi, <mhandisi at cpan.org>

BUGS

Please report any bugs or feature requests to bug-finance-nadex at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Finance-Nadex. 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::Nadex::Contract

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2015 mhandisi.

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.