@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,341 +1,341 @@
1
- # Internet Archive / Wayback Machine — Scraping & Data Extraction
2
-
3
- `https://archive.org` / `https://web.archive.org` — all public data, no auth required. Every workflow here is pure `http_get` — no browser needed.
4
-
5
- ## Do this first
6
-
7
- **Use the CDX API for anything Wayback-related — it is the reliable workhorse. The Wayback Availability API (`/wayback/available`) is known to return empty `archived_snapshots` even for well-archived URLs and should not be used as a primary mechanism.**
8
-
9
- ```python
10
- import json
11
-
12
- # Find snapshots of any URL — primary entry point for Wayback data
13
- r = http_get(
14
- "https://web.archive.org/cdx/search/cdx"
15
- "?url=iana.org&output=json&limit=5"
16
- "&fl=timestamp,original,statuscode,mimetype,length",
17
- timeout=40.0
18
- )
19
- rows = json.loads(r)
20
- headers = rows[0] # ['timestamp', 'original', 'statuscode', 'mimetype', 'length']
21
- for row in rows[1:]:
22
- ts, orig, status, mime, length = row
23
- snap_url = f"https://web.archive.org/web/{ts}/{orig}"
24
- print(f"{ts} {status} {snap_url}")
25
- ```
26
-
27
- For item metadata (books, video, audio, software), go straight to:
28
-
29
- ```python
30
- data = json.loads(http_get("https://archive.org/metadata/{identifier}", timeout=30.0))
31
- ```
32
-
33
- ## Common workflows
34
-
35
- ### Find the nearest archived snapshot to a target date
36
-
37
- ```python
38
- import json
39
-
40
- # CDX sort=closest returns the single snapshot nearest to the given timestamp
41
- r = http_get(
42
- "https://web.archive.org/cdx/search/cdx"
43
- "?url=iana.org&output=json&limit=1"
44
- "&fl=timestamp,original,statuscode"
45
- "&closest=20230601120000&sort=closest",
46
- timeout=60.0 # CDX can be slow — always use timeout >= 40s
47
- )
48
- rows = json.loads(r)
49
- # rows[0] = header, rows[1] = closest snapshot
50
- ts, orig, status = rows[1]
51
- snap_url = f"https://web.archive.org/web/{ts}/{orig}"
52
- # Result: ts='20230601114925', orig='https://www.iana.org/', status='200'
53
- # snap_url: https://web.archive.org/web/20230601114925/https://www.iana.org/
54
- ```
55
-
56
- Timestamp format is always 14-digit `YYYYMMDDHHMMSS`. Pass any prefix — `20230601` (day), `202306` (month), `2023` (year) — and CDX will match.
57
-
58
- ### List all monthly snapshots for a URL (collapsed)
59
-
60
- ```python
61
- import json
62
-
63
- r = http_get(
64
- "https://web.archive.org/cdx/search/cdx"
65
- "?url=iana.org&output=json"
66
- "&collapse=timestamp:6" # :6 = dedupe by YYYYMM (one per month)
67
- "&from=20230101&to=20231231"
68
- "&fl=timestamp,original",
69
- timeout=60.0
70
- )
71
- rows = json.loads(r)
72
- # rows[0] = header ['timestamp', 'original']
73
- # rows[1:] = one row per month:
74
- # ['20230101103807', 'https://www.iana.org/']
75
- # ['20230201144829', 'https://www.iana.org/']
76
- # ...12 rows for 2023
77
-
78
- for ts, orig in rows[1:]:
79
- print(f"{ts[:4]}-{ts[4:6]} https://web.archive.org/web/{ts}/{orig}")
80
- ```
81
-
82
- `collapse=timestamp:N` deduplicates by the first N digits of the timestamp:
83
- - `:4` = one per year, `:6` = one per month, `:8` = one per day
84
-
85
- ### List snapshots for an entire domain (all pages)
86
-
87
- ```python
88
- import json
89
-
90
- # matchType=domain captures all URLs under that domain
91
- r = http_get(
92
- "https://web.archive.org/cdx/search/cdx"
93
- "?url=iana.org&matchType=domain&output=json"
94
- "&limit=10&fl=timestamp,original,statuscode"
95
- "&collapse=timestamp:8", # one capture per URL per day
96
- timeout=60.0
97
- )
98
- rows = json.loads(r)
99
- for row in rows[1:]:
100
- print(row)
101
- # ['19971210061738', 'http://www.iana.org:80/', '200']
102
- # ['19980211065537', 'http://www.iana.org:80/', '200']
103
- # ...
104
- ```
105
-
106
- `matchType` options: `exact` (default), `prefix` (URL + subpaths), `host` (all subdomains), `domain` (host + all subdomains).
107
-
108
- ### Filter snapshots by prefix path
109
-
110
- ```python
111
- import json
112
-
113
- # All archived pages under /domains/ path
114
- r = http_get(
115
- "https://web.archive.org/cdx/search/cdx"
116
- "?url=iana.org/domains/&matchType=prefix&output=json"
117
- "&limit=5&fl=timestamp,original,statuscode",
118
- timeout=40.0
119
- )
120
- rows = json.loads(r)
121
- for row in rows[1:]:
122
- print(row)
123
- # ['20080509121811', 'http://www.iana.org/domains/', '200']
124
- # ['20080704174537', 'http://iana.org/domains/', '200']
125
- ```
126
-
127
- ### Paginate CDX results with resumeKey
128
-
129
- ```python
130
- import json
131
- from urllib.parse import quote
132
-
133
- def cdx_all_snapshots(url, fl="timestamp,original,statuscode", page_size=500):
134
- """Iterate all CDX records for a URL, yielding rows (excluding header)."""
135
- base = (
136
- f"https://web.archive.org/cdx/search/cdx"
137
- f"?url={quote(url, safe='')}&output=json"
138
- f"&fl={fl}&limit={page_size}&showResumeKey=true"
139
- )
140
- resume_key = None
141
- while True:
142
- endpoint = base if resume_key is None else f"{base}&resumeKey={quote(resume_key)}"
143
- rows = json.loads(http_get(endpoint, timeout=60.0))
144
- # rows structure with showResumeKey=true:
145
- # [header, row1, row2, ..., [], [resume_key_string]]
146
- # The second-to-last row is [] (separator), last row is [resume_key]
147
- has_resume = len(rows) >= 2 and rows[-1] != [] and rows[-2] == []
148
- data_rows = rows[1:-2] if has_resume else rows[1:]
149
- for row in data_rows:
150
- yield row
151
- if not has_resume:
152
- break
153
- resume_key = rows[-1][0]
154
-
155
- for row in cdx_all_snapshots("iana.org", fl="timestamp,original"):
156
- ts, orig = row
157
- # process...
158
- ```
159
-
160
- ### Retrieve the actual archived page
161
-
162
- ```python
163
- # Direct snapshot URL: /web/{14-digit-timestamp}/{original-url}
164
- snap_url = "https://web.archive.org/web/19971210061738/http://www.iana.org:80/"
165
- content = http_get(snap_url, timeout=30.0)
166
- # Returns the archived HTML with Wayback toolbar injected at top
167
- # The toolbar is inside <!-- BEGIN WAYBACK TOOLBAR INSERT --> comments
168
-
169
- # The calendar view URL pattern (for browser navigation, not http_get):
170
- # https://web.archive.org/web/20230101000000*/python.org
171
- # The * tells Wayback to show the calendar — returns HTML, not raw page
172
- ```
173
-
174
- ### Item metadata (books, video, audio, software, collections)
175
-
176
- ```python
177
- import json
178
- from urllib.parse import quote
179
-
180
- identifier = "HardWonWisdomTrailer"
181
- data = json.loads(http_get(f"https://archive.org/metadata/{identifier}", timeout=30.0))
182
-
183
- # Top-level keys:
184
- # alternate_locations, created, d1, d2, dir, files, files_count,
185
- # is_collection, item_last_updated, item_size, metadata, server, uniq, workable_servers
186
-
187
- meta = data['metadata']
188
- # Common metadata fields (not all present on every item):
189
- print(meta.get('identifier')) # 'HardWonWisdomTrailer'
190
- print(meta.get('title')) # 'Hard Won Wisdom Trailer'
191
- print(meta.get('mediatype')) # 'movies' | 'texts' | 'audio' | 'software' | 'collection'
192
- print(meta.get('creator')) # 'jakemauz'
193
- print(meta.get('date')) # '2017-02-18'
194
- print(meta.get('description')) # HTML string — strip tags if needed
195
- print(meta.get('subject')) # str OR list of str depending on item
196
- print(meta.get('publicdate')) # '2017-02-18 11:51:16'
197
- print(meta.get('collection')) # parent collection identifier
198
-
199
- files = data['files']
200
- # Each file entry:
201
- # name, source ('original'|'derivative'|'metadata'), format, size (bytes as str),
202
- # md5, sha1, crc32, mtime
203
- # For video/audio: length (seconds as str), height, width
204
- # For derivative: original (name of source file)
205
-
206
- # Find the primary original file
207
- orig_files = [f for f in files if f.get('source') == 'original']
208
- # orig_files[0]: {'name': 'Hard-won wisdom trailer.mp4', 'source': 'original',
209
- # 'format': 'MPEG4', 'size': '7532153', 'length': '94.13',
210
- # 'height': '360', 'width': '640', 'md5': 'aaeebe0481...', ...}
211
-
212
- # Build download URL — two equivalent forms:
213
- server = data['server'] # 'ia601405.us.archive.org'
214
- dir_path = data['dir'] # '/2/items/HardWonWisdomTrailer'
215
- fname = orig_files[0]['name']
216
- from urllib.parse import quote as urlquote
217
- # Form 1: direct storage server (fastest)
218
- url1 = f"https://{server}{dir_path}/{urlquote(fname)}"
219
- # Form 2: standard redirect URL (always works, resolved by CDN)
220
- url2 = f"https://archive.org/download/{identifier}/{urlquote(fname)}"
221
- # Both confirmed status 200, Content-Type: video/mp4
222
- ```
223
-
224
- ### Search items (books, audio, video, software)
225
-
226
- ```python
227
- import json
228
-
229
- # advancedsearch.php is the correct API — /search returns HTML
230
- r = http_get(
231
- "https://archive.org/advancedsearch.php"
232
- "?q=artificial+intelligence+AND+mediatype:texts"
233
- "&fl[]=identifier&fl[]=title&fl[]=creator&fl[]=date&fl[]=downloads"
234
- "&rows=5&sort[]=downloads+desc&output=json",
235
- timeout=30.0
236
- )
237
- data = json.loads(r)
238
- # data['responseHeader']['status'] = 0 (success)
239
- # data['responseHeader']['QTime'] = query time ms
240
- # data['response']['numFound'] = 25911 (total matches)
241
- # data['response']['start'] = 0 (offset)
242
- # data['response']['docs'] = list of item dicts
243
-
244
- resp = data['response']
245
- print(f"Total: {resp['numFound']}, showing: {len(resp['docs'])}")
246
- for doc in resp['docs']:
247
- print(f" {doc['identifier']} {doc.get('title', '')[:50]}")
248
- # doc fields are only present if they have values — always use .get()
249
- ```
250
-
251
- Pagination: use `start=` offset (not `page=`). Max `rows=` is not documented but 100 works reliably.
252
-
253
- ### Search with all supported parameters
254
-
255
- ```python
256
- import json
257
-
258
- r = http_get(
259
- "https://archive.org/advancedsearch.php"
260
- "?q=machine+learning+AND+mediatype:texts" # Lucene query syntax
261
- "&fl[]=identifier&fl[]=title&fl[]=date&fl[]=year"
262
- "&fl[]=creator&fl[]=subject&fl[]=description&fl[]=downloads"
263
- "&rows=3"
264
- "&start=0" # pagination offset
265
- "&sort[]=date+desc" # sort field + direction
266
- "&output=json",
267
- timeout=30.0
268
- )
269
- data = json.loads(r)
270
- # Confirmed fields in fl[]:
271
- # identifier, title, date, year, creator, subject, description,
272
- # downloads, mediatype, collection, language, avg_rating, num_reviews
273
-
274
- # mediatype values: texts, audio, movies, software, image, etree, data, collection, account
275
- # Sort fields: date, downloads, avg_rating, num_reviews, publicdate, addeddate
276
- ```
277
-
278
- ## API reference
279
-
280
- | Endpoint | What it returns | Auth |
281
- |---|---|---|
282
- | `web.archive.org/cdx/search/cdx?url=...&output=json` | Snapshot index: all captures of a URL | None |
283
- | `archive.org/wayback/available?url=...` | Nearest snapshot (DEGRADED — see gotchas) | None |
284
- | `archive.org/metadata/{identifier}` | Item metadata + files list | None |
285
- | `archive.org/advancedsearch.php?q=...&output=json` | Full-text + metadata search | None |
286
- | `archive.org/download/{identifier}/{filename}` | Direct file download | None |
287
- | `web.archive.org/web/{timestamp}/{url}` | Archived page HTML | None |
288
-
289
- ## CDX field reference
290
-
291
- The CDX API returns a JSON array of arrays. The first row is always the header when `output=json`.
292
-
293
- | Field | Description | Example |
294
- |---|---|---|
295
- | `urlkey` | SURT-format URL (reversed domain, path in parens) | `org,iana)/` |
296
- | `timestamp` | Capture time, 14-digit `YYYYMMDDHHMMSS` | `19971210061738` |
297
- | `original` | Original crawled URL (exact, including port) | `http://www.iana.org:80/` |
298
- | `mimetype` | Content-Type of the archived response | `text/html` |
299
- | `statuscode` | HTTP status at crawl time | `200` |
300
- | `digest` | SHA-1 of response body, base32-encoded | `I4YBMQ6PHPWE2TD6TIXNWHZB6MXRNTSR` |
301
- | `length` | Content length in bytes (as string) | `1418` |
302
-
303
- Default `fl=` when omitted: `urlkey,timestamp,original,mimetype,statuscode,digest,length` (all 7 fields in that order).
304
-
305
- ## Rate limits
306
-
307
- No auth, no API key. In practice:
308
- - CDX API: **intermittently slow** — individual queries time out at 20s and succeed at 40–60s. Always use `timeout=40.0` minimum. 3 rapid sequential CDX calls in ~10s completed; 10 rapid calls produced 3 timeouts.
309
- - Metadata API: Fast and reliable — 5 sequential calls completed in 3.0s with no errors.
310
- - Search API: Fast — typically responds in 30–65ms (`QTime` in response header).
311
- - No documented per-second or per-day limits. Archive.org's policy is to be respectful: add `time.sleep(1)` between CDX calls in loops.
312
-
313
- ## Gotchas
314
-
315
- - **CDX times out — always set `timeout=40.0` or higher.** The default 20s is often too short for CDX. Metadata and search APIs are fine at 20–30s. CDX slowness is backend-side and unpredictable; add retry logic for production use.
316
-
317
- - **Wayback Availability API is unreliable.** `GET /wayback/available?url=iana.org` returns `{"url": "iana.org", "archived_snapshots": {}}` even for URLs confirmed archived via CDX. Tested 2026-04-18 across many URLs and timestamp combinations — consistently empty. Use `CDX ?sort=closest&limit=1` instead (confirmed working).
318
-
319
- - **CDX first row is always the header when `output=json`.** `rows[0]` is `['timestamp', 'original', ...]`, not a data row. Always slice `rows[1:]` for data. When `showResumeKey=true`, the last two rows are `[]` (separator) and `['<resume_key_string>']`.
320
-
321
- - **CDX `fl=` must match exactly what you iterate.** If you request `&fl=timestamp,original` you get 2-element rows; forgetting a field breaks destructuring. When in doubt, omit `fl=` entirely and get all 7 fields.
322
-
323
- - **`output=json` is required — there is no default JSON mode.** Omitting `output=json` returns space-separated text. `output=text` also works and is slightly faster for simple queries.
324
-
325
- - **`timestamp` is a string, not an integer.** Even in JSON, CDX returns all fields as strings: `'1418'` not `1418`, `'200'` not `200`. Cast explicitly: `int(row[4])`, `int(row[6])`.
326
-
327
- - **The `original` field preserves port numbers.** Old crawls captured `http://www.iana.org:80/` — the `:80` is part of the URL. When building a playback URL, use `original` verbatim: `f"https://web.archive.org/web/{ts}/{orig}"` works correctly with the port included.
328
-
329
- - **Metadata `{}` means the item doesn't exist or is private.** `http_get("https://archive.org/metadata/nonexistent")` returns `'{}'` (2-byte response) with HTTP 200. Always check `if not data` or `if not data.get('metadata')` before accessing fields.
330
-
331
- - **Metadata `subject` can be a string or a list.** When a single subject tag is set, the API returns `"subject": "short film"`. When multiple, it returns `"subject": ["short film", "spoken word"]`. Normalize with: `subjects = [meta['subject']] if isinstance(meta.get('subject'), str) else meta.get('subject', [])`.
332
-
333
- - **File `size` and `length` are strings, not numbers.** `files[0]['size']` is `'7532153'` (bytes). `files[0]['length']` is `'94.13'` (seconds for video/audio). Cast with `int()` and `float()` respectively.
334
-
335
- - **Use `archive.org/download/` not the raw storage server URL for reliability.** The raw URL (`ia601405.us.archive.org/2/items/...`) is faster but server-specific. `archive.org/download/{id}/{file}` redirects to the correct storage node and remains stable as items migrate.
336
-
337
- - **`/search?output=json` returns HTML, not JSON.** The `/search` endpoint is a React SPA — it ignores `output=json`. Always use `advancedsearch.php` for programmatic access.
338
-
339
- - **`collapse=timestamp:6` gives one row per month, but it keeps the FIRST capture of that month.** If you want the last, you'd need to reverse and re-collapse, or fetch all and filter client-side. The `collapse` parameter de-duplicates by truncating the timestamp to N digits and keeping the first matching row.
340
-
341
- - **CDX `from=` / `to=` accept partial timestamps.** `from=20230101` means `20230101000000`. `to=20231231` means `20231231000000` (exclusive). To include all of 2023, use `to=20240101`.
1
+ # Internet Archive / Wayback Machine — Scraping & Data Extraction
2
+
3
+ `https://archive.org` / `https://web.archive.org` — all public data, no auth required. Every workflow here is pure `http_get` — no browser needed.
4
+
5
+ ## Do this first
6
+
7
+ **Use the CDX API for anything Wayback-related — it is the reliable workhorse. The Wayback Availability API (`/wayback/available`) is known to return empty `archived_snapshots` even for well-archived URLs and should not be used as a primary mechanism.**
8
+
9
+ ```python
10
+ import json
11
+
12
+ # Find snapshots of any URL — primary entry point for Wayback data
13
+ r = http_get(
14
+ "https://web.archive.org/cdx/search/cdx"
15
+ "?url=iana.org&output=json&limit=5"
16
+ "&fl=timestamp,original,statuscode,mimetype,length",
17
+ timeout=40.0
18
+ )
19
+ rows = json.loads(r)
20
+ headers = rows[0] # ['timestamp', 'original', 'statuscode', 'mimetype', 'length']
21
+ for row in rows[1:]:
22
+ ts, orig, status, mime, length = row
23
+ snap_url = f"https://web.archive.org/web/{ts}/{orig}"
24
+ print(f"{ts} {status} {snap_url}")
25
+ ```
26
+
27
+ For item metadata (books, video, audio, software), go straight to:
28
+
29
+ ```python
30
+ data = json.loads(http_get("https://archive.org/metadata/{identifier}", timeout=30.0))
31
+ ```
32
+
33
+ ## Common workflows
34
+
35
+ ### Find the nearest archived snapshot to a target date
36
+
37
+ ```python
38
+ import json
39
+
40
+ # CDX sort=closest returns the single snapshot nearest to the given timestamp
41
+ r = http_get(
42
+ "https://web.archive.org/cdx/search/cdx"
43
+ "?url=iana.org&output=json&limit=1"
44
+ "&fl=timestamp,original,statuscode"
45
+ "&closest=20230601120000&sort=closest",
46
+ timeout=60.0 # CDX can be slow — always use timeout >= 40s
47
+ )
48
+ rows = json.loads(r)
49
+ # rows[0] = header, rows[1] = closest snapshot
50
+ ts, orig, status = rows[1]
51
+ snap_url = f"https://web.archive.org/web/{ts}/{orig}"
52
+ # Result: ts='20230601114925', orig='https://www.iana.org/', status='200'
53
+ # snap_url: https://web.archive.org/web/20230601114925/https://www.iana.org/
54
+ ```
55
+
56
+ Timestamp format is always 14-digit `YYYYMMDDHHMMSS`. Pass any prefix — `20230601` (day), `202306` (month), `2023` (year) — and CDX will match.
57
+
58
+ ### List all monthly snapshots for a URL (collapsed)
59
+
60
+ ```python
61
+ import json
62
+
63
+ r = http_get(
64
+ "https://web.archive.org/cdx/search/cdx"
65
+ "?url=iana.org&output=json"
66
+ "&collapse=timestamp:6" # :6 = dedupe by YYYYMM (one per month)
67
+ "&from=20230101&to=20231231"
68
+ "&fl=timestamp,original",
69
+ timeout=60.0
70
+ )
71
+ rows = json.loads(r)
72
+ # rows[0] = header ['timestamp', 'original']
73
+ # rows[1:] = one row per month:
74
+ # ['20230101103807', 'https://www.iana.org/']
75
+ # ['20230201144829', 'https://www.iana.org/']
76
+ # ...12 rows for 2023
77
+
78
+ for ts, orig in rows[1:]:
79
+ print(f"{ts[:4]}-{ts[4:6]} https://web.archive.org/web/{ts}/{orig}")
80
+ ```
81
+
82
+ `collapse=timestamp:N` deduplicates by the first N digits of the timestamp:
83
+ - `:4` = one per year, `:6` = one per month, `:8` = one per day
84
+
85
+ ### List snapshots for an entire domain (all pages)
86
+
87
+ ```python
88
+ import json
89
+
90
+ # matchType=domain captures all URLs under that domain
91
+ r = http_get(
92
+ "https://web.archive.org/cdx/search/cdx"
93
+ "?url=iana.org&matchType=domain&output=json"
94
+ "&limit=10&fl=timestamp,original,statuscode"
95
+ "&collapse=timestamp:8", # one capture per URL per day
96
+ timeout=60.0
97
+ )
98
+ rows = json.loads(r)
99
+ for row in rows[1:]:
100
+ print(row)
101
+ # ['19971210061738', 'http://www.iana.org:80/', '200']
102
+ # ['19980211065537', 'http://www.iana.org:80/', '200']
103
+ # ...
104
+ ```
105
+
106
+ `matchType` options: `exact` (default), `prefix` (URL + subpaths), `host` (all subdomains), `domain` (host + all subdomains).
107
+
108
+ ### Filter snapshots by prefix path
109
+
110
+ ```python
111
+ import json
112
+
113
+ # All archived pages under /domains/ path
114
+ r = http_get(
115
+ "https://web.archive.org/cdx/search/cdx"
116
+ "?url=iana.org/domains/&matchType=prefix&output=json"
117
+ "&limit=5&fl=timestamp,original,statuscode",
118
+ timeout=40.0
119
+ )
120
+ rows = json.loads(r)
121
+ for row in rows[1:]:
122
+ print(row)
123
+ # ['20080509121811', 'http://www.iana.org/domains/', '200']
124
+ # ['20080704174537', 'http://iana.org/domains/', '200']
125
+ ```
126
+
127
+ ### Paginate CDX results with resumeKey
128
+
129
+ ```python
130
+ import json
131
+ from urllib.parse import quote
132
+
133
+ def cdx_all_snapshots(url, fl="timestamp,original,statuscode", page_size=500):
134
+ """Iterate all CDX records for a URL, yielding rows (excluding header)."""
135
+ base = (
136
+ f"https://web.archive.org/cdx/search/cdx"
137
+ f"?url={quote(url, safe='')}&output=json"
138
+ f"&fl={fl}&limit={page_size}&showResumeKey=true"
139
+ )
140
+ resume_key = None
141
+ while True:
142
+ endpoint = base if resume_key is None else f"{base}&resumeKey={quote(resume_key)}"
143
+ rows = json.loads(http_get(endpoint, timeout=60.0))
144
+ # rows structure with showResumeKey=true:
145
+ # [header, row1, row2, ..., [], [resume_key_string]]
146
+ # The second-to-last row is [] (separator), last row is [resume_key]
147
+ has_resume = len(rows) >= 2 and rows[-1] != [] and rows[-2] == []
148
+ data_rows = rows[1:-2] if has_resume else rows[1:]
149
+ for row in data_rows:
150
+ yield row
151
+ if not has_resume:
152
+ break
153
+ resume_key = rows[-1][0]
154
+
155
+ for row in cdx_all_snapshots("iana.org", fl="timestamp,original"):
156
+ ts, orig = row
157
+ # process...
158
+ ```
159
+
160
+ ### Retrieve the actual archived page
161
+
162
+ ```python
163
+ # Direct snapshot URL: /web/{14-digit-timestamp}/{original-url}
164
+ snap_url = "https://web.archive.org/web/19971210061738/http://www.iana.org:80/"
165
+ content = http_get(snap_url, timeout=30.0)
166
+ # Returns the archived HTML with Wayback toolbar injected at top
167
+ # The toolbar is inside <!-- BEGIN WAYBACK TOOLBAR INSERT --> comments
168
+
169
+ # The calendar view URL pattern (for browser navigation, not http_get):
170
+ # https://web.archive.org/web/20230101000000*/python.org
171
+ # The * tells Wayback to show the calendar — returns HTML, not raw page
172
+ ```
173
+
174
+ ### Item metadata (books, video, audio, software, collections)
175
+
176
+ ```python
177
+ import json
178
+ from urllib.parse import quote
179
+
180
+ identifier = "HardWonWisdomTrailer"
181
+ data = json.loads(http_get(f"https://archive.org/metadata/{identifier}", timeout=30.0))
182
+
183
+ # Top-level keys:
184
+ # alternate_locations, created, d1, d2, dir, files, files_count,
185
+ # is_collection, item_last_updated, item_size, metadata, server, uniq, workable_servers
186
+
187
+ meta = data['metadata']
188
+ # Common metadata fields (not all present on every item):
189
+ print(meta.get('identifier')) # 'HardWonWisdomTrailer'
190
+ print(meta.get('title')) # 'Hard Won Wisdom Trailer'
191
+ print(meta.get('mediatype')) # 'movies' | 'texts' | 'audio' | 'software' | 'collection'
192
+ print(meta.get('creator')) # 'jakemauz'
193
+ print(meta.get('date')) # '2017-02-18'
194
+ print(meta.get('description')) # HTML string — strip tags if needed
195
+ print(meta.get('subject')) # str OR list of str depending on item
196
+ print(meta.get('publicdate')) # '2017-02-18 11:51:16'
197
+ print(meta.get('collection')) # parent collection identifier
198
+
199
+ files = data['files']
200
+ # Each file entry:
201
+ # name, source ('original'|'derivative'|'metadata'), format, size (bytes as str),
202
+ # md5, sha1, crc32, mtime
203
+ # For video/audio: length (seconds as str), height, width
204
+ # For derivative: original (name of source file)
205
+
206
+ # Find the primary original file
207
+ orig_files = [f for f in files if f.get('source') == 'original']
208
+ # orig_files[0]: {'name': 'Hard-won wisdom trailer.mp4', 'source': 'original',
209
+ # 'format': 'MPEG4', 'size': '7532153', 'length': '94.13',
210
+ # 'height': '360', 'width': '640', 'md5': 'aaeebe0481...', ...}
211
+
212
+ # Build download URL — two equivalent forms:
213
+ server = data['server'] # 'ia601405.us.archive.org'
214
+ dir_path = data['dir'] # '/2/items/HardWonWisdomTrailer'
215
+ fname = orig_files[0]['name']
216
+ from urllib.parse import quote as urlquote
217
+ # Form 1: direct storage server (fastest)
218
+ url1 = f"https://{server}{dir_path}/{urlquote(fname)}"
219
+ # Form 2: standard redirect URL (always works, resolved by CDN)
220
+ url2 = f"https://archive.org/download/{identifier}/{urlquote(fname)}"
221
+ # Both confirmed status 200, Content-Type: video/mp4
222
+ ```
223
+
224
+ ### Search items (books, audio, video, software)
225
+
226
+ ```python
227
+ import json
228
+
229
+ # advancedsearch.php is the correct API — /search returns HTML
230
+ r = http_get(
231
+ "https://archive.org/advancedsearch.php"
232
+ "?q=artificial+intelligence+AND+mediatype:texts"
233
+ "&fl[]=identifier&fl[]=title&fl[]=creator&fl[]=date&fl[]=downloads"
234
+ "&rows=5&sort[]=downloads+desc&output=json",
235
+ timeout=30.0
236
+ )
237
+ data = json.loads(r)
238
+ # data['responseHeader']['status'] = 0 (success)
239
+ # data['responseHeader']['QTime'] = query time ms
240
+ # data['response']['numFound'] = 25911 (total matches)
241
+ # data['response']['start'] = 0 (offset)
242
+ # data['response']['docs'] = list of item dicts
243
+
244
+ resp = data['response']
245
+ print(f"Total: {resp['numFound']}, showing: {len(resp['docs'])}")
246
+ for doc in resp['docs']:
247
+ print(f" {doc['identifier']} {doc.get('title', '')[:50]}")
248
+ # doc fields are only present if they have values — always use .get()
249
+ ```
250
+
251
+ Pagination: use `start=` offset (not `page=`). Max `rows=` is not documented but 100 works reliably.
252
+
253
+ ### Search with all supported parameters
254
+
255
+ ```python
256
+ import json
257
+
258
+ r = http_get(
259
+ "https://archive.org/advancedsearch.php"
260
+ "?q=machine+learning+AND+mediatype:texts" # Lucene query syntax
261
+ "&fl[]=identifier&fl[]=title&fl[]=date&fl[]=year"
262
+ "&fl[]=creator&fl[]=subject&fl[]=description&fl[]=downloads"
263
+ "&rows=3"
264
+ "&start=0" # pagination offset
265
+ "&sort[]=date+desc" # sort field + direction
266
+ "&output=json",
267
+ timeout=30.0
268
+ )
269
+ data = json.loads(r)
270
+ # Confirmed fields in fl[]:
271
+ # identifier, title, date, year, creator, subject, description,
272
+ # downloads, mediatype, collection, language, avg_rating, num_reviews
273
+
274
+ # mediatype values: texts, audio, movies, software, image, etree, data, collection, account
275
+ # Sort fields: date, downloads, avg_rating, num_reviews, publicdate, addeddate
276
+ ```
277
+
278
+ ## API reference
279
+
280
+ | Endpoint | What it returns | Auth |
281
+ |---|---|---|
282
+ | `web.archive.org/cdx/search/cdx?url=...&output=json` | Snapshot index: all captures of a URL | None |
283
+ | `archive.org/wayback/available?url=...` | Nearest snapshot (DEGRADED — see gotchas) | None |
284
+ | `archive.org/metadata/{identifier}` | Item metadata + files list | None |
285
+ | `archive.org/advancedsearch.php?q=...&output=json` | Full-text + metadata search | None |
286
+ | `archive.org/download/{identifier}/{filename}` | Direct file download | None |
287
+ | `web.archive.org/web/{timestamp}/{url}` | Archived page HTML | None |
288
+
289
+ ## CDX field reference
290
+
291
+ The CDX API returns a JSON array of arrays. The first row is always the header when `output=json`.
292
+
293
+ | Field | Description | Example |
294
+ |---|---|---|
295
+ | `urlkey` | SURT-format URL (reversed domain, path in parens) | `org,iana)/` |
296
+ | `timestamp` | Capture time, 14-digit `YYYYMMDDHHMMSS` | `19971210061738` |
297
+ | `original` | Original crawled URL (exact, including port) | `http://www.iana.org:80/` |
298
+ | `mimetype` | Content-Type of the archived response | `text/html` |
299
+ | `statuscode` | HTTP status at crawl time | `200` |
300
+ | `digest` | SHA-1 of response body, base32-encoded | `I4YBMQ6PHPWE2TD6TIXNWHZB6MXRNTSR` |
301
+ | `length` | Content length in bytes (as string) | `1418` |
302
+
303
+ Default `fl=` when omitted: `urlkey,timestamp,original,mimetype,statuscode,digest,length` (all 7 fields in that order).
304
+
305
+ ## Rate limits
306
+
307
+ No auth, no API key. In practice:
308
+ - CDX API: **intermittently slow** — individual queries time out at 20s and succeed at 40–60s. Always use `timeout=40.0` minimum. 3 rapid sequential CDX calls in ~10s completed; 10 rapid calls produced 3 timeouts.
309
+ - Metadata API: Fast and reliable — 5 sequential calls completed in 3.0s with no errors.
310
+ - Search API: Fast — typically responds in 30–65ms (`QTime` in response header).
311
+ - No documented per-second or per-day limits. Archive.org's policy is to be respectful: add `time.sleep(1)` between CDX calls in loops.
312
+
313
+ ## Gotchas
314
+
315
+ - **CDX times out — always set `timeout=40.0` or higher.** The default 20s is often too short for CDX. Metadata and search APIs are fine at 20–30s. CDX slowness is backend-side and unpredictable; add retry logic for production use.
316
+
317
+ - **Wayback Availability API is unreliable.** `GET /wayback/available?url=iana.org` returns `{"url": "iana.org", "archived_snapshots": {}}` even for URLs confirmed archived via CDX. Tested 2026-04-18 across many URLs and timestamp combinations — consistently empty. Use `CDX ?sort=closest&limit=1` instead (confirmed working).
318
+
319
+ - **CDX first row is always the header when `output=json`.** `rows[0]` is `['timestamp', 'original', ...]`, not a data row. Always slice `rows[1:]` for data. When `showResumeKey=true`, the last two rows are `[]` (separator) and `['<resume_key_string>']`.
320
+
321
+ - **CDX `fl=` must match exactly what you iterate.** If you request `&fl=timestamp,original` you get 2-element rows; forgetting a field breaks destructuring. When in doubt, omit `fl=` entirely and get all 7 fields.
322
+
323
+ - **`output=json` is required — there is no default JSON mode.** Omitting `output=json` returns space-separated text. `output=text` also works and is slightly faster for simple queries.
324
+
325
+ - **`timestamp` is a string, not an integer.** Even in JSON, CDX returns all fields as strings: `'1418'` not `1418`, `'200'` not `200`. Cast explicitly: `int(row[4])`, `int(row[6])`.
326
+
327
+ - **The `original` field preserves port numbers.** Old crawls captured `http://www.iana.org:80/` — the `:80` is part of the URL. When building a playback URL, use `original` verbatim: `f"https://web.archive.org/web/{ts}/{orig}"` works correctly with the port included.
328
+
329
+ - **Metadata `{}` means the item doesn't exist or is private.** `http_get("https://archive.org/metadata/nonexistent")` returns `'{}'` (2-byte response) with HTTP 200. Always check `if not data` or `if not data.get('metadata')` before accessing fields.
330
+
331
+ - **Metadata `subject` can be a string or a list.** When a single subject tag is set, the API returns `"subject": "short film"`. When multiple, it returns `"subject": ["short film", "spoken word"]`. Normalize with: `subjects = [meta['subject']] if isinstance(meta.get('subject'), str) else meta.get('subject', [])`.
332
+
333
+ - **File `size` and `length` are strings, not numbers.** `files[0]['size']` is `'7532153'` (bytes). `files[0]['length']` is `'94.13'` (seconds for video/audio). Cast with `int()` and `float()` respectively.
334
+
335
+ - **Use `archive.org/download/` not the raw storage server URL for reliability.** The raw URL (`ia601405.us.archive.org/2/items/...`) is faster but server-specific. `archive.org/download/{id}/{file}` redirects to the correct storage node and remains stable as items migrate.
336
+
337
+ - **`/search?output=json` returns HTML, not JSON.** The `/search` endpoint is a React SPA — it ignores `output=json`. Always use `advancedsearch.php` for programmatic access.
338
+
339
+ - **`collapse=timestamp:6` gives one row per month, but it keeps the FIRST capture of that month.** If you want the last, you'd need to reverse and re-collapse, or fetch all and filter client-side. The `collapse` parameter de-duplicates by truncating the timestamp to N digits and keeping the first matching row.
340
+
341
+ - **CDX `from=` / `to=` accept partial timestamps.** `from=20230101` means `20230101000000`. `to=20231231` means `20231231000000` (exclusive). To include all of 2023, use `to=20240101`.