fmp_py.fmp_ipo_calendar

Classes

FmpIpoCalendar

Module Contents

class fmp_py.fmp_ipo_calendar.FmpIpoCalendar(api_key: str = os.getenv('FMP_API_KEY'))

Bases: fmp_py.fmp_base.FmpBase

ipo_calendar_by_symbol(from_date: str, to_date: str) → pandas.DataFrame

Retrieves IPO calendar data for a specific symbol within a given date range. :param from_date: The starting date of the date range in “YYYY-MM-DD” format. :type from_date: str :param to_date: The ending date of the date range in “YYYY-MM-DD” format. :type to_date: str

Returns:

A DataFrame containing IPO calendar data for the specified symbol within the given date range.

Return type:

pd.DataFrame

ipo_prospectus(from_date: str, to_date: str) → pandas.DataFrame

Retrieves IPO prospectus data from the specified date range. :param from_date: The starting date of the date range in “YYYY-MM-DD” format. :type from_date: str :param to_date: The ending date of the date range in “YYYY-MM-DD” format. :type to_date: str

Returns:

A DataFrame containing IPO prospectus data with the following columns:

  • symbol (str): The symbol of the IPO.

  • cik (str): The CIK (Central Index Key) of the IPO.

  • form (str): The form type of the IPO.

  • filing_date (datetime64[ns]): The filing date of the IPO.

  • accepted_date (datetime64[ns]): The accepted date of the IPO.

  • ipo_date (datetime64[ns]): The IPO date.

  • price_public_per_share (float): The price per share for the public offering.

  • price_public_total (float): The total price for the public offering.

  • discounts_and_commissions_per_share (float): The discounts and commissions per share.

  • discounts_and_commissions_total (float): The total discounts and commissions.

  • proceeds_before_expenses_per_share (float): The proceeds per share before expenses.

  • proceeds_before_expenses_total (float): The total proceeds before expenses.

  • url (str): The URL of the IPO prospectus.

Return type:

pd.DataFrame

Raises:

ValueError – If from_date is greater than to_date or if there is an error fetching the IPO calendar data.

ipo_confirmed(from_date: str, to_date: str) → pandas.DataFrame

Retrieves the IPO calendar data for confirmed IPOs within the specified date range. :param from_date: The start date of the date range in the format “YYYY-MM-DD”. :type from_date: str :param to_date: The end date of the date range in the format “YYYY-MM-DD”. :type to_date: str

Returns:

A DataFrame containing the IPO calendar data for confirmed IPOs, sorted by filing date.

Return type:

pd.DataFrame

Raises:

ValueError – If from_date is greater than to_date or if there is an error fetching the IPO calendar data.