@pencil-agent/nano-pencil 2.0.0-beta.8 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (241) hide show
  1. package/README.md +267 -267
  2. package/dist/build-meta.json +3 -3
  3. package/dist/core/export-html/AGENT.md +11 -11
  4. package/dist/core/export-html/template.css +971 -971
  5. package/dist/core/export-html/template.html +54 -54
  6. package/dist/core/extensions-host/index.d.ts +1 -1
  7. package/dist/core/extensions-host/loader.js +1 -1
  8. package/dist/core/extensions-host/runner.d.ts +1 -0
  9. package/dist/core/extensions-host/runner.js +2 -2
  10. package/dist/core/extensions-host/types.d.ts +17 -22
  11. package/dist/core/lib/ai/src/types.d.ts +12 -2
  12. package/dist/core/persona/persona-manager.js +5 -2
  13. package/dist/core/runtime/agent-session.js +3 -3
  14. package/dist/core/runtime/extension-core-bindings.d.ts +1 -0
  15. package/dist/core/runtime/extension-core-bindings.js +2 -2
  16. package/dist/extensions/builtin/AGENT.md +115 -115
  17. package/dist/extensions/builtin/browser/AGENT.md +17 -17
  18. package/dist/extensions/builtin/browser/agent-workspace/agent_helpers.py +12 -12
  19. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/amazon/product-search.md +198 -198
  20. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/archive-org/scraping.md +341 -341
  21. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv/scraping.md +311 -311
  22. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv-bulk/scraping.md +333 -333
  23. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/atlas/overview.md +70 -70
  24. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/booking-com/scraping.md +578 -578
  25. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/capterra/scraping.md +440 -440
  26. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/centilebrain/generate-estimates.md +110 -110
  27. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coingecko/scraping.md +325 -325
  28. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coinmarketcap/scraping.md +463 -463
  29. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coursera/scraping.md +360 -360
  30. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/craigslist/scraping.md +390 -390
  31. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/crossref/scraping.md +568 -568
  32. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/dev-to/scraping.md +323 -323
  33. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/duckduckgo/scraping.md +349 -349
  34. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/ebay/scraping.md +435 -435
  35. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/etsy/scraping.md +506 -506
  36. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/eventbrite/scraping.md +363 -363
  37. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/expedia/automation.md +168 -168
  38. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/groups.md +236 -236
  39. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/pages.md +295 -295
  40. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/framer/editor.md +108 -108
  41. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/fred/scraping.md +493 -493
  42. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/g2/scraping.md +580 -580
  43. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/genius/scraping.md +511 -511
  44. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/repo-actions.md +65 -65
  45. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/scraping.md +184 -184
  46. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/glassdoor/scraping.md +543 -543
  47. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gmail/compose.md +122 -122
  48. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/goodreads/scraping.md +461 -461
  49. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gutenberg/scraping.md +383 -383
  50. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/hackernews/scraping.md +243 -243
  51. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/howlongtobeat/scraping.md +473 -473
  52. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/imdb/scraping.md +271 -271
  53. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/itch-io/scraping.md +436 -436
  54. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/job-boards/indeed-glassdoor.md +1021 -1021
  55. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/letterboxd/scraping.md +349 -349
  56. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/linkedin/invitation-manager.md +109 -109
  57. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/loom/folder-enumeration.md +170 -170
  58. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/macrotrends/scraping.md +537 -537
  59. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/article-hydration.md +120 -120
  60. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/scraping.md +414 -414
  61. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/metacritic/scraping.md +477 -477
  62. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/musicbrainz/scraping.md +478 -478
  63. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/nasa/scraping.md +339 -339
  64. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/news-aggregation/multi-source.md +205 -205
  65. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/open-library/scraping.md +472 -472
  66. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openalex/scraping.md +470 -470
  67. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openstreetmap/scraping.md +490 -490
  68. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/package-registries/npm-pypi.md +478 -478
  69. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/polymarket/scraping.md +234 -234
  70. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/producthunt/scraping.md +307 -307
  71. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/pubmed/scraping.md +421 -421
  72. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/quora/scraping.md +364 -364
  73. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rawg/scraping.md +352 -352
  74. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/reddit/scraping.md +124 -124
  75. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rest-countries/scraping.md +233 -233
  76. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/sec-edgar/scraping.md +361 -361
  77. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/README.md +36 -36
  78. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/embedded-apps.md +72 -72
  79. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/knowledge-base.md +109 -109
  80. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/polaris-inputs.md +137 -137
  81. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/soundcloud/scraping.md +362 -362
  82. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/spotify/scraping.md +339 -339
  83. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/stackoverflow/scraping.md +435 -435
  84. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/steam/scraping.md +575 -575
  85. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/substack/scraping.md +338 -338
  86. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/thetechgeeks/pricing.md +52 -52
  87. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tiktok/upload.md +107 -107
  88. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tradingview/scraping.md +309 -309
  89. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trello/boards-and-lists.md +88 -88
  90. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trustpilot/scraping.md +375 -375
  91. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/walmart/scraping.md +444 -444
  92. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wayback-machine/scraping.md +306 -306
  93. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/weather/scraping.md +398 -398
  94. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wellfound/scraping.md +596 -596
  95. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/world-bank/scraping.md +356 -356
  96. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/xiaohongshu/scraping.md +84 -84
  97. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/youtube/scraping.md +418 -418
  98. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/zillow/scraping.md +433 -433
  99. package/dist/extensions/builtin/browser/browser.md +73 -73
  100. package/dist/extensions/builtin/browser/install.md +142 -142
  101. package/dist/extensions/builtin/browser/interaction-skills/connection.md +48 -48
  102. package/dist/extensions/builtin/browser/interaction-skills/cookies.md +3 -3
  103. package/dist/extensions/builtin/browser/interaction-skills/cross-origin-iframes.md +3 -3
  104. package/dist/extensions/builtin/browser/interaction-skills/dialogs.md +64 -64
  105. package/dist/extensions/builtin/browser/interaction-skills/downloads.md +3 -3
  106. package/dist/extensions/builtin/browser/interaction-skills/drag-and-drop.md +3 -3
  107. package/dist/extensions/builtin/browser/interaction-skills/dropdowns.md +3 -3
  108. package/dist/extensions/builtin/browser/interaction-skills/iframes.md +3 -3
  109. package/dist/extensions/builtin/browser/interaction-skills/network-requests.md +3 -3
  110. package/dist/extensions/builtin/browser/interaction-skills/print-as-pdf.md +3 -3
  111. package/dist/extensions/builtin/browser/interaction-skills/profile-sync.md +90 -90
  112. package/dist/extensions/builtin/browser/interaction-skills/screenshots.md +17 -17
  113. package/dist/extensions/builtin/browser/interaction-skills/scrolling.md +3 -3
  114. package/dist/extensions/builtin/browser/interaction-skills/shadow-dom.md +3 -3
  115. package/dist/extensions/builtin/browser/interaction-skills/tabs.md +69 -69
  116. package/dist/extensions/builtin/browser/interaction-skills/uploads.md +1 -1
  117. package/dist/extensions/builtin/browser/interaction-skills/viewport.md +3 -3
  118. package/dist/extensions/builtin/browser/src/browser_harness/AGENT.md +15 -15
  119. package/dist/extensions/builtin/browser/src/browser_harness/__init__.py +8 -8
  120. package/dist/extensions/builtin/browser/src/browser_harness/_ipc.py +90 -90
  121. package/dist/extensions/builtin/browser/src/browser_harness/admin.py +722 -722
  122. package/dist/extensions/builtin/browser/src/browser_harness/daemon.py +328 -328
  123. package/dist/extensions/builtin/browser/src/browser_harness/helpers.py +396 -396
  124. package/dist/extensions/builtin/browser/src/browser_harness/run.py +103 -103
  125. package/dist/extensions/builtin/discipline/skills/brainstorming/SKILL.md +33 -33
  126. package/dist/extensions/builtin/discipline/skills/executing-plans/SKILL.md +25 -25
  127. package/dist/extensions/builtin/discipline/skills/finishing-development-branch/SKILL.md +25 -25
  128. package/dist/extensions/builtin/discipline/skills/receiving-code-review/SKILL.md +22 -22
  129. package/dist/extensions/builtin/discipline/skills/requesting-code-review/SKILL.md +31 -31
  130. package/dist/extensions/builtin/discipline/skills/systematic-debugging/SKILL.md +28 -28
  131. package/dist/extensions/builtin/discipline/skills/test-driven-development/SKILL.md +32 -32
  132. package/dist/extensions/builtin/discipline/skills/using-git-worktrees/SKILL.md +25 -25
  133. package/dist/extensions/builtin/discipline/skills/verification-before-completion/SKILL.md +27 -27
  134. package/dist/extensions/builtin/discipline/skills/writing-plans/SKILL.md +26 -26
  135. package/dist/extensions/builtin/goal/README.md +67 -67
  136. package/dist/extensions/builtin/goal/goal-controller.d.ts +39 -10
  137. package/dist/extensions/builtin/goal/goal-controller.js +1 -1
  138. package/dist/extensions/builtin/goal/goal-format.js +1 -1
  139. package/dist/extensions/builtin/goal/goal-prompts.d.ts +2 -0
  140. package/dist/extensions/builtin/goal/goal-prompts.js +5 -4
  141. package/dist/extensions/builtin/goal/goal-store.js +1 -1
  142. package/dist/extensions/builtin/goal/index.d.ts +1 -1
  143. package/dist/extensions/builtin/goal/index.js +10 -7
  144. package/dist/extensions/builtin/grub/README.md +112 -112
  145. package/dist/extensions/builtin/link-world/agent-workspace/README.md +16 -16
  146. package/dist/extensions/builtin/link-world/index.js +6 -6
  147. package/dist/extensions/builtin/link-world/internet-search/internet-search.md +65 -65
  148. package/dist/extensions/builtin/link-world/link-world-agent.md +82 -82
  149. package/dist/extensions/builtin/link-world/linkworld.md +313 -313
  150. package/dist/extensions/builtin/link-world/{network-routing.md → network-routing/network-routing.md} +67 -67
  151. package/dist/extensions/builtin/loop/README.md +92 -92
  152. package/dist/extensions/builtin/mcp/figma-design.md +68 -68
  153. package/dist/extensions/builtin/mcp/mcp-management.md +85 -85
  154. package/dist/extensions/builtin/plan/index.js +1 -1
  155. package/dist/extensions/builtin/recap/AGENT.md +15 -15
  156. package/dist/extensions/builtin/sal/README.md +72 -72
  157. package/dist/extensions/builtin/security-audit/README.md +289 -289
  158. package/dist/extensions/builtin/task/task-store.d.ts +4 -0
  159. package/dist/extensions/builtin/task/task-store.js +1 -1
  160. package/dist/extensions/builtin/team/AGENT.md +112 -112
  161. package/dist/extensions/builtin/team/TESTING.md +299 -299
  162. package/dist/extensions/builtin/token-save/README.md +56 -56
  163. package/dist/extensions/optional/AGENT.md +10 -10
  164. package/dist/index.d.ts +5 -30
  165. package/dist/index.js +1 -1
  166. package/dist/models.d.ts +7 -0
  167. package/dist/models.js +1 -0
  168. package/dist/modes/interactive/components/footer.js +1 -1
  169. package/dist/modes/interactive/components/task-status-panel.d.ts +36 -0
  170. package/dist/modes/interactive/components/task-status-panel.js +1 -0
  171. package/dist/modes/interactive/controllers/stream-render-controller.d.ts +7 -0
  172. package/dist/modes/interactive/controllers/stream-render-controller.js +2 -2
  173. package/dist/modes/interactive/interactive-mode.js +40 -40
  174. package/dist/modes/interactive/state/interactive-state.d.ts +2 -0
  175. package/dist/modes/interactive/state/interactive-state.js +1 -1
  176. package/dist/modes/interactive/theme/dark.json +85 -85
  177. package/dist/modes/interactive/theme/light.json +84 -84
  178. package/dist/modes/interactive/theme/theme-schema.json +335 -335
  179. package/dist/modes/interactive/theme/warm.json +81 -81
  180. package/dist/node_modules/@pencil-agent/ai/dist/cli.js +0 -0
  181. package/dist/node_modules/@pencil-agent/ai/dist/models.generated.js +1 -1
  182. package/dist/node_modules/@pencil-agent/ai/dist/providers/anthropic.js +2 -2
  183. package/dist/node_modules/@pencil-agent/ai/dist/providers/openai-completions.js +5 -5
  184. package/dist/node_modules/@pencil-agent/ai/dist/providers/openai-responses.js +1 -1
  185. package/dist/node_modules/@pencil-agent/ai/dist/stream.js +1 -1
  186. package/dist/packages/protocol/src/commands.d.ts +33 -0
  187. package/dist/packages/protocol/src/flags.d.ts +20 -0
  188. package/dist/packages/protocol/src/hooks.d.ts +17 -0
  189. package/dist/packages/protocol/src/hooks.js +0 -0
  190. package/dist/packages/{extension-sdk → protocol}/src/index.d.ts +7 -4
  191. package/dist/packages/protocol/src/index.js +1 -0
  192. package/dist/packages/{extension-sdk → protocol}/src/lifecycle.d.ts +15 -27
  193. package/dist/packages/protocol/src/lifecycle.js +0 -0
  194. package/dist/packages/{extension-sdk → protocol}/src/tools.d.ts +1 -1
  195. package/dist/packages/protocol/src/tools.js +0 -0
  196. package/dist/public-config.d.ts +12 -0
  197. package/dist/public-config.js +1 -0
  198. package/dist/runtime.d.ts +9 -0
  199. package/dist/runtime.js +1 -0
  200. package/dist/session-compaction.d.ts +7 -0
  201. package/dist/session-compaction.js +1 -0
  202. package/dist/session.d.ts +7 -0
  203. package/dist/session.js +1 -0
  204. package/dist/skills.d.ts +7 -0
  205. package/dist/skills.js +1 -0
  206. package/dist/tools.d.ts +7 -0
  207. package/dist/tools.js +1 -0
  208. package/docs/ACP/345/215/217/350/256/256/351/233/206/346/210/220/345/274/200/345/217/221/346/226/207/346/241/243.md +851 -0
  209. package/docs/SDK-TESTING.md +364 -0
  210. package/docs/codex-goal-command-impl.md +1055 -1055
  211. package/docs/codex-goal-vs-grub.md +500 -500
  212. package/docs/custom-provider.md +27 -27
  213. package/docs/extensions.md +27 -27
  214. package/docs/keybindings.md +27 -27
  215. package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/200/273/347/273/223.md" +250 -250
  216. package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/212/245/345/221/212.md" +122 -122
  217. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210.md" +1222 -1222
  218. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210/345/256/236/347/216/260/346/212/245/345/221/212.md" +158 -158
  219. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210/345/257/271/346/257/224/345/210/206/346/236/220.md" +128 -128
  220. package/docs/loop /351/207/215/346/236/204/350/256/241/345/210/222.md" +320 -320
  221. package/docs/loop-usage-examples.md +214 -214
  222. package/docs/mem-core/346/212/200/346/234/257/346/226/207/346/241/243.md +593 -0
  223. package/docs/models.md +27 -27
  224. package/docs/packages.md +27 -27
  225. package/docs/pi-design-philosophy.md +457 -457
  226. package/docs/planmode.md +1987 -1987
  227. package/docs/prompt-templates.md +27 -27
  228. package/docs/providers.md +27 -27
  229. package/docs/sdk.md +27 -27
  230. package/docs/skills.md +27 -27
  231. package/docs/startup-performance-optimization.md +301 -0
  232. package/docs/themes.md +27 -27
  233. package/docs/tui.md +27 -27
  234. package/docs//350/256/244/347/237/245/345/234/260/345/233/276.md +47 -0
  235. package/package.json +190 -162
  236. package/dist/packages/extension-sdk/src/index.js +0 -1
  237. package/docs/cc-agent-design.md +0 -1297
  238. package/docs/cc-tui-design.md +0 -1333
  239. package/docs//345/257/271/346/240/207Claude-Code.md +0 -1775
  240. /package/dist/packages/{extension-sdk/src/lifecycle.js → protocol/src/commands.js} +0 -0
  241. /package/dist/packages/{extension-sdk/src/tools.js → protocol/src/flags.js} +0 -0
@@ -1,461 +1,461 @@
1
- # Goodreads — Book Data Extraction
2
-
3
- Field-tested against goodreads.com on 2026-04-18 via `http_get` (no browser required).
4
- All five URL types return full HTML with no bot-wall, CAPTCHA, or login gate.
5
-
6
- ## Access Summary
7
-
8
- | Page type | `http_get` works? | Data format |
9
- |--------------------|-------------------|--------------------------|
10
- | Book show page | Yes | `__NEXT_DATA__` + JSON-LD |
11
- | Search results | Yes | Server-rendered HTML (schema.org microdata) |
12
- | Author show page | Yes | Server-rendered HTML + OG meta |
13
- | Listopia list page | Yes | Server-rendered HTML (schema.org microdata) |
14
-
15
- Goodreads shut down its public API in 2020. All extraction is HTML-based.
16
- Open Library is a reliable supplement with a free JSON API (see [Open Library fallback](#open-library-api-fallback)).
17
-
18
- ---
19
-
20
- ## Book Page — Full Data (`__NEXT_DATA__`)
21
-
22
- URL pattern: `https://www.goodreads.com/book/show/{book_id}` or `/{book_id}.{Slug}`
23
-
24
- The slug is optional — numeric ID alone works and redirects cleanly.
25
-
26
- ```python
27
- import re, json
28
- from helpers import http_get
29
-
30
- def parse_book(book_id):
31
- html = http_get(f"https://www.goodreads.com/book/show/{book_id}")
32
-
33
- # Parse Apollo state from Next.js page
34
- nd = re.search(r'<script id="__NEXT_DATA__"[^>]*>(.*?)</script>', html, re.DOTALL)
35
- ap = json.loads(nd.group(1))['props']['pageProps']['apolloState']
36
-
37
- # The primary Book entity matches the URL's legacy ID
38
- book = next(v for v in ap.values()
39
- if v.get('__typename') == 'Book' and v.get('legacyId') == int(book_id))
40
- work = next((v for v in ap.values() if v.get('__typename') == 'Work'), {})
41
- author_ref = book['primaryContributorEdge']['node']['__ref']
42
- author = ap.get(author_ref, {})
43
-
44
- stats = work.get('stats', {})
45
- work_details = work.get('details', {})
46
- book_details = book.get('details', {})
47
-
48
- return {
49
- 'title': book['title'],
50
- 'title_complete': book['titleComplete'],
51
- 'book_id': book['legacyId'],
52
- 'url': book['webUrl'],
53
- 'cover_url': book['imageUrl'],
54
- # Strip HTML tags from description
55
- 'description': re.sub(r'<[^>]+>', '', book.get('description({"stripped":true})',
56
- book.get('description', ''))).strip(),
57
- 'genres': [g['genre']['name'] for g in book.get('bookGenres', [])],
58
- 'series': [{'name': s['series']['title'], 'position': s.get('userPosition')}
59
- for s in book.get('bookSeries', [])],
60
- # Author
61
- 'author_name': author.get('name'),
62
- 'author_url': author.get('webUrl'),
63
- # Edition details
64
- 'format': book_details.get('format'),
65
- 'num_pages': book_details.get('numPages'),
66
- 'publisher': book_details.get('publisher'),
67
- 'language': (book_details.get('language') or {}).get('name'),
68
- 'isbn': book_details.get('isbn'),
69
- 'isbn13': book_details.get('isbn13'),
70
- 'pub_timestamp_ms': book_details.get('publicationTime'),
71
- # Ratings (from Work, not Book)
72
- 'avg_rating': stats.get('averageRating'),
73
- 'ratings_count': stats.get('ratingsCount'),
74
- 'text_reviews': stats.get('textReviewsCount'),
75
- # ratings_dist is list of counts for [1-star, 2-star, 3-star, 4-star, 5-star]
76
- 'ratings_dist': stats.get('ratingsCountDist'),
77
- # Awards
78
- 'awards': [a['name'] + (' — ' + a['category'] if a.get('category') else '')
79
- for a in work_details.get('awardsWon', [])],
80
- }
81
-
82
- # Example
83
- book = parse_book(149267) # The Stand by Stephen King
84
- # book['title'] => "The Stand"
85
- # book['avg_rating'] => 4.35
86
- # book['ratings_count']=> 845591
87
- # book['genres'] => ["Horror", "Fiction", "Fantasy", ...]
88
- # book['awards'] => ["Locus Award — Best SF Novel", ...]
89
- ```
90
-
91
- **Field notes:**
92
- - `book['legacyId']` is the integer in the URL (e.g. `149267`). Use it to match the correct entity — the `apolloState` often contains 2-3 Book entries for different editions.
93
- - Ratings and awards live in the `Work` entity, not `Book`. The `Work` is always `__typename == 'Work'`.
94
- - `description` comes in two forms: `description` (HTML) and `description({"stripped":true})` (plain text). Prefer the stripped version.
95
- - `pub_timestamp_ms` is a Unix timestamp in **milliseconds**. Convert: `datetime.fromtimestamp(ts/1000)`.
96
- - `isbn` / `isbn13` are often `null` on older editions — the JSON-LD path (below) is no more reliable.
97
-
98
- ---
99
-
100
- ## Book Page — Fast Path (JSON-LD)
101
-
102
- Use when you only need title, author, rating, page count, and awards. ~3× less parsing code.
103
-
104
- ```python
105
- import re, json
106
- from helpers import http_get
107
-
108
- def parse_book_fast(book_id):
109
- html = http_get(f"https://www.goodreads.com/book/show/{book_id}")
110
- blocks = re.findall(r'<script type="application/ld\+json">(.*?)</script>', html, re.DOTALL)
111
- if not blocks:
112
- return None
113
- ld = json.loads(blocks[0])
114
- return {
115
- 'title': ld.get('name'),
116
- 'author': ld['author'][0]['name'] if ld.get('author') else None,
117
- 'avg_rating': ld.get('aggregateRating', {}).get('ratingValue'),
118
- 'ratings_count':ld.get('aggregateRating', {}).get('ratingCount'),
119
- 'review_count': ld.get('aggregateRating', {}).get('reviewCount'),
120
- 'num_pages': ld.get('numberOfPages'),
121
- 'isbn': ld.get('isbn'),
122
- 'cover_url': ld.get('image'),
123
- 'awards': ld.get('awards'), # single string, comma-separated
124
- 'format': ld.get('bookFormat'),
125
- }
126
-
127
- book = parse_book_fast(149267)
128
- # book['avg_rating'] => 4.35
129
- # book['ratings_count']=> 845591
130
- ```
131
-
132
- **JSON-LD does NOT include:** description, genres, series membership, per-star rating distribution, publisher, language.
133
- Use `parse_book()` (the `__NEXT_DATA__` path) when you need any of those.
134
-
135
- ---
136
-
137
- ## Search Results
138
-
139
- URL: `https://www.goodreads.com/search?q={query}&search_type=books&page={n}`
140
-
141
- Search uses server-rendered HTML with schema.org microdata `<tr>` rows. No `__NEXT_DATA__`.
142
-
143
- ```python
144
- import re, json
145
- from helpers import http_get
146
-
147
- def search_books(query, page=1):
148
- from urllib.parse import quote_plus
149
- url = f"https://www.goodreads.com/search?q={quote_plus(query)}&search_type=books&page={page}"
150
- html = http_get(url)
151
-
152
- rows = re.findall(
153
- r'<tr itemscope itemtype="http://schema.org/Book">(.*?)</tr>',
154
- html, re.DOTALL
155
- )
156
-
157
- results = []
158
- for row in rows:
159
- bid = re.search(r'<div id="(\d+)" class="u-anchorTarget">', row)
160
- title = re.search(r"itemprop='name'[^>]*>([^<]+)</span>", row)
161
- author = re.search(r'class="authorName"[^>]*><span[^>]*>([^<]+)</span>', row)
162
- avg = re.search(r'(\d+\.\d+)\s*avg rating', row)
163
- cnt = re.search(r'(\d[\d,]*)\s*rating', row)
164
- cover = re.search(r'img alt="[^"]*" class="bookCover"[^>]*src="([^"]+)"', row)
165
- if not (bid and title):
166
- continue
167
- results.append({
168
- 'book_id': bid.group(1),
169
- 'title': title.group(1).strip(),
170
- 'author': author.group(1).strip() if author else None,
171
- 'avg_rating': float(avg.group(1)) if avg else None,
172
- 'ratings_count':cnt.group(1).replace(',', '') if cnt else None,
173
- 'cover_url': cover.group(1) if cover else None,
174
- 'url': f"https://www.goodreads.com/book/show/{bid.group(1)}",
175
- })
176
-
177
- total_m = re.search(r'([\d,]+)\s+results', html)
178
- total = int(total_m.group(1).replace(',', '')) if total_m else None
179
-
180
- return {'total': total, 'page': page, 'results': results}
181
-
182
- # Example
183
- r = search_books("dune")
184
- # r['total'] => 101026
185
- # r['results'] => [{'book_id':'44767458', 'title':'Dune (Dune, #1)', 'avg_rating':4.29, ...}, ...]
186
- ```
187
-
188
- **Field notes:**
189
- - Returns exactly 20 results per page.
190
- - `total` is the result count shown in `"N results for…"` header.
191
- - The `avg rating` regex uses `&mdash;` (HTML entity) in the raw HTML — the pattern above matches the decoded text.
192
- - `ratings_count` regex hits the first occurrence of `\d+ rating` in the row, which is always the book's count (not a user review count).
193
- - `cover_url` is a 75px thumbnail (`._SY75_.jpg`). Swap `_SY75_` → `_SX315_` for a larger image.
194
-
195
- ---
196
-
197
- ## Author Page
198
-
199
- URL: `https://www.goodreads.com/author/show/{author_id}.{Slug}`
200
-
201
- Author pages are **not** Next.js — they use classic server-rendered HTML with OG meta tags and microdata.
202
- The author ID and slug can be obtained from a book's `author_url` field.
203
-
204
- ```python
205
- import re, json
206
- from helpers import http_get
207
-
208
- def parse_author(author_id_and_slug):
209
- # author_id_and_slug e.g. "58.Frank_Patrick_Herbert"
210
- html = http_get(f"https://www.goodreads.com/author/show/{author_id_and_slug}")
211
-
212
- # Name and basic info from OG/meta tags
213
- name = re.search(r"<meta content='([^']+)' property='og:title'>", html)
214
- img = re.search(r"<meta content='([^']+)' property='og:image'>", html)
215
- website = re.search(r"Website\s*</div>\s*<div[^>]*>\s*<a[^>]*href=\"([^\"]+)\"", html)
216
-
217
- # Full biography from hidden span (shown/hidden by "...more" toggle in browser)
218
- bio_span = re.search(
219
- r'<span id="freeText(?:author|long)\d+"[^>]*>(.*?)</span>',
220
- html, re.DOTALL
221
- )
222
- bio = re.sub(r'<[^>]+>', '', bio_span.group(1)).strip() if bio_span else None
223
-
224
- # Top books listed on the page (10 rows, same microdata format as search)
225
- rows = re.findall(
226
- r'<tr itemscope itemtype="http://schema.org/Book">(.*?)</tr>',
227
- html, re.DOTALL
228
- )
229
- books = []
230
- for row in rows:
231
- bid = re.search(r'<div id="(\d+)" class="u-anchorTarget">', row)
232
- title = re.search(r"itemprop='name'[^>]*>([^<]+)</span>", row)
233
- avg = re.search(r'(\d+\.\d+)\s*avg rating', row)
234
- cnt = re.search(r'(\d[\d,]*)\s*rating', row)
235
- if bid and title:
236
- books.append({
237
- 'book_id': bid.group(1),
238
- 'title': title.group(1).strip(),
239
- 'avg_rating': float(avg.group(1)) if avg else None,
240
- 'ratings_count':cnt.group(1).replace(',', '') if cnt else None,
241
- 'url': f"https://www.goodreads.com/book/show/{bid.group(1)}",
242
- })
243
-
244
- return {
245
- 'name': name.group(1) if name else None,
246
- 'profile_image':img.group(1) if img else None,
247
- 'bio': bio,
248
- 'website': website.group(1) if website else None,
249
- 'top_books': books,
250
- }
251
-
252
- # Example
253
- author = parse_author("58.Frank_Patrick_Herbert")
254
- # author['name'] => "Frank Patrick Herbert"
255
- # author['bio'] => "Franklin Patrick Herbert Jr. was an American science fiction..."
256
- # len(author['top_books']) => 10
257
- ```
258
-
259
- **Field notes:**
260
- - Author IDs can be found in a book's `author_url` (from `__NEXT_DATA__` or JSON-LD).
261
- - The slug is optional in the URL — numeric ID alone redirects correctly.
262
- - `profile_image` from OG tag is a large portrait (p8 suffix = 800px). Swap to `p5` for 500px.
263
- - The bio is server-rendered in a `<span id="freeTextauthor{ID}">` or `<span id="freeTextlong{ID}">` — which variant appears depends on length.
264
- - Follower count is **not** present in the static HTML — it requires JS execution to appear.
265
- - Page lists exactly 10 books. To get all books, paginate `/author/list/{author_id}?page=N`.
266
-
267
- ---
268
-
269
- ## Listopia List Page
270
-
271
- URL: `https://www.goodreads.com/list/show/{list_id}.{Slug}?page={n}`
272
-
273
- Returns 100 books per page with rank numbers.
274
-
275
- ```python
276
- import re, json
277
- from helpers import http_get
278
-
279
- def parse_list(list_id_and_slug, page=1):
280
- url = f"https://www.goodreads.com/list/show/{list_id_and_slug}?page={page}"
281
- html = http_get(url)
282
-
283
- rows = re.findall(
284
- r'<tr itemscope itemtype="http://schema.org/Book">(.*?)</tr>',
285
- html, re.DOTALL
286
- )
287
-
288
- results = []
289
- for row in rows:
290
- rank = re.search(r'<td[^>]*class="number"[^>]*>(\d+)</td>', row)
291
- bid = re.search(r'<div id="(\d+)" class="u-anchorTarget">', row)
292
- title = re.search(r"itemprop='name'[^>]*>([^<]+)</span>", row)
293
- author = re.search(r'class="authorName"[^>]*><span[^>]*>([^<]+)</span>', row)
294
- avg = re.search(r'(\d+\.\d+)\s*avg rating', row)
295
- cnt = re.search(r'(\d[\d,]*)\s*rating', row)
296
- if not (bid and title):
297
- continue
298
- results.append({
299
- 'rank': int(rank.group(1)) if rank else None,
300
- 'book_id': bid.group(1),
301
- 'title': title.group(1).strip(),
302
- 'author': author.group(1).strip() if author else None,
303
- 'avg_rating': float(avg.group(1)) if avg else None,
304
- 'ratings_count':cnt.group(1).replace(',', '') if cnt else None,
305
- 'url': f"https://www.goodreads.com/book/show/{bid.group(1)}",
306
- })
307
-
308
- return {'page': page, 'results': results}
309
-
310
- # Example
311
- lst = parse_list("1.Best_Books_Ever")
312
- # lst['results'][0] => {'rank': 1, 'book_id': '2767052',
313
- # 'title': 'The Hunger Games (The Hunger Games, #1)',
314
- # 'author': 'Suzanne Collins', 'avg_rating': 4.35, ...}
315
- ```
316
-
317
- **Field notes:**
318
- - 100 rows per page. Ranks are sequential across pages (page 2 starts at rank 101).
319
- - Paginate with `?page=2`, `?page=3` etc.
320
- - List pages do not use `__NEXT_DATA__` — same classic HTML format as author pages.
321
-
322
- ---
323
-
324
- ## Open Library API Fallback
325
-
326
- Use Open Library when you need structured JSON without HTML parsing, or when you want supplementary data (birth/death dates, ISBNs across editions, subjects).
327
-
328
- Open Library's ratings are from its own user base (~400 ratings vs. Goodreads' 800k+ for Dune) — use Goodreads ratings when accuracy matters.
329
-
330
- ### Search
331
-
332
- ```python
333
- import json
334
- from urllib.parse import quote_plus
335
- from helpers import http_get
336
-
337
- def ol_search(query, limit=10):
338
- url = f"https://openlibrary.org/search.json?q={quote_plus(query)}&limit={limit}"
339
- data = json.loads(http_get(url))
340
- results = []
341
- for doc in data.get('docs', []):
342
- cover_id = doc.get('cover_i')
343
- results.append({
344
- 'ol_key': doc['key'], # e.g. "/works/OL893415W"
345
- 'title': doc.get('title'),
346
- 'author': (doc.get('author_name') or [''])[0],
347
- 'author_key': (doc.get('author_key') or [''])[0],
348
- 'first_pub_year': doc.get('first_publish_year'),
349
- 'edition_count': doc.get('edition_count'),
350
- 'series': doc.get('series_name'),
351
- 'cover_url': f"https://covers.openlibrary.org/b/id/{cover_id}-M.jpg" if cover_id else None,
352
- })
353
- return {'total': data.get('numFound'), 'results': results}
354
-
355
- r = ol_search("dune frank herbert", limit=5)
356
- # r['results'][0]['ol_key'] => "/works/OL893415W"
357
- # r['results'][0]['title'] => "Dune"
358
- ```
359
-
360
- ### Work (book details)
361
-
362
- ```python
363
- def ol_work(ol_key):
364
- # ol_key like "/works/OL893415W" or just "OL893415W"
365
- key = ol_key if ol_key.startswith('/') else f'/works/{ol_key}'
366
- data = json.loads(http_get(f"https://openlibrary.org{key}.json"))
367
- desc = data.get('description', '')
368
- if isinstance(desc, dict):
369
- desc = desc.get('value', '')
370
- return {
371
- 'title': data.get('title'),
372
- 'subjects': data.get('subjects', []),
373
- 'series': data.get('series', []),
374
- 'description': desc,
375
- 'covers': data.get('covers', []),
376
- 'links': data.get('links', []),
377
- }
378
-
379
- work = ol_work("OL893415W")
380
- # work['title'] => "Dune"
381
- # work['subjects'] => ["Dune (Imaginary place)", "Fiction", ...]
382
- ```
383
-
384
- ### Ratings for a work
385
-
386
- ```python
387
- def ol_ratings(ol_key):
388
- key = ol_key if ol_key.startswith('/') else f'/works/{ol_key}'
389
- data = json.loads(http_get(f"https://openlibrary.org{key}/ratings.json"))
390
- return data.get('summary', {})
391
-
392
- # {'average': 4.30, 'count': 414, 'sortable': 4.21}
393
- ```
394
-
395
- ### Author
396
-
397
- ```python
398
- def ol_author(author_key):
399
- # author_key like "OL79034A"
400
- data = json.loads(http_get(f"https://openlibrary.org/authors/{author_key}.json"))
401
- bio = data.get('bio', '')
402
- if isinstance(bio, dict):
403
- bio = bio.get('value', '')
404
- return {
405
- 'name': data.get('name'),
406
- 'birth_date': data.get('birth_date'),
407
- 'death_date': data.get('death_date'),
408
- 'bio': bio,
409
- 'ol_key': data.get('key'),
410
- }
411
-
412
- author = ol_author("OL79034A")
413
- # author['name'] => "Frank Herbert"
414
- # author['birth_date'] => "8 October 1920"
415
- # author['death_date'] => "11 February 1986"
416
- ```
417
-
418
- ---
419
-
420
- ## Combining Goodreads + Open Library
421
-
422
- ```python
423
- # Get full book data: Goodreads for ratings/genres/description, OL for ISBNs/edition details
424
- def get_book_full(goodreads_book_id, ol_work_key=None):
425
- gr = parse_book(goodreads_book_id)
426
- result = dict(gr)
427
- if ol_work_key:
428
- ol = ol_work(ol_work_key)
429
- result['ol_subjects'] = ol['subjects']
430
- result['ol_description'] = ol['description']
431
- result['ol_covers'] = ol['covers']
432
- return result
433
- ```
434
-
435
- ---
436
-
437
- ## Gotchas
438
-
439
- - **Goodreads API is gone**: The official API was shut down in December 2020. All data must come from HTML scraping or the unofficial paths documented here.
440
-
441
- - **Book ID 5107 redirects**: The URL `goodreads.com/book/show/5107.The_Stand` actually resolves to *The Catcher in the Rye* (ID 5107). The Stand is ID `149267`. Always verify `book['legacyId']` matches the URL ID.
442
-
443
- - **Author page ID mismatch**: Author ID `10538` in the URL resolves to Carl Sagan, not Frank Herbert (ID `58`). Always obtain author IDs from the `author_url` field inside a book's data rather than guessing.
444
-
445
- - **Two Book entities in `apolloState`**: The `apolloState` contains multiple `Book:` entries — one is a stub (only has `legacyId` and `webUrl`), and one is full. Filter by `legacyId == int(book_id)` AND check that the entry has more than 3 fields.
446
-
447
- - **Ratings are on `Work`, not `Book`**: `avg_rating`, `ratingsCount`, and `ratingsCountDist` are in the `Work` entity's `stats` key. The `Book` entity has no rating fields.
448
-
449
- - **Author pages are old-style HTML**: Author pages (`/author/show/`) do not use Next.js or `__NEXT_DATA__`. Use OG meta tags and regex for extraction. The follower count only loads via JS — it will be missing from `http_get` responses.
450
-
451
- - **Search has no `__NEXT_DATA__`**: Search result pages (`/search`) are classic server-rendered HTML. JSON-LD is absent. Use the `<tr itemscope itemtype="http://schema.org/Book">` microdata rows.
452
-
453
- - **`ratings_count` regex order matters**: The pattern `r'(\d[\d,]*)\s*rating'` always matches the book's aggregate rating count first in each search row — this is reliable. Do not use `minirating` span text as it contains nested HTML.
454
-
455
- - **Open Library cover URLs return binary JPEG**: `http_get()` will raise a `UnicodeDecodeError` on cover image URLs. Use `urllib.request.urlopen()` directly and read bytes, or just store the URL string without fetching.
456
-
457
- - **Open Library ratings are sparse**: OL has ~400 community ratings for Dune vs. Goodreads' 1.6M. Use OL ratings only as a last resort.
458
-
459
- - **Search page `&mdash;` entity**: The raw HTML uses `&mdash;` (not `—`) between rating value and count in search and author pages. The regex patterns above match the decoded text because Python's `re` operates on the decoded string after `http_get()` decodes UTF-8.
460
-
461
- - **Book slug is optional**: `goodreads.com/book/show/44767458` (no slug) works identically to `goodreads.com/book/show/44767458-dune`. Redirects are transparent.
1
+ # Goodreads — Book Data Extraction
2
+
3
+ Field-tested against goodreads.com on 2026-04-18 via `http_get` (no browser required).
4
+ All five URL types return full HTML with no bot-wall, CAPTCHA, or login gate.
5
+
6
+ ## Access Summary
7
+
8
+ | Page type | `http_get` works? | Data format |
9
+ |--------------------|-------------------|--------------------------|
10
+ | Book show page | Yes | `__NEXT_DATA__` + JSON-LD |
11
+ | Search results | Yes | Server-rendered HTML (schema.org microdata) |
12
+ | Author show page | Yes | Server-rendered HTML + OG meta |
13
+ | Listopia list page | Yes | Server-rendered HTML (schema.org microdata) |
14
+
15
+ Goodreads shut down its public API in 2020. All extraction is HTML-based.
16
+ Open Library is a reliable supplement with a free JSON API (see [Open Library fallback](#open-library-api-fallback)).
17
+
18
+ ---
19
+
20
+ ## Book Page — Full Data (`__NEXT_DATA__`)
21
+
22
+ URL pattern: `https://www.goodreads.com/book/show/{book_id}` or `/{book_id}.{Slug}`
23
+
24
+ The slug is optional — numeric ID alone works and redirects cleanly.
25
+
26
+ ```python
27
+ import re, json
28
+ from helpers import http_get
29
+
30
+ def parse_book(book_id):
31
+ html = http_get(f"https://www.goodreads.com/book/show/{book_id}")
32
+
33
+ # Parse Apollo state from Next.js page
34
+ nd = re.search(r'<script id="__NEXT_DATA__"[^>]*>(.*?)</script>', html, re.DOTALL)
35
+ ap = json.loads(nd.group(1))['props']['pageProps']['apolloState']
36
+
37
+ # The primary Book entity matches the URL's legacy ID
38
+ book = next(v for v in ap.values()
39
+ if v.get('__typename') == 'Book' and v.get('legacyId') == int(book_id))
40
+ work = next((v for v in ap.values() if v.get('__typename') == 'Work'), {})
41
+ author_ref = book['primaryContributorEdge']['node']['__ref']
42
+ author = ap.get(author_ref, {})
43
+
44
+ stats = work.get('stats', {})
45
+ work_details = work.get('details', {})
46
+ book_details = book.get('details', {})
47
+
48
+ return {
49
+ 'title': book['title'],
50
+ 'title_complete': book['titleComplete'],
51
+ 'book_id': book['legacyId'],
52
+ 'url': book['webUrl'],
53
+ 'cover_url': book['imageUrl'],
54
+ # Strip HTML tags from description
55
+ 'description': re.sub(r'<[^>]+>', '', book.get('description({"stripped":true})',
56
+ book.get('description', ''))).strip(),
57
+ 'genres': [g['genre']['name'] for g in book.get('bookGenres', [])],
58
+ 'series': [{'name': s['series']['title'], 'position': s.get('userPosition')}
59
+ for s in book.get('bookSeries', [])],
60
+ # Author
61
+ 'author_name': author.get('name'),
62
+ 'author_url': author.get('webUrl'),
63
+ # Edition details
64
+ 'format': book_details.get('format'),
65
+ 'num_pages': book_details.get('numPages'),
66
+ 'publisher': book_details.get('publisher'),
67
+ 'language': (book_details.get('language') or {}).get('name'),
68
+ 'isbn': book_details.get('isbn'),
69
+ 'isbn13': book_details.get('isbn13'),
70
+ 'pub_timestamp_ms': book_details.get('publicationTime'),
71
+ # Ratings (from Work, not Book)
72
+ 'avg_rating': stats.get('averageRating'),
73
+ 'ratings_count': stats.get('ratingsCount'),
74
+ 'text_reviews': stats.get('textReviewsCount'),
75
+ # ratings_dist is list of counts for [1-star, 2-star, 3-star, 4-star, 5-star]
76
+ 'ratings_dist': stats.get('ratingsCountDist'),
77
+ # Awards
78
+ 'awards': [a['name'] + (' — ' + a['category'] if a.get('category') else '')
79
+ for a in work_details.get('awardsWon', [])],
80
+ }
81
+
82
+ # Example
83
+ book = parse_book(149267) # The Stand by Stephen King
84
+ # book['title'] => "The Stand"
85
+ # book['avg_rating'] => 4.35
86
+ # book['ratings_count']=> 845591
87
+ # book['genres'] => ["Horror", "Fiction", "Fantasy", ...]
88
+ # book['awards'] => ["Locus Award — Best SF Novel", ...]
89
+ ```
90
+
91
+ **Field notes:**
92
+ - `book['legacyId']` is the integer in the URL (e.g. `149267`). Use it to match the correct entity — the `apolloState` often contains 2-3 Book entries for different editions.
93
+ - Ratings and awards live in the `Work` entity, not `Book`. The `Work` is always `__typename == 'Work'`.
94
+ - `description` comes in two forms: `description` (HTML) and `description({"stripped":true})` (plain text). Prefer the stripped version.
95
+ - `pub_timestamp_ms` is a Unix timestamp in **milliseconds**. Convert: `datetime.fromtimestamp(ts/1000)`.
96
+ - `isbn` / `isbn13` are often `null` on older editions — the JSON-LD path (below) is no more reliable.
97
+
98
+ ---
99
+
100
+ ## Book Page — Fast Path (JSON-LD)
101
+
102
+ Use when you only need title, author, rating, page count, and awards. ~3× less parsing code.
103
+
104
+ ```python
105
+ import re, json
106
+ from helpers import http_get
107
+
108
+ def parse_book_fast(book_id):
109
+ html = http_get(f"https://www.goodreads.com/book/show/{book_id}")
110
+ blocks = re.findall(r'<script type="application/ld\+json">(.*?)</script>', html, re.DOTALL)
111
+ if not blocks:
112
+ return None
113
+ ld = json.loads(blocks[0])
114
+ return {
115
+ 'title': ld.get('name'),
116
+ 'author': ld['author'][0]['name'] if ld.get('author') else None,
117
+ 'avg_rating': ld.get('aggregateRating', {}).get('ratingValue'),
118
+ 'ratings_count':ld.get('aggregateRating', {}).get('ratingCount'),
119
+ 'review_count': ld.get('aggregateRating', {}).get('reviewCount'),
120
+ 'num_pages': ld.get('numberOfPages'),
121
+ 'isbn': ld.get('isbn'),
122
+ 'cover_url': ld.get('image'),
123
+ 'awards': ld.get('awards'), # single string, comma-separated
124
+ 'format': ld.get('bookFormat'),
125
+ }
126
+
127
+ book = parse_book_fast(149267)
128
+ # book['avg_rating'] => 4.35
129
+ # book['ratings_count']=> 845591
130
+ ```
131
+
132
+ **JSON-LD does NOT include:** description, genres, series membership, per-star rating distribution, publisher, language.
133
+ Use `parse_book()` (the `__NEXT_DATA__` path) when you need any of those.
134
+
135
+ ---
136
+
137
+ ## Search Results
138
+
139
+ URL: `https://www.goodreads.com/search?q={query}&search_type=books&page={n}`
140
+
141
+ Search uses server-rendered HTML with schema.org microdata `<tr>` rows. No `__NEXT_DATA__`.
142
+
143
+ ```python
144
+ import re, json
145
+ from helpers import http_get
146
+
147
+ def search_books(query, page=1):
148
+ from urllib.parse import quote_plus
149
+ url = f"https://www.goodreads.com/search?q={quote_plus(query)}&search_type=books&page={page}"
150
+ html = http_get(url)
151
+
152
+ rows = re.findall(
153
+ r'<tr itemscope itemtype="http://schema.org/Book">(.*?)</tr>',
154
+ html, re.DOTALL
155
+ )
156
+
157
+ results = []
158
+ for row in rows:
159
+ bid = re.search(r'<div id="(\d+)" class="u-anchorTarget">', row)
160
+ title = re.search(r"itemprop='name'[^>]*>([^<]+)</span>", row)
161
+ author = re.search(r'class="authorName"[^>]*><span[^>]*>([^<]+)</span>', row)
162
+ avg = re.search(r'(\d+\.\d+)\s*avg rating', row)
163
+ cnt = re.search(r'(\d[\d,]*)\s*rating', row)
164
+ cover = re.search(r'img alt="[^"]*" class="bookCover"[^>]*src="([^"]+)"', row)
165
+ if not (bid and title):
166
+ continue
167
+ results.append({
168
+ 'book_id': bid.group(1),
169
+ 'title': title.group(1).strip(),
170
+ 'author': author.group(1).strip() if author else None,
171
+ 'avg_rating': float(avg.group(1)) if avg else None,
172
+ 'ratings_count':cnt.group(1).replace(',', '') if cnt else None,
173
+ 'cover_url': cover.group(1) if cover else None,
174
+ 'url': f"https://www.goodreads.com/book/show/{bid.group(1)}",
175
+ })
176
+
177
+ total_m = re.search(r'([\d,]+)\s+results', html)
178
+ total = int(total_m.group(1).replace(',', '')) if total_m else None
179
+
180
+ return {'total': total, 'page': page, 'results': results}
181
+
182
+ # Example
183
+ r = search_books("dune")
184
+ # r['total'] => 101026
185
+ # r['results'] => [{'book_id':'44767458', 'title':'Dune (Dune, #1)', 'avg_rating':4.29, ...}, ...]
186
+ ```
187
+
188
+ **Field notes:**
189
+ - Returns exactly 20 results per page.
190
+ - `total` is the result count shown in `"N results for…"` header.
191
+ - The `avg rating` regex uses `&mdash;` (HTML entity) in the raw HTML — the pattern above matches the decoded text.
192
+ - `ratings_count` regex hits the first occurrence of `\d+ rating` in the row, which is always the book's count (not a user review count).
193
+ - `cover_url` is a 75px thumbnail (`._SY75_.jpg`). Swap `_SY75_` → `_SX315_` for a larger image.
194
+
195
+ ---
196
+
197
+ ## Author Page
198
+
199
+ URL: `https://www.goodreads.com/author/show/{author_id}.{Slug}`
200
+
201
+ Author pages are **not** Next.js — they use classic server-rendered HTML with OG meta tags and microdata.
202
+ The author ID and slug can be obtained from a book's `author_url` field.
203
+
204
+ ```python
205
+ import re, json
206
+ from helpers import http_get
207
+
208
+ def parse_author(author_id_and_slug):
209
+ # author_id_and_slug e.g. "58.Frank_Patrick_Herbert"
210
+ html = http_get(f"https://www.goodreads.com/author/show/{author_id_and_slug}")
211
+
212
+ # Name and basic info from OG/meta tags
213
+ name = re.search(r"<meta content='([^']+)' property='og:title'>", html)
214
+ img = re.search(r"<meta content='([^']+)' property='og:image'>", html)
215
+ website = re.search(r"Website\s*</div>\s*<div[^>]*>\s*<a[^>]*href=\"([^\"]+)\"", html)
216
+
217
+ # Full biography from hidden span (shown/hidden by "...more" toggle in browser)
218
+ bio_span = re.search(
219
+ r'<span id="freeText(?:author|long)\d+"[^>]*>(.*?)</span>',
220
+ html, re.DOTALL
221
+ )
222
+ bio = re.sub(r'<[^>]+>', '', bio_span.group(1)).strip() if bio_span else None
223
+
224
+ # Top books listed on the page (10 rows, same microdata format as search)
225
+ rows = re.findall(
226
+ r'<tr itemscope itemtype="http://schema.org/Book">(.*?)</tr>',
227
+ html, re.DOTALL
228
+ )
229
+ books = []
230
+ for row in rows:
231
+ bid = re.search(r'<div id="(\d+)" class="u-anchorTarget">', row)
232
+ title = re.search(r"itemprop='name'[^>]*>([^<]+)</span>", row)
233
+ avg = re.search(r'(\d+\.\d+)\s*avg rating', row)
234
+ cnt = re.search(r'(\d[\d,]*)\s*rating', row)
235
+ if bid and title:
236
+ books.append({
237
+ 'book_id': bid.group(1),
238
+ 'title': title.group(1).strip(),
239
+ 'avg_rating': float(avg.group(1)) if avg else None,
240
+ 'ratings_count':cnt.group(1).replace(',', '') if cnt else None,
241
+ 'url': f"https://www.goodreads.com/book/show/{bid.group(1)}",
242
+ })
243
+
244
+ return {
245
+ 'name': name.group(1) if name else None,
246
+ 'profile_image':img.group(1) if img else None,
247
+ 'bio': bio,
248
+ 'website': website.group(1) if website else None,
249
+ 'top_books': books,
250
+ }
251
+
252
+ # Example
253
+ author = parse_author("58.Frank_Patrick_Herbert")
254
+ # author['name'] => "Frank Patrick Herbert"
255
+ # author['bio'] => "Franklin Patrick Herbert Jr. was an American science fiction..."
256
+ # len(author['top_books']) => 10
257
+ ```
258
+
259
+ **Field notes:**
260
+ - Author IDs can be found in a book's `author_url` (from `__NEXT_DATA__` or JSON-LD).
261
+ - The slug is optional in the URL — numeric ID alone redirects correctly.
262
+ - `profile_image` from OG tag is a large portrait (p8 suffix = 800px). Swap to `p5` for 500px.
263
+ - The bio is server-rendered in a `<span id="freeTextauthor{ID}">` or `<span id="freeTextlong{ID}">` — which variant appears depends on length.
264
+ - Follower count is **not** present in the static HTML — it requires JS execution to appear.
265
+ - Page lists exactly 10 books. To get all books, paginate `/author/list/{author_id}?page=N`.
266
+
267
+ ---
268
+
269
+ ## Listopia List Page
270
+
271
+ URL: `https://www.goodreads.com/list/show/{list_id}.{Slug}?page={n}`
272
+
273
+ Returns 100 books per page with rank numbers.
274
+
275
+ ```python
276
+ import re, json
277
+ from helpers import http_get
278
+
279
+ def parse_list(list_id_and_slug, page=1):
280
+ url = f"https://www.goodreads.com/list/show/{list_id_and_slug}?page={page}"
281
+ html = http_get(url)
282
+
283
+ rows = re.findall(
284
+ r'<tr itemscope itemtype="http://schema.org/Book">(.*?)</tr>',
285
+ html, re.DOTALL
286
+ )
287
+
288
+ results = []
289
+ for row in rows:
290
+ rank = re.search(r'<td[^>]*class="number"[^>]*>(\d+)</td>', row)
291
+ bid = re.search(r'<div id="(\d+)" class="u-anchorTarget">', row)
292
+ title = re.search(r"itemprop='name'[^>]*>([^<]+)</span>", row)
293
+ author = re.search(r'class="authorName"[^>]*><span[^>]*>([^<]+)</span>', row)
294
+ avg = re.search(r'(\d+\.\d+)\s*avg rating', row)
295
+ cnt = re.search(r'(\d[\d,]*)\s*rating', row)
296
+ if not (bid and title):
297
+ continue
298
+ results.append({
299
+ 'rank': int(rank.group(1)) if rank else None,
300
+ 'book_id': bid.group(1),
301
+ 'title': title.group(1).strip(),
302
+ 'author': author.group(1).strip() if author else None,
303
+ 'avg_rating': float(avg.group(1)) if avg else None,
304
+ 'ratings_count':cnt.group(1).replace(',', '') if cnt else None,
305
+ 'url': f"https://www.goodreads.com/book/show/{bid.group(1)}",
306
+ })
307
+
308
+ return {'page': page, 'results': results}
309
+
310
+ # Example
311
+ lst = parse_list("1.Best_Books_Ever")
312
+ # lst['results'][0] => {'rank': 1, 'book_id': '2767052',
313
+ # 'title': 'The Hunger Games (The Hunger Games, #1)',
314
+ # 'author': 'Suzanne Collins', 'avg_rating': 4.35, ...}
315
+ ```
316
+
317
+ **Field notes:**
318
+ - 100 rows per page. Ranks are sequential across pages (page 2 starts at rank 101).
319
+ - Paginate with `?page=2`, `?page=3` etc.
320
+ - List pages do not use `__NEXT_DATA__` — same classic HTML format as author pages.
321
+
322
+ ---
323
+
324
+ ## Open Library API Fallback
325
+
326
+ Use Open Library when you need structured JSON without HTML parsing, or when you want supplementary data (birth/death dates, ISBNs across editions, subjects).
327
+
328
+ Open Library's ratings are from its own user base (~400 ratings vs. Goodreads' 800k+ for Dune) — use Goodreads ratings when accuracy matters.
329
+
330
+ ### Search
331
+
332
+ ```python
333
+ import json
334
+ from urllib.parse import quote_plus
335
+ from helpers import http_get
336
+
337
+ def ol_search(query, limit=10):
338
+ url = f"https://openlibrary.org/search.json?q={quote_plus(query)}&limit={limit}"
339
+ data = json.loads(http_get(url))
340
+ results = []
341
+ for doc in data.get('docs', []):
342
+ cover_id = doc.get('cover_i')
343
+ results.append({
344
+ 'ol_key': doc['key'], # e.g. "/works/OL893415W"
345
+ 'title': doc.get('title'),
346
+ 'author': (doc.get('author_name') or [''])[0],
347
+ 'author_key': (doc.get('author_key') or [''])[0],
348
+ 'first_pub_year': doc.get('first_publish_year'),
349
+ 'edition_count': doc.get('edition_count'),
350
+ 'series': doc.get('series_name'),
351
+ 'cover_url': f"https://covers.openlibrary.org/b/id/{cover_id}-M.jpg" if cover_id else None,
352
+ })
353
+ return {'total': data.get('numFound'), 'results': results}
354
+
355
+ r = ol_search("dune frank herbert", limit=5)
356
+ # r['results'][0]['ol_key'] => "/works/OL893415W"
357
+ # r['results'][0]['title'] => "Dune"
358
+ ```
359
+
360
+ ### Work (book details)
361
+
362
+ ```python
363
+ def ol_work(ol_key):
364
+ # ol_key like "/works/OL893415W" or just "OL893415W"
365
+ key = ol_key if ol_key.startswith('/') else f'/works/{ol_key}'
366
+ data = json.loads(http_get(f"https://openlibrary.org{key}.json"))
367
+ desc = data.get('description', '')
368
+ if isinstance(desc, dict):
369
+ desc = desc.get('value', '')
370
+ return {
371
+ 'title': data.get('title'),
372
+ 'subjects': data.get('subjects', []),
373
+ 'series': data.get('series', []),
374
+ 'description': desc,
375
+ 'covers': data.get('covers', []),
376
+ 'links': data.get('links', []),
377
+ }
378
+
379
+ work = ol_work("OL893415W")
380
+ # work['title'] => "Dune"
381
+ # work['subjects'] => ["Dune (Imaginary place)", "Fiction", ...]
382
+ ```
383
+
384
+ ### Ratings for a work
385
+
386
+ ```python
387
+ def ol_ratings(ol_key):
388
+ key = ol_key if ol_key.startswith('/') else f'/works/{ol_key}'
389
+ data = json.loads(http_get(f"https://openlibrary.org{key}/ratings.json"))
390
+ return data.get('summary', {})
391
+
392
+ # {'average': 4.30, 'count': 414, 'sortable': 4.21}
393
+ ```
394
+
395
+ ### Author
396
+
397
+ ```python
398
+ def ol_author(author_key):
399
+ # author_key like "OL79034A"
400
+ data = json.loads(http_get(f"https://openlibrary.org/authors/{author_key}.json"))
401
+ bio = data.get('bio', '')
402
+ if isinstance(bio, dict):
403
+ bio = bio.get('value', '')
404
+ return {
405
+ 'name': data.get('name'),
406
+ 'birth_date': data.get('birth_date'),
407
+ 'death_date': data.get('death_date'),
408
+ 'bio': bio,
409
+ 'ol_key': data.get('key'),
410
+ }
411
+
412
+ author = ol_author("OL79034A")
413
+ # author['name'] => "Frank Herbert"
414
+ # author['birth_date'] => "8 October 1920"
415
+ # author['death_date'] => "11 February 1986"
416
+ ```
417
+
418
+ ---
419
+
420
+ ## Combining Goodreads + Open Library
421
+
422
+ ```python
423
+ # Get full book data: Goodreads for ratings/genres/description, OL for ISBNs/edition details
424
+ def get_book_full(goodreads_book_id, ol_work_key=None):
425
+ gr = parse_book(goodreads_book_id)
426
+ result = dict(gr)
427
+ if ol_work_key:
428
+ ol = ol_work(ol_work_key)
429
+ result['ol_subjects'] = ol['subjects']
430
+ result['ol_description'] = ol['description']
431
+ result['ol_covers'] = ol['covers']
432
+ return result
433
+ ```
434
+
435
+ ---
436
+
437
+ ## Gotchas
438
+
439
+ - **Goodreads API is gone**: The official API was shut down in December 2020. All data must come from HTML scraping or the unofficial paths documented here.
440
+
441
+ - **Book ID 5107 redirects**: The URL `goodreads.com/book/show/5107.The_Stand` actually resolves to *The Catcher in the Rye* (ID 5107). The Stand is ID `149267`. Always verify `book['legacyId']` matches the URL ID.
442
+
443
+ - **Author page ID mismatch**: Author ID `10538` in the URL resolves to Carl Sagan, not Frank Herbert (ID `58`). Always obtain author IDs from the `author_url` field inside a book's data rather than guessing.
444
+
445
+ - **Two Book entities in `apolloState`**: The `apolloState` contains multiple `Book:` entries — one is a stub (only has `legacyId` and `webUrl`), and one is full. Filter by `legacyId == int(book_id)` AND check that the entry has more than 3 fields.
446
+
447
+ - **Ratings are on `Work`, not `Book`**: `avg_rating`, `ratingsCount`, and `ratingsCountDist` are in the `Work` entity's `stats` key. The `Book` entity has no rating fields.
448
+
449
+ - **Author pages are old-style HTML**: Author pages (`/author/show/`) do not use Next.js or `__NEXT_DATA__`. Use OG meta tags and regex for extraction. The follower count only loads via JS — it will be missing from `http_get` responses.
450
+
451
+ - **Search has no `__NEXT_DATA__`**: Search result pages (`/search`) are classic server-rendered HTML. JSON-LD is absent. Use the `<tr itemscope itemtype="http://schema.org/Book">` microdata rows.
452
+
453
+ - **`ratings_count` regex order matters**: The pattern `r'(\d[\d,]*)\s*rating'` always matches the book's aggregate rating count first in each search row — this is reliable. Do not use `minirating` span text as it contains nested HTML.
454
+
455
+ - **Open Library cover URLs return binary JPEG**: `http_get()` will raise a `UnicodeDecodeError` on cover image URLs. Use `urllib.request.urlopen()` directly and read bytes, or just store the URL string without fetching.
456
+
457
+ - **Open Library ratings are sparse**: OL has ~400 community ratings for Dune vs. Goodreads' 1.6M. Use OL ratings only as a last resort.
458
+
459
+ - **Search page `&mdash;` entity**: The raw HTML uses `&mdash;` (not `—`) between rating value and count in search and author pages. The regex patterns above match the decoded text because Python's `re` operates on the decoded string after `http_get()` decodes UTF-8.
460
+
461
+ - **Book slug is optional**: `goodreads.com/book/show/44767458` (no slug) works identically to `goodreads.com/book/show/44767458-dune`. Redirects are transparent.