Authentication & Setup

Credentials

Obtain from https://www.zotero.org/settings/keys:

Credential	Where to Find
User ID	"Your userID for use in API calls" section
API Key	Create new key at /settings/keys/new
Group Library ID	Integer after `/groups/` in group URL (e.g. `https://www.zotero.org/groups/169947`)

Environment Variables

Store in .env or export in shell:

ZOTERO_LIBRARY_ID=436
ZOTERO_API_KEY=ABC1234XYZ
ZOTERO_LIBRARY_TYPE=user

Load in Python:

import os
from dotenv import load_dotenv
from pyzotero import Zotero

load_dotenv()

zot = Zotero(
    library_id=os.environ['ZOTERO_LIBRARY_ID'],
    library_type=os.environ['ZOTERO_LIBRARY_TYPE'],
    api_key=os.environ['ZOTERO_API_KEY']
)

Library Types

# Personal library
zot = Zotero('436', 'user', 'ABC1234XYZ')

# Group library
zot = Zotero('169947', 'group', 'ABC1234XYZ')

Important: A Zotero instance is bound to a single library. To access multiple libraries, create multiple instances.

Local Mode (Read-Only)

Connect to your local Zotero installation without an API key. Only supports read requests.

zot = Zotero(library_id='436', library_type='user', local=True)
items = zot.items(limit=10)  # reads from local Zotero

Optional Parameters

zot = Zotero(
    library_id='436',
    library_type='user',
    api_key='ABC1234XYZ',
    preserve_json_order=True,   # use OrderedDict for JSON responses
    locale='en-US',             # localise field names (e.g. 'fr-FR' for French)
)

Key Permissions

Check what the current API key can access:

info = zot.key_info()
# Returns dict with user info and group access permissions

Check accessible groups:

groups = zot.groups()
# Returns list of group libraries accessible to the current key

API Key Scopes

When creating an API key at https://www.zotero.org/settings/keys/new, choose appropriate permissions:

Read Only: For retrieving items and collections
Write Access: For creating, updating, and deleting items
Notes Access: To include notes in read/write operations
Files Access: Required for uploading attachments

2.2 KiB Raw Blame History