Skip to content
practicalglitch edited this page Jul 23, 2024 · 1 revision

This is the primary class to interact with.

LAST UPDATED FOR v0.1.0

Work[] ApiO3.GetListOfRecentWorks(String tag, int page)

Returns a list of all works from https://archiveofourown.org/tags/TAG/works?page=PAGE.

Fields filled out:

  • Id
  • Author / AuthorLoc (Please note the case of Author="Anonymous", AuthorLoc="")
  • Title
  • Stats (Words, comments, kudos, bookmarks, hits, chapters)
  • Date Updated in ISO date (Date Published is NOT included - returns Unix epoch in ISO date)
  • Rating
  • Category
  • Finished-ness
  • Warning
  • Tags (Relationships, Characters, Freeforms)
  • Language
  • Fandoms / FandomsLoc
  • Summary

WorkChapter[] ApiO3.DownloadWholeWork(String workId)

Returns an array of each chapter of a work.

Fills out all fields of a workchapter.

WorkChapter[] ApiO3.GetChapterMetadatas(String workId)

Returns an array of each chapter of a work, minus chapter contents (notes, summary, body).

Work ApiO3.GetWorkMetadata(String workId)

Provides all metadata of a work. Does not provide any chapter information

WorkChapter ApiO3.DownloadSingleChapter(String id)

Returns all metadata and body text of a single chapter.

boolean ApiO3.DownloadSingleChapter(WorkChapter chapter)

Returns true if data filled out, false if fails. Data is returned by reference from chapter.

Fandom[] ApiO3.GetAllFandoms()

Returns a list of all fandoms.

This takes a while; deeply recommended to cache this as it does not often change.