NAME

Finance::Alpaca::Struct::Asset - A Single Account Object

SYNOPSIS

use Finance::Alpaca;
Finance::Alpaca->new( ... )->assets;

DESCRIPTION

The assets API serves as the master list of assets available for trade and data consumption from Alpaca. Assets are sorted by asset class, exchange and symbol. Some assets are only available for data consumption via Polygon, and are not tradable with Alpaca. These assets will be marked with the flag tradable=false.

Properties

The following properties are contained in the object.

$account->id;

id - UUID

class - String (us_equity)

exchange - AMEX, ARCA, BATS, NYSE, NASDAQ, NYSEARCA, or OTC

symbol - String

status - active or inactive

tradable - Boolean indicating whether the asset is tradable on Alpaca or not

marginable - Boolean indicating whether the asset is marginable or not

shortable - Boolean indicating whether the asset is shortable or not

easy_to_borrow - Boolean indicating the asset is easy-to-borrow or not (filtering for easy_to_borrow = True is the best way to check whether the name is currently available to short at Alpaca)

fractionable - Boolean indicating the asset is fractionable or not

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>