ao3-py
An unofficial, typed, synchronous Python SDK for Archive of Our Own.
ao3-py turns AO3 pages into lazy domain objects. Constructing a Work, Tag,
User, or another model creates only a lightweight handle. The first property that
needs remote data loads it through httpx, and the parsed state is then cached on
that object. The SDK reads AO3's HTML pages and submits its forms for supported
actions.
Table of contents
- Design highlights
- Installation
- Quick start
- Object and loading model
- Login
- Authenticated actions
- Browsing tags and languages
- Works, chapters, comments, kudos, and downloads
- Users and pseuds
- Media and fandom indexes
- Series, collections, bookmarks, and external works
- API reference
- Adult content
- Network and parsing behavior
- Disclaimer
Design highlights
- Standalone models use one process-wide client that is created lazily; there is no
default-client setup API to call before
Work.from_url(...). - Explicit
AO3Clientsessions provide login, custom cookies, a mutable origin, and deterministic connection-pool lifetime. - HTTP/2 is preferred when AO3 supports it, with HTTP/1.1 negotiated automatically.
- List pages produce lightweight, summary-backed models instead of eagerly loading every result and causing an N+1 request pattern.
- Metadata relationships such as
work.tags,work.pseuds, andwork.seriesreturn fresh handles. Listing pages retain their parsed result objects. - Metadata, full chapter content, and independent listings such as comments or bookmarks have separate lazy caches, so callers only pay for the data they use.
- Plain text and the corresponding parsed HTML fragments are exposed separately where AO3 provides rich user content.
- Models follow AO3 terminology: a
Useris the account and aPseudis the public identity attached to works, series, bookmarks, and comments. - Read and write operations live on the object they affect: for example,
work.create_bookmark(),comment.reply(), andseries.subscribe(). - Parser records, references, and page containers are nested under their owning model, keeping the public module layout small and cohesive.
Installation
ao3-py requires Python 3.10 or newer.
uv add ao3-py
or:
pip install --upgrade ao3-py
Quick start
Examples use placeholders such as WORK_ID, TAG_NAME, TAG_URL, and SERIES_ID.
Replace them with the resources you want to access. Later snippets that use client
assume an open AO3Client, and snippets that use work assume a work created through
that client.
from ao3 import Work
# Both constructors create a lightweight handle without making a request.
work = Work.from_id(WORK_ID)
work = Work.from_url(f"https://archiveofourown.org/works/{WORK_ID}")
# The first metadata-backed property loads and caches the work page.
print(work.title)
print(work.pseuds)
print(work.words, work.kudos_count, work.hits)
for tag in work.tags:
print(tag.kind, tag.name)
# Full chapter content is loaded separately from metadata.
for chapter in work.chapters:
print(chapter.id, chapter.position, chapter.title, chapter.published)
print(chapter.content)
content, summary, notes, and similar properties contain plain text. Their
matching content_html, summary_html, and notes_html properties retain the parsed
HTML fragment when one is available.
Object and loading model
Summary, detail, and content states
A handle stores identity, paging options, and a client. It does not load its page in the constructor:
from ao3 import Tag, Work
work = Work.from_id(WORK_ID) # no request
tag = Tag(TAG_NAME) # no request
print(work.title) # loads work metadata once
print(work.title) # uses the cached result
Objects produced by list pages already contain the information visible in that list.
Reading a summary field such as title, summary, tags, or work statistics does
not immediately fetch every individual work:
tag = Tag(TAG_NAME)
for work in tag.works:
print(work.title, work.words, work.complete)
For a Work, these states are deliberately separate:
- A result from a work index may already contain a summary, tags, creators, and statistics.
- A metadata-only handle loads
detailthe first time a detail-backed property is needed. chaptersrequests and parses content separately, then also updates the work's cached metadata. A chapter-specific handle loads only that chapter's content.comments_page,bookmarks_page, andkudos.detailare independent listings and therefore have independent caches.
This gives list-heavy applications useful summary data without fetching every work, while still making the complete resource available through the same object.
Cached properties hold snapshots; there is no automatic refresh interval or public
load() / refresh() method. Construct a new handle to read a resource again.
For a listing, copy(page=...) starts with an unloaded page cache.
Successful writes update or invalidate caches on the object performing the action.
For example, work.create_comment() clears that work's comments_page, and
work.kudos.leave() clears its Kudos detail. Other handles and already-loaded work
statistics are not refreshed, even when they refer to the same resource.
Lightweight relationships
Metadata relationships such as work.fandoms return new lightweight handles. Keep
the returned handle if you want to reuse data loaded through it:
first = tag.works[0].fandoms[0]
second = tag.works[0].fandoms[0]
assert first is not second
assert first.name == second.name
Cached collections retain their items: repeated access to tag.works, for example,
returns the same tuple and work objects. Parsed chapter tuples, comment replies, and
media fandom listings are also cached. Fresh-handle behavior does not apply to every
property that returns a model.
Clients and connection lifetime
When no client is passed, models share an internal process-wide AO3Client. It is
created only when the first standalone model is constructed, and it is intentionally
not exposed as a public configuration concept. Use an explicit client whenever
session identity or lifetime matters.
Models hold a client through composition; they do not inherit networking behavior.
This keeps cookies, HTTP policy, and request lifetime in AO3Client, while the model
owns AO3 terminology, relationships, parsed state, and object-bound actions.
Use an explicit client when you need a bounded connection-pool lifetime, authentication, cookies, or a different AO3 origin:
from ao3 import AO3Client, Work
with AO3Client() as client:
by_id = client.work(id=WORK_ID)
by_url = client.work(url=f"https://archiveofourown.org/works/{WORK_ID}")
from_class = Work.from_id(WORK_ID, client=client)
assert by_id.client is client
assert by_url.client is client
assert from_class.client is client
The same client is passed to related handles returned by a model, so all requests use the same cookies and connection pool.
Custom origin, cookies, and transport settings
from ao3 import AO3Client
with AO3Client(
base_url="https://archiveofourown.org",
cookies=COOKIES,
headers={"Accept-Language": "en-US,en;q=0.9"},
timeout=60,
) as client:
work = client.work(WORK_ID)
print(work.title)
cookies accepts a dictionary or httpx.Cookies; omit it for a new anonymous
session. transport accepts a synchronous httpx.BaseTransport, including an
httpx.MockTransport for offline applications or tests.
Model URLs and relative download links are resolved against the owning client's
current base_url. Absolute download URLs retain the host supplied by AO3.
Changing base_url, cookies, or login state does not clear existing model caches;
create new handles when changing the session or origin.
The built-in client uses a Chrome user agent and enables HTTP/2. httpx negotiates
HTTP/1.1 when HTTP/2 is unavailable. Transport errors and timeouts are left visible to
the caller instead of being hidden behind automatic retries.
Pagination
Listing pages use 1-based page numbers and expose page, page_count, total, and
a model-specific tuple such as works, comments, bookmarks, series,
collections, or pseuds. Page
objects support iteration and len(page); index the contained tuple when random
access is needed:
tag = client.tag(TAG_NAME)
page = tag.works_page
print(len(page), page.total)
if page:
print(page.works[0].title)
for work in page:
print(work.title)
if page.page < page.page_count:
next_page = tag.copy(page=page.page + 1).works_page
The page object itself is not sequence-indexable. copy(page=...) keeps the same
identity and client, preserves other options, and starts without loaded detail or
listing caches. Some models also retain lightweight fields such as a known title,
tag count, or pseud description. Omit page to keep the current page number.
Use copy(page=...) instead of assigning to page on an object whose listings are
already cached. A browse handle's page number applies to each of its independent
listings; related browse handles start at page 1.
AO3 also lists works and bookmarks on noncanonical tag profile pages. These lists
are parsed independently, and tag redirects preserve the requested page.
Work.Page.total and Bookmark.Page.total may be None when the page does not
provide enough information to determine the total. Use page_count to traverse
the available pages rather than calculating it from total or a fixed page size.
For work and chapter comments, and work bookmarks, page 1 is cached on the handle.
Calls to comments_for_page(n) or bookmarks_for_page(n) with n != 1 make a new
request each time; retain the returned page when you want to reuse it.
Login
AO3 currently accepts either a username or an email address in its login form.
Credentials are posted directly to AO3; the password is not retained on
AO3Client.
import os
from ao3 import AO3Client
with AO3Client(timeout=60) as client:
client.login(os.environ["AO3_LOGIN"], os.environ["AO3_PASSWORD"], remember_me=False)
user = client.user("your_ao3_username")
print(user.id, user.joined, user.title)
print(user.pseuds)
print(user.works_page.total)
The session cookies remain inside that client's httpx cookie jar. If AO3 redirects
a protected request to the login page, AO3AuthenticationError is raised.
Log in before creating the handles you intend to use for authenticated reads.
Listings reflect the current account's visibility, including restricted works and
the account's own private bookmarks where AO3 exposes them. client.user(login)
selects an account to browse; it does not authenticate as that account.
Authenticated actions
Kudos and bookmarks
Write operations use the same object relationships as browsing: actions concerning a
work begin on Work or its Kudos, while an existing Bookmark owns its update and
delete operations. They submit immediately and therefore should use an explicitly
authenticated client when AO3 requires an account.
import os
from ao3 import AO3Client
with AO3Client() as client:
client.login(os.environ["AO3_LOGIN"], os.environ["AO3_PASSWORD"])
work = client.work(id=WORK_ID)
# AO3 records this against the logged-in user. Public works also accept
# guest Kudos when the client has not logged in.
work.kudos.leave()
# The default pseud is selected automatically. Pass pseud_id when the
# account has multiple pseuds and another one should own the bookmark.
bookmark = work.create_bookmark(
notes="Read again after the next update.",
tags=["To Reread", "Favorite"],
collections=["collection_name"],
private=True,
recommended=False,
)
bookmark.update(
notes="Finished reading.", tags=["Finished"], private=False, recommended=True
)
bookmark.delete()
For Bookmark.update(), None leaves a field unchanged; an empty string or empty
iterable clears text, tags, or collections. AO3 permits only one bookmark per user for
the same item, so a second create is rejected with AO3ActionError.
tags accepts a comma-separated string or an iterable of strings and Tag objects.
collections accepts a comma-separated string or an iterable of collection names
and Collection objects. create_bookmark() returns a Bookmark; update() returns
the same bookmark with updated parsed data, and delete() returns None.
AO3 exposes POST /kudos for creation and no DELETE /kudos/:id route or delete
form override. Leaving Kudos is therefore one-way for both the sender and the work
creator, and the library deliberately exposes no removal method. Duplicate Kudos,
bookmarking a work twice, attempting to edit somebody else's bookmark, and other
AO3-side business-rule failures raise AO3ActionError.
Comments and replies
Comment creation belongs to the object being commented on. Existing comments own their reply, update, and delete operations. With an authenticated client, only the comment text is required; AO3 supplies the account's default pseud through the returned form:
work = client.work(id=WORK_ID)
comment = work.create_comment("Thank you for writing this!")
reply = comment.reply("One more thought about the ending.")
comment.update("Thank you for writing and sharing this!")
reply.delete()
# A Chapter uses the same operation but posts to that chapter's comment route.
chapter_comment = work.chapters[0].create_comment("I loved this chapter.")
A Work created with a chapter_id also posts comments to that chapter, matching
its chapter-scoped comment listing.
create_comment() and reply() return a new Comment handle; accessing its content
loads the comment permalink. update() returns the same comment with updated
parsed data, and delete() returns None.
When an account has multiple pseuds, pass pseud_id to create_comment(), reply(),
or update(). Do not pass name or email for an authenticated comment.
The optional name and email arguments exist only because AO3 also supports guest
comments on works whose creators allow them. They are used with a client that has not
logged in:
guest_comment = work.create_comment(
"A guest comment.", name=GUEST_NAME, email=GUEST_EMAIL
)
AO3 decides whether the current session may comment, reply, edit, or delete. Rejected
operations raise AO3ActionError; moderated comments may remain visible only to the
commenter and work creator until approved.
Comment deletion has no user-facing restore operation. AO3 destroys a childless comment; when replies exist, it preserves the thread position but wipes the content and marks the comment as deleted.
Subscriptions and Marked for Later
AO3 subscriptions apply to a work, series, or user. subscribe() returns the
corresponding Subscription; calling it for an existing subscription returns that
same server-side relationship instead of creating a duplicate:
work_subscription = work.subscribe()
series_subscription = client.series(SERIES_ID).subscribe()
user_subscription = client.user(USER_LOGIN).subscribe()
print(work_subscription.id, work_subscription.subscribable_type)
# Either form removes a subscription.
work_subscription.delete()
client.series(SERIES_ID).unsubscribe()
user_subscription.delete()
Marked for Later is a work-specific reading-list action:
work.mark_for_later()
# AO3 calls the inverse action “Mark as Read”; it removes the work from the
# Marked for Later list rather than exposing a general read/unread property.
work.mark_as_read()
Subscriptions and Marked for Later require an authenticated AO3Client.
unsubscribe() and Subscription.delete() return None and raise AO3ActionError
if AO3 does not expose an active subscription to remove. Subscription responses must
include AO3's success confirmation; an unexpected response raises AO3ParseError.
Browsing tags and languages
from ao3 import Tag
tag = Tag.from_url(TAG_URL)
page = tag.works_page
print(page.page, page.page_count, page.total)
for work in page:
print(work.id, work.title)
if page.page < page.page_count:
next_page = tag.copy(page=page.page + 1).works_page
Tags also expose bookmarks independently:
for bookmark in tag.bookmarks:
print(bookmark.pseud.byline, bookmark.notes)
copy(page=...) creates another lightweight handle carrying the same identity and
client without copying loaded detail or listing caches. It is available on Tag,
User, Pseud, Series, Collection, ExternalWork, Language, and Kudos.
Languages are lightweight browse handles too. A work exposes both AO3's short code and display name:
language = client.language("zh")
print(language.url, language.works_page.total)
work_language = client.work(WORK_ID).language
if work_language:
print(work_language.short, work_language.name)
Works, chapters, comments, kudos, and downloads
client.work(WORK_ID) loads all available chapters when chapters is accessed.
To read a specific chapter, use client.work(WORK_ID, CHAPTER_ID) or a chapter URL:
chapter_work = client.work(WORK_ID, CHAPTER_ID)
chapter = chapter_work.chapters[0]
print(chapter.position, chapter.content)
print(chapter_work.comments_page.total)
On a chapter-specific handle, chapters, comment listings, and create_comment()
are scoped to that chapter. Metadata statistics such as words, comments_count,
and number_of_posted_chapters still describe the whole work. Bookmarks, Kudos,
subscriptions, downloads, and Marked for Later also apply to the whole work.
work = client.work(id=WORK_ID)
print(work.title)
print(work.summary)
if work.language:
print(work.language.short, work.language.name)
print(work.published, work.updated)
print(work.number_of_posted_chapters, work.expected_number_of_chapters)
print(work.comments_count, work.kudos_count, work.bookmarks_count, work.hits)
print(work.complete, work.restricted)
for chapter in work.chapters:
print(chapter.id, chapter.position, chapter.title, chapter.published)
print(chapter.work.title, chapter.pseuds)
print(chapter.summary_html)
print(chapter.content_html)
for comment in chapter.comments:
print(comment.content)
for comment in work.comments:
if comment.pseud:
author = comment.pseud.byline
elif comment.by_anonymous_creator:
author = "Anonymous Creator"
else:
author = comment.guest_name
print(author, comment.content, comment.replies_count)
for reply in comment.replies:
print(reply.depth, reply.content)
second_comment_page = work.comments_for_page(2)
second_bookmark_page = work.bookmarks_for_page(2)
kudos = work.kudos
print(kudos.users_count, kudos.guest_count, kudos.total)
for user in kudos.users:
print(user.login)
Download links are parsed from the work page and resolved through the same client.
Supported formats are azw3, epub, mobi, pdf, and html:
epub = work.download(file_type="epub")
with open("work.epub", "wb") as file:
file.write(epub)
Users and pseuds
user = client.user("your_ao3_username")
print(user.id, user.joined)
print(user.bio, user.bio_html)
print(user.default_pseud)
for pseud in user.pseuds:
print(pseud.name, pseud.byline)
for work in user.works:
print(work.title)
for series in user.series:
print(series.title)
for bookmark in user.bookmarks:
print(bookmark.bookmarkable)
for collection in user.collections:
print(collection.title)
A Pseud points back to its owning User and exposes its own works, series, and
bookmarks:
pseud = client.pseud("Public Name", "account_login")
print(pseud.user.login)
print(pseud.works_page.total)
Media and fandom indexes
The AO3 media index is cached once per client. index_fandoms exposes the fandoms
shown in that index without implying a separate AO3 "hot tag" concept, while
fandoms loads the complete fandom list for one media category:
for media in client.media_index:
print(media.name)
games = client.media("Video Games")
for fandom in games.index_fandoms:
print(fandom.name, fandom.works_count)
for fandom in games.fandoms:
print(fandom.letter, fandom.name, fandom.works_count)
Series, collections, bookmarks, and external works
series = client.series(SERIES_ID)
print(series.title, series.summary, series.complete)
for work in series.works:
print(work.title)
collection = client.collection("collection_name")
print(collection.title, collection.description)
print(collection.closed, collection.moderated)
print(collection.works_count, collection.bookmarks_count)
print(collection.works, collection.bookmarks, collection.subcollections)
bookmark = client.bookmark(BOOKMARK_ID)
print(bookmark.pseud, bookmark.created, bookmark.notes)
print(bookmark.tags, bookmark.collections)
print(bookmark.recommended, bookmark.private)
# bookmarkable is a lightweight Work, Series, ExternalWork, or None.
print(bookmark.bookmarkable)
external = client.external_work(EXTERNAL_WORK_ID)
print(external.title, external.author, external.url)
print(external.tags, external.bookmarks)
API reference
This section documents the application-level API exported from ao3. Nested
Data, Reference, and Parsed classes, model parser methods, and
AO3Client.fetch_* methods connect the HTML/network layer to the domain layer; they
remain available for library development but are not the recommended entry points
for application code.
Unless noted otherwise, a model accepts client=AO3Client(...). Browse models also
accept page=1 and view_adult=True.
from_url() constructors extract identity from the URL path. Query parameters and
fragments do not configure the handle; pass page and view_adult explicitly where
supported. Resource URLs use the selected client's origin rather than adopting the
origin of the supplied URL.
All supported application-level names can be imported from the package root:
from ao3 import (
AO3ActionError,
AO3AuthenticationError,
AO3Client,
AO3Error,
AO3InvalidURLError,
AO3ParseError,
Bookmark,
Chapter,
Collection,
Comment,
ExternalWork,
Kudos,
Language,
Media,
Pseud,
Series,
Subscription,
Tag,
TagKind,
User,
Work,
)
AO3Client
All constructor arguments are keyword-only.
AO3Client(
base_url="https://archiveofourown.org",
cookies=None,
headers=None,
timeout=30,
transport=None,
)
| Member | Behavior |
|---|---|
http |
The underlying synchronous httpx.Client and its cookie jar. |
base_url |
Read/write origin used to resolve model and download URLs. |
get(url, **kwargs) / post(url, **kwargs) |
Perform an HTTP request, raise for non-success status, and detect redirects to AO3 login. |
login(login, password, *, remember_me=False) |
Authenticate the current cookie session and return the client. login accepts an AO3 username or email address. |
close() |
Close the connection pool. |
with AO3Client() as client |
Close the client automatically on context exit. |
media_index |
Lazily parse and cache the top-level AO3 media index once per client. |
Custom headers override the default headers case-insensitively, including
User-Agent and Accept.
Resource factories return unloaded handles bound to this client:
| Factory | Result |
|---|---|
work(id, chapter_id=None, *, view_adult=True) |
Work by ID, optionally retaining a chapter ID. |
work(url=..., *, view_adult=True) |
Work parsed from a work or chapter URL. |
tag(name, *, page=1, view_adult=True) |
Tag browse handle. |
language(short, name=None, *, page=1, view_adult=True) |
Language work listing. |
media(name) |
Media fandom index. |
user(login, *, page=1, view_adult=True) |
AO3 User account. |
pseud(name, user_login, *, page=1, view_adult=True) |
Public Pseud owned by a user. |
series(series_id, *, page=1, view_adult=True) |
Series by ID. |
collection(name, *, page=1, view_adult=True) |
Collection by collection name. |
comment(comment_id) |
Comment by ID. |
bookmark(bookmark_id, *, view_adult=True) |
Bookmark by ID. |
external_work(external_work_id, *, page=1, view_adult=True) |
ExternalWork by AO3 record ID. |
Work
Create a work with Work.from_id(work_id, chapter_id=None, ...),
Work.from_url(url, ...), Work(work_id, chapter_id=None, ...), or
client.work(...).
| Group | Members |
|---|---|
| Identity | id, chapter_id, link, url, view_adult, client |
| Core metadata | title, summary, summary_html, language, published, updated, words, complete, restricted |
| Chapter/statistics metadata | number_of_posted_chapters, expected_number_of_chapters, comments_count, kudos_count, bookmarks_count, collections_count, hits |
| People and grouping | pseuds, recipients, series, collections |
| Typed tags | ratings, warnings, categories, fandoms, relationships, characters, additional_tags, and combined tags |
| Work-level content | notes, notes_html, endnotes, endnotes_html |
| Lazy resources | detail, chapters, download_links, comments_page, comments, kudos, bookmarks_page, bookmarks |
| Method | Behavior |
|---|---|
comments_for_page(page) |
Load a specific Comment.Page. |
bookmarks_for_page(page) |
Load a specific Bookmark.Page. |
create_comment(content, *, pseud_id=None, name=None, email=None) |
Return a new Comment for this work or its selected chapter. pseud_id overrides the authenticated pseud; name and email are guest-only fields. |
create_bookmark(*, notes="", tags=(), collections=(), private=False, recommended=False, pseud_id=None) |
Return the logged-in user's new Bookmark. Tag/collection arguments accept strings or iterables of strings and model objects. |
subscribe() / unsubscribe() |
Return a Subscription when subscribing; return None when unsubscribing. |
mark_for_later() / mark_as_read() |
Add to or remove from AO3's Marked for Later list; each returns the work. |
download(file_type=...) |
Return bytes for keyword-only file_type: azw3, epub, mobi, pdf, or html. |
When available, download_links is a Work.DownloadLinks object with absolute
azw3, epub, mobi, pdf, and html URL attributes. It is None when the parsed
page does not expose all supported links; download() then raises AO3ParseError.
Chapter
Chapters are fully parsed objects returned by work.chapters; they are not separate
metadata handles.
Loading chapters also requests AO3's chapter navigation to resolve chapter IDs,
positions, titles, and publication dates. position is 1-based within the work;
chapter.work returns a new handle for the whole work.
| Group | Members |
|---|---|
| Identity | id, work_id, position, link, url, title, published, view_adult, client |
| Creator/content | pseuds, summary, summary_html, notes, notes_html, content, content_html, endnotes, endnotes_html |
| Relationships | work, comments_page, comments |
| Methods | comments_for_page(page) and create_comment(...); authenticated comments need only content, while name and email are guest-only fields. |
Kudos
Use work.kudos or Kudos(work_id, *, page=1, view_adult=True, client=None).
| Member | Behavior |
|---|---|
work_id, page, url, view_adult, client |
Identity and request context. |
detail |
Cached parsed Kudos page used by the convenience properties below. |
users, users_count, guest_count, total, page_count |
Paginated public Kudos data. |
leave() |
Submit Kudos, invalidate this object's cached Kudos page, and return the same Kudos object. |
copy(page=...) |
Create a clean handle for another Kudos page. |
Tag and TagKind
Use Tag(name, ...), Tag.from_url(url, ...), or client.tag(name, ...).
Tag.from_url() accepts tag profile, work-list, and bookmark-list paths:
/tags/NAME, /tags/NAME/works, and /tags/NAME/bookmarks. A tag handle exposes both
listings regardless of which of these paths was supplied.
TagKind is one of rating, warning, category, fandom, relationship,
character, or freeform.
| Member | Behavior |
|---|---|
name, kind, letter, link, url, page, view_adult, client |
Tag identity, optional classification/index letter, and request context. |
works_page, works, works_count |
Works visible to the current session carrying this tag; works_count can be None. |
bookmarks_page, bookmarks |
Visible bookmark listings carrying this tag; inspect bookmarks_page.grouped for the listing's count semantics. |
copy(page=...) |
Create another lightweight page handle. |
Tag.path(name, *, bookmarks=False) |
Build AO3's escaped work or bookmark path for a tag. |
Language
Use Language(short, name=None, ...), Language.from_url(url, ...), or
client.language(short, name=None, ...).
| Member | Behavior |
|---|---|
short, name, link, url, page, view_adult, client |
Language identity and request context. |
works_page, works, works_count |
Works visible to the current session in this language; works_count can be None. |
copy(page=...) |
Create another lightweight page handle. |
Media
Use Media(name, ...), Media.from_url(url, ...), client.media(name), or iterate
client.media_index.
| Member | Behavior |
|---|---|
name, link, url, client |
Media identity and request context. |
index_fandoms |
Fandom tags included in the cached /media index. |
fandoms |
Complete fandom-tag listing for this media category. |
Media.path(name) |
Build the escaped AO3 fandom-index path. |
User
Use User(login, ...), User.from_url(url, ...), or client.user(login, ...).
A User is the AO3 account; it is deliberately distinct from its public Pseud
identities.
| Group | Members |
|---|---|
| Identity/profile | login, link, url, id, joined, title, bio, bio_html, detail, page, view_adult, client |
| Pseuds | default_pseud, pseuds_page, pseuds |
| Listings | works_page, works, series_page, series, bookmarks_page, bookmarks, collections_page, collections |
| Actions/paging | subscribe(), unsubscribe(), copy(page=...) |
Pseud
Use Pseud(name, user_login, ...), Pseud.from_url(url, ...), or
client.pseud(name, user_login, ...).
| Group | Members |
|---|---|
| Identity/summary | name, user_login, byline, link, url, description, description_html, works_count, recs_count, page, view_adult, client |
| Relationships | user, works_page, works, series_page, series, bookmarks_page, bookmarks |
| Paging | copy(page=...) |
description, description_html, works_count, and recs_count are optional
summary fields. A directly constructed pseud can have None for these values;
reading them does not load a profile. Loading works_page updates works_count.
Series
Use Series(series_id, ...), Series.from_url(url, ...), or
client.series(series_id, ...).
detail and works_page are populated together from the series page. position
is the work's part number when the series handle comes from work.series; it can
be None on a directly constructed handle.
| Group | Members |
|---|---|
| Identity | id, position, link, url, title, page, view_adult, client |
| Parsed state | detail |
| Metadata | begun, updated, summary, summary_html, notes, notes_html, words, works_count, bookmarks_count, complete, restricted |
| Relationships | pseuds, works_page, works, bookmarks_page, bookmarks |
| Actions/paging | subscribe(), unsubscribe(), copy(page=...) |
Collection
Use Collection(name, ...), Collection.from_url(url, ...), or
client.collection(name, ...).
| Group | Members |
|---|---|
| Identity | name, title, link, url, page, view_adult, client |
| Parsed state | detail |
| Profile | description, description_html, active_since, updated, contact, intro, intro_html, faq, faq_html, rules, rules_html |
| Configuration | closed, moderated, unrevealed, anonymous, challenge_type |
| Relationships | tags, maintainers, works_page, works, bookmarks_page, bookmarks, subcollections_page, subcollections |
| Counts/paging | works_count, bookmarks_count, subcollections_count, copy(page=...) |
Bookmark
Use Bookmark(bookmark_id, ...), Bookmark.from_url(url, ...), or
client.bookmark(bookmark_id, ...). New bookmarks are created by
work.create_bookmark().
| Group | Members |
|---|---|
| Identity | id, link, url, view_adult, client |
| Parsed state | detail |
| Metadata | pseud, created, notes, notes_html, recommended, private, tags, collections |
| Target | bookmarkable, a lightweight Work, Series, ExternalWork, or None when unavailable. |
| Mutation | update(*, notes=None, tags=None, collections=None, private=None, recommended=None, pseud_id=None), delete() |
For update(), None preserves a field; empty text or an empty iterable clears the
corresponding value. delete() destroys that bookmark and its stored metadata; a new
bookmark can be created later, but it is a new server-side record rather than an undo.
AO3's abbreviated bookmark previews do not expose a bookmark ID. These objects
have id, link, and url set to None, while retaining the visible bookmark
metadata and target. An individual bookmark ID is required to update or delete it.
ExternalWork
Use ExternalWork(external_work_id, ...), ExternalWork.from_url(url, ...), or
client.external_work(external_work_id, ...).
| Group | Members |
|---|---|
| Identity | id, link, ao3_url, page, view_adult, client; ao3_url is the AO3 record URL. |
| Parsed state | detail |
| External metadata | url, title, author, summary, summary_html, language, created; url is the off-site target. |
| AO3 relationships | tags, bookmarks_count, related_works_count, bookmarks_page, bookmarks |
| Paging | copy(page=...) |
tags includes rating and category tags when shown. If a bookmark preview links
only to the AO3 record, reading url fetches the external-work detail page to
resolve the actual off-site destination.
Comment
Use Comment(comment_id, ...), Comment.from_url(url, ...), or
client.comment(comment_id). New root comments are created by a Work or Chapter.
| Group | Members |
|---|---|
| Identity/tree | id, link, url, parent_id, depth, replies_count, replies, client |
| Parsed state | detail |
| Author | pseud, guest_name, by_anonymous_creator |
| Time | created_at, created_at_text, timezone, edited_at, edited_at_text |
| Content/state | content, content_html, deleted, unreviewed, spam, hidden |
| Mutation | reply(content, *, pseud_id=None, name=None, email=None), update(content, *, pseud_id=None), delete(); reply name and email are guest-only fields. |
created_at and edited_at are naive datetime values or None; the SDK does not
convert them to UTC. timezone retains the displayed posting-time zone abbreviation,
and created_at_text / edited_at_text retain the full displayed timestamp when
present. Date-only fields on other models use datetime.date or None.
delete() is irreversible through AO3's user-facing routes; a deleted comment cannot
be restored by this library.
Subscription
Work.subscribe(), Series.subscribe(), and User.subscribe() return a
Subscription.
| Member | Behavior |
|---|---|
id, subscribable_type, subscribable_id |
Server-side subscription identity. The type is Work, Series, or User. |
subscribable_link, link, url, client |
Target and subscription paths plus request context. |
delete() |
Remove the subscription. AO3 exposes creation and deletion, not a separate update operation. |
Page objects
| Type | Item tuple | Returned by |
|---|---|---|
Work.Page |
works |
Tag, language, user, pseud, series, or collection work listings |
Bookmark.Page |
bookmarks |
Work, tag, user, pseud, series, collection, or external-work bookmark listings |
Comment.Page |
comments |
Work and chapter comments |
Pseud.Page |
pseuds |
User pseuds |
Series.Page |
series |
User and pseud series listings |
Collection.Page |
collections |
User collections and collection subcollections |
Each page has page, page_count, and total, implements iteration, and implements
len(page). Its item tuple supports normal indexing and slicing.
| Field | Meaning |
|---|---|
page |
Current page reported by AO3, falling back to the requested page. |
page_count |
Highest page number exposed by the page's pagination; defaults to 1 without pagination. |
total |
Listing total, when known. Work.Page and Bookmark.Page allow None; other page types expose an integer. |
len(page) |
Number of parsed items in this page's tuple, not the listing total. |
Comment.Page.comments contains the page's top-level threads; nested replies are
available through each comment's replies. Its total reflects the comment count
displayed for the work or selected chapter, including replies, so it need not equal
the number of top-level threads. Unavailable or unrevealed work entries may likewise
contribute to a listing's total without producing a readable Work object.
Bookmark.Page.grouped identifies AO3's Bookmarked Items listings. On these
pages, total counts bookmarked targets, while bookmarks contains the individual
bookmark previews shown under those targets. More bookmarks may be available on
each target's own bookmark listing. Ordinary bookmark listings have grouped=False
and total counts bookmarks.
Exceptions
| Exception | Meaning |
|---|---|
AO3Error |
Base class for library-defined errors. |
AO3InvalidURLError |
A URL does not match the requested AO3 resource shape; also a ValueError. |
AO3AuthenticationError |
AO3 redirected to login, returned a recognized login gate, or rejected credentials. |
AO3ActionError |
AO3 rejected, forbids, or does not provide a requested write operation. |
AO3ParseError |
Required page structure, resource identity, or an action's confirmation is missing or invalid. |
HTTP status, connection, TLS, and timeout failures remain httpx exceptions.
Adult content
Page-producing constructors accept view_adult. It defaults to True, which sends
AO3's view_adult=true query parameter where required:
work = Work.from_id(WORK_ID, view_adult=False)
tag = client.tag(TAG_NAME, view_adult=False)
This option only controls AO3's adult-content interstitial. It does not bypass login, visibility, or collection restrictions.
Network and parsing behavior
import httpx
from ao3 import (
AO3ActionError,
AO3AuthenticationError,
AO3InvalidURLError,
AO3ParseError,
Work,
)
try:
work = Work.from_url(f"https://archiveofourown.org/works/{WORK_ID}")
print(work.title)
except AO3InvalidURLError:
print("The URL is not a supported AO3 resource URL")
except AO3AuthenticationError:
print("This resource requires an authenticated AO3 session")
except AO3ActionError as error:
print(f"AO3 rejected or does not support the action: {error}")
except AO3ParseError:
print("AO3 returned a page shape that this version could not parse")
except httpx.HTTPError as error:
print(f"The HTTP request failed: {error}")
ao3-py deliberately leaves rate limiting, retries, proxies, persistence, and request
scheduling to the application. This keeps the network layer explicit and lets callers
apply policies appropriate to their own workload.
Fields ending in _html preserve parsed fragments from AO3; they are not sanitized
by ao3-py. Treat them as untrusted input before inserting them into another HTML
document. Their plain-text counterparts are the safer choice when markup is not
needed.
Disclaimer
This project is unofficial and is not affiliated with the Organization for Transformative Works. Use it responsibly and respect AO3, its users, and its terms of service.
Metadata
Release files for ao3-py 2026.10.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ao3_py-2026.10.10.tar.gz | 60.4 kB | Without provenance | Details for ao3_py-2026.10.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ao3_py-2026.10.10-py3-none-any.whl | Python 3 | none | any | Details for ao3_py-2026.10.10-py3-none-any.whl |
Total release size: 119.8 kB
Release files / ao3_py-2026.10.10.tar.gz
| Download URL | ao3_py-2026.10.10.tar.gz |
|---|---|
| Size | 60.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d94882d243c188401eef4d9031e6d59a9eed370fbb1177c88d416426ac26aa08
|
|
BLAKE2b-256 checksum How to use checksums |
a08671a6db0e0cae66c963ff68ef2a00b1dad544d9f4e5918859cdd37ae7d423
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / ao3_py-2026.10.10-py3-none-any.whl
| Download URL | ao3_py-2026.10.10-py3-none-any.whl |
|---|---|
| Size | 59.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d4b3a7612407ba22be052325209de5e141eea6fc78144fec8af1b31961d7ccd
|
|
BLAKE2b-256 checksum How to use checksums |
4c5055f853075d1bbcd350555c576625e9f39c3c2b6736a1a660d64c6681b0d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for ao3-py 2026.10.10
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.