/ 
Finance-Robinhood-0.92_003
River stage zero No dependents
/ Finance::Robinhood::Options::Instrument

NAME

Finance::Robinhood::Options::Instrument - Represents a Single Options Instrument

SYNOPSIS

use Finance::Robinhood;
my $rh = Finance::Robinhood->new;
my $instruments = $rh->options_instruments();

for my $instrument ($instruments->all) {
    CORE::say $instrument->chain_symbol;
}

METHODS

chain_id()

chain_symbol()

id( )

UUID used to identify this instrument.

min_ticks( )

Returns a hash reference with the following keys:

above_tick - Minimum tick size when applicable.
below_tick - Minimum tick size when applicable.
cutoff_price - At this price or more, the above_tick will apply. Below this price, the below_tick is required.

rhs_tradability( )

Exposes whether or not this instrument can be traded on Robinhood. Either tradable or untradable.

state( )

strike_price( )

The strike of this particular instrument.

tradability( )

Indicates whether this instrument is being traded in general.

type( )

Indicated whether this is a call or put.

expiration_date( )

Returns a Time::Moment object.

issue_date( )

Returns a Time::Moment object.

created_at( )

Returns a Time::Moment object.

updated_at( )

Returns a Time::Moment object.

LEGAL

This is a simple wrapper around the API used in the official apps. The author provides no investment, legal, or tax advice and is not responsible for any damages incurred while using this software. This software is not affiliated with Robinhood Financial LLC in any way.

For Robinhood's terms and disclosures, please see their website at https://robinhood.com/legal/

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. Please refer to the LEGAL section.

AUTHOR

Sanko Robinson <sanko@cpan.org>