Skip to main content

Google/Excel Sheets API Python.

Project description


Google/Excel Sheets API Python Client. For use with

Build Status PyPI version


Install using pip...

pip install sheet2api

Usage Examples

Before starting you should head over to and link up your Google Sheets or Excel Online account and create your first Spreadsheet API.

Next, create an instance of the client and pass in the API URL to your API.

from sheet2api import Sheet2APIClient

client = Sheet2APIClient(api_url='')
# If your API has authentication enabled
client = Sheet2APIClient(

Get all rows

Returns all rows within the first Sheet of your Spreadsheet.


# Returns a list of dicts
	'name': 'Bob',
	'age': 22
}, {
	'name': 'Richard',
	'age': 19
}, {
	'name': 'Bob Jones',
	'age': 99

To return rows from a specific Sheet.


Get all rows matching a query

Returns all rows matching a query.

client.get_rows(query={'name': 'Bob'})

Create a new row

client.create_row(sheet='Sheet1', row={'name': 'Jane','age': 18})

Update all rows which match a query

This will update the entire row for the matches, if you fail to specificy all column values in the replacement row, those cells will be filled with an empty value.

    query={'name': 'Philip'},
        'name': 'Phil',
        'age': 99999

Partially update rows matching a query.

This will only update the columns which you provide replacement values for in the row dict parameter. All other columns will be left unchanged.

    query={'name': 'Philip'},
        'age': 99999

Delete all rows matching a query

client.delete_rows(sheet='Sheet1', query={'name': 'Satan'})


Contact support

Release History

0.1.3 (2020-08-01)

  • Docs fixes.

0.1.2 (2020-05-10)

  • Documentation updates.

0.1.1 (2020-05-07)

  • Documentation updates.

0.1.0 (2020-05-06)

  • Initial release.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sheet2api-0.1.3.tar.gz (4.6 kB view hashes)

Uploaded source

Built Distribution

sheet2api-0.1.3-py2.py3-none-any.whl (7.3 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page