pyAirtable Python SDK

3.3.0 · active · verified Tue Mar 17

Official community Python client for the Airtable API. Formerly known as airtable-python-wrapper. Current version is 3.3.0 (Nov 2025). Has gone through major rewrites at 1.0, 2.0, and 3.0 — each with breaking changes. Many tutorials still reference the old airtable-python-wrapper package which is abandoned.

Warnings

breaking Airtable deprecated legacy API keys in January 2024. They no longer work. All code using api_key='key...' strings will fail with 401.
Fix: Generate a Personal Access Token at airtable.com/create/tokens and use that instead. Scopes must be explicitly granted per base.
breaking airtable-python-wrapper is the old abandoned package. Package name changed to pyairtable at 1.0.0. Installing airtable-python-wrapper gives you dead code.
Fix: pip install pyairtable — not airtable or airtable-python-wrapper.
breaking Pydantic 1.x support dropped in pyairtable 3.x. Will fail to import if Pydantic 1.x is installed.
Fix: pip install 'pydantic>=2.0'
breaking Table(api_key, base_id, table_name) constructor with raw strings deprecated in 2.0, raises TypeError in 3.0. Most tutorials and LLM-generated code still use this pattern.
Fix: api = Api(token); table = api.table(base_id, table_name)
breaking pyairtable.metadata module removed in 3.0. Any code importing from it will fail.
Fix: Use api.base(base_id).schema() for metadata access.
gotcha Model.save() return type changed from bool to SaveResult in 3.x. Code checking 'if record.save():' will break silently — SaveResult is always truthy.
Fix: Check SaveResult.created or SaveResult.updated explicitly.
gotcha return_fields_by_field_id= parameter renamed to use_field_ids= in 3.x.
Fix: Replace return_fields_by_field_id=True with use_field_ids=True.
deprecated Python 3.9 support dropped in 3.3.0 (Nov 2025).
Fix: Use Python 3.10+.

Install

pip install pyairtable Python (core)
pip install pyairtable[cli] Python (with CLI and ORM generator)

Imports

Api
```
from pyairtable import Api
```
airtable-python-wrapper is the old abandoned package. pyairtable is the maintained successor. Do not confuse the two.
Table
```
api = Api(api_key); table = api.table(base_id, table_name)
```
Passing raw strings to Table() constructor is deprecated since 2.0. Always construct via Api instance.

Quickstart

Minimal Airtable read/write using pyairtable 3.3.x.

from pyairtable import Api

api = Api('YOUR_PERSONAL_ACCESS_TOKEN')  # not API key — deprecated
table = api.table('BASE_ID', 'TABLE_NAME')

# fetch all records
records = table.all()

# create a record
table.create({'Name': 'New Row', 'Status': 'Active'})

view raw JSON →