The unofficial Substack API wrapper for Python.
Project description
Substack-api
An unofficial Python wrapper around Substack's API.
I developed this package as a lightweight tool to help researchers collect data about Substack newsletters, and to help writers archive their work off-platform. This is not a tool designed for bulk text extraction/web scraping. It supports the following functionality:
- Download full JSON metadata about newsletters by category
- Download full JSON metadata about posts by newsletter
- Download text of individual, publicly-available posts
- List newsletter categories
Installation
pip install substack-api
Usage
import substack_api
List all categories on Substack:
substack_api.list_all_categories()
Get metadata for the first 2 pages of Technology newsletters:
substack_api.get_newsletters_in_category(4, start_page=0, end_page=2)
Get post metadata for the most recent 30 posts from a newsletter:
substack_api.get_newsletter_post_metadata("platformer", start_offset=0, end_offset=30)
Get post contents (HTML only) from one newsletter post:
substack_api.get_post_contents("platformer", "how-a-single-engineer-brought-down", html_only=True)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
substack_api-0.0.1.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for substack_api-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4f4a3e7e582bf7caf100cbe9b7b49d3341462c07ab6a8b5eb95ecff8ab85209 |
|
MD5 | 9b7c988e1c8cb37c968b428dc87434af |
|
BLAKE2b-256 | 8091f96d8ab9113a6bb8ec200c7939b3a40cdf34360fb437aa2981c14798d2f2 |