Skip to main content

logo

Readwise API

An unofficial Python client for the Readwise Reader API.

Installation

pip install readwise-api

Usage

Prerequisites

First, you have to obtain a Readwise access token. Then, the token has to be stored, either into an .env file or an environment variable using export READWISE_TOKEN=<your_token>.

Python API

import readwise

List all documents:

readwise.get_documents(location="new")

Get a single document by its ID:

readwise.get_document_by_id("<document_id>")

CLI

List all documents:

readwise list new

Naturally, the output can be saved to a JSON file:

readwise list new > new_documents.json

Get a single document by its ID:

readwise get <document_id>

Metadata

Release files for readwise-api 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for readwise-api 0.3.0
File Size Uploaded Provenance
readwise_api-0.3.0.tar.gz 5.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for readwise-api 0.3.0
File Interpreter ABI Platform
readwise_api-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 12.8 kB

Release files / readwise_api-0.3.0.tar.gz

Download URL readwise_api-0.3.0.tar.gz
Size 5.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8375853b147007f0709d48bc8601f871e104f48afdfe8bf6364c3ac0a82f8c6f
BLAKE2b-256 checksum
How to use checksums
ac36c0292cd3564d4704b13c54c35326d909d188adbde4360c177e7920074651
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.3 Darwin/20.6.0

Release files / readwise_api-0.3.0-py3-none-any.whl

Download URL readwise_api-0.3.0-py3-none-any.whl
Size 7.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6815d02186e429d67c1484156b4f31065f7696d24dc5c4ebfc67350179f3fe50
BLAKE2b-256 checksum
How to use checksums
4a2b1648646c62ebfeb3507f892d37ecd1c03090143617101e4427dcbf33483c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.3 Darwin/20.6.0

Security for readwise-api 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page