Skip to main content

__ Back to top

__ ` Ctrl ` \+ ` K `

[ ![pandas 2.2.2 documentation - Home](../_static/pandas.svg) ](../index.html)

Site Navigation

  * [ Getting started ](../getting_started/index.html)
  * [ User Guide ](../user_guide/index.html)
  * API reference 
  * [ Development ](../development/index.html)
  * [ Release notes ](../whatsnew/index.html)

  * [ __ GitHub  ](https://github.com/pandas-dev/pandas "GitHub")
  * [ __ Twitter  ](https://twitter.com/pandas_dev "Twitter")
  * [ __ Mastodon  ](https://fosstodon.org/@pandas_dev "Mastodon")

Site Navigation

  * [ Getting started ](../getting_started/index.html)
  * [ User Guide ](../user_guide/index.html)
  * API reference 
  * [ Development ](../development/index.html)
  * [ Release notes ](../whatsnew/index.html)

  * [ __ GitHub  ](https://github.com/pandas-dev/pandas "GitHub")
  * [ __ Twitter  ](https://twitter.com/pandas_dev "Twitter")
  * [ __ Mastodon  ](https://fosstodon.org/@pandas_dev "Mastodon")

  * [ Input/output ](io.html)
  * [ General functions ](general_functions.html)
  * [ Series ](series.html)
  * [ DataFrame ](frame.html)
  * [ pandas arrays, scalars, and data types ](arrays.html)
  * [ Index objects ](indexing.html)
  * [ Date offsets ](offset_frequency.html)
  * [ Window ](window.html)
  * [ GroupBy ](groupby.html)
  * [ Resampling ](resampling.html)
  * [ Style ](style.html)
  * [ Plotting ](plotting.html)
  * [ Options and settings ](options.html)
  * [ Extensions ](extensions.html)
  * [ Testing ](testing.html)
  * [ Missing values ](missing_value.html)

  * [ __ ](../index.html)
  * API reference 

#  API reference  #

This page gives an overview of all public pandas objects, functions and
methods. All classes and functions exposed in ` pandas.*  ` namespace are
public.

The following subpackages are public.

  * ` pandas.errors  ` : Custom exception and warnings classes that are raised by pandas. 

  * ` pandas.plotting  ` : Plotting public API. 

  * ` pandas.testing  ` : Functions that are useful for writing tests involving pandas objects. 

  * ` pandas.api.extensions  ` : Functions and classes for extending pandas objects. 

  * ` pandas.api.indexers  ` : Functions and classes for rolling window indexers. 

  * ` pandas.api.interchange  ` : DataFrame interchange protocol. 

  * ` pandas.api.types  ` : Datatype classes and functions. 

  * ` pandas.api.typing  ` : Classes that may be necessary for type-hinting. These are classes that are encountered as intermediate results but should not be instantiated directly by users. These classes are not to be confused with classes from the [ pandas-stubs ](https://github.com/pandas-dev/pandas-stubs) package which has classes in addition to those that occur in pandas for type-hinting. 

In addition, public functions in ` pandas.io  ` and ` pandas.tseries  `
submodules are mentioned in the documentation.

Warning

The ` pandas.core  ` , ` pandas.compat  ` , and ` pandas.util  ` top-level
modules are PRIVATE. Stable functionality in such modules is not guaranteed.

  * [ Input/output ](io.html)
    * [ Pickling ](io.html#pickling)
    * [ Flat file ](io.html#flat-file)
    * [ Clipboard ](io.html#clipboard)
    * [ Excel ](io.html#excel)
    * [ JSON ](io.html#json)
    * [ HTML ](io.html#html)
    * [ XML ](io.html#xml)
    * [ Latex ](io.html#latex)
    * [ HDFStore: PyTables (HDF5) ](io.html#hdfstore-pytables-hdf5)
    * [ Feather ](io.html#feather)
    * [ Parquet ](io.html#parquet)
    * [ ORC ](io.html#orc)
    * [ SAS ](io.html#sas)
    * [ SPSS ](io.html#spss)
    * [ SQL ](io.html#sql)
    * [ Google BigQuery ](io.html#google-bigquery)
    * [ STATA ](io.html#stata)
  * [ General functions ](general_functions.html)
    * [ Data manipulations ](general_functions.html#data-manipulations)
    * [ Top-level missing data ](general_functions.html#top-level-missing-data)
    * [ Top-level dealing with numeric data ](general_functions.html#top-level-dealing-with-numeric-data)
    * [ Top-