Scroll to navigation

Finance::Quote::FinanceAPI(3pm) User Contributed Perl Documentation Finance::Quote::FinanceAPI(3pm)

NAME

Finance::Quote::FinanceAPI - Obtain quotes from financeapi.net.

SYNOPSIS

    use Finance::Quote;
    # API Key passed during object creation
    $q = Finance::Quote->new('FinanceAPI', financeapi => {API_KEY => 'your-financeapi-api-key'});
    # FINANCEAPI_API_KEY environment variable set
    $q = Finance::Quote->new;
    %info = $q->fetch("financeapi", "AAPL");  # Only query financeapi

DESCRIPTION

This module fetches information from <https://financeapi.net/>. The API URL is https://yfapi.net/.

This module is loaded by default on a Finance::Quote object. It's also possible to load it explicitly by placing "financeapi" in the argument list to Finance::Quote->new().

This module provides the "financeapi" fetch method. In addition it advertises "nyse", "usa", and "nasdaq".

API_KEY

<https://financeapi.net/> requires users to register for an API Key (token). The free "Basic" API Key allows 100 queries per day and a 300 per minute rate.

The API key may be set by either providing a module specific hash to Finance::Quote->new as in the above example, or by setting the environment variable FINANCEAPI_API_KEY.

LABELS RETURNED

The following labels are returned:

2024-09-22 perl v5.38.2