pandas.DataFrame.to_json — pandas 0.24.0rc1 documentation (original) (raw)

Parameters:

path_or_buf : string or file handle, optional

File path or object. If not specified, the result is returned as a string.

orient : string

Indication of expected JSON string format.

• Series
  • default is ‘index’
  • allowed values are: {‘split’,’records’,’index’,’table’}
• DataFrame
  • default is ‘columns’
  • allowed values are: {‘split’,’records’,’index’,’columns’,’values’,’table’}
• The format of the JSON string
  • ‘split’ : dict like {‘index’ -> [index], ‘columns’ -> [columns], ‘data’ -> [values]}
  • ‘records’ : list like [{column -> value}, … , {column -> value}]
  • ‘index’ : dict like {index -> {column -> value}}
  • ‘columns’ : dict like {column -> {index -> value}}
  • ‘values’ : just the values array
  • ‘table’ : dict like {‘schema’: {schema}, ‘data’: {data}} describing the data, and the data component is like orient='records'.
    Changed in version 0.20.0.

date_format : {None, ‘epoch’, ‘iso’}

Type of date conversion. ‘epoch’ = epoch milliseconds, ‘iso’ = ISO8601. The default depends on the orient. Fororient='table', the default is ‘iso’. For all other orients, the default is ‘epoch’.

double_precision : int, default 10

The number of decimal places to use when encoding floating point values.

force_ascii : bool, default True

Force encoded string to be ASCII.

date_unit : string, default ‘ms’ (milliseconds)

The time unit to encode to, governs timestamp and ISO8601 precision. One of ‘s’, ‘ms’, ‘us’, ‘ns’ for second, millisecond, microsecond, and nanosecond respectively.

default_handler : callable, default None

Handler to call if object cannot otherwise be converted to a suitable format for JSON. Should receive a single argument which is the object to convert and return a serialisable object.

lines : bool, default False

If ‘orient’ is ‘records’ write out line delimited json format. Will throw ValueError if incorrect ‘orient’ since others are not list like.

New in version 0.19.0.

compression : {‘infer’, ‘gzip’, ‘bz2’, ‘zip’, ‘xz’, None}

A string representing the compression to use in the output file, only used when the first argument is a filename. By default, the compression is inferred from the filename.

New in version 0.21.0.

Changed in version 0.24.0: ‘infer’ option added and set to default

index : bool, default True

Whether to include the index values in the JSON string. Not including the index (index=False) is only supported when orient is ‘split’ or ‘table’.

New in version 0.23.0.