@pencil-agent/nano-pencil 2.0.1 → 2.0.2
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.
- package/README.md +267 -267
- package/dist/build-meta.json +3 -3
- package/dist/core/export-html/AGENT.md +11 -11
- package/dist/core/export-html/template.css +971 -971
- package/dist/core/export-html/template.html +54 -54
- package/dist/core/model/custom-providers.js +1 -1
- package/dist/core/model-registry.js +5 -5
- package/dist/extensions/builtin/AGENT.md +115 -115
- package/dist/extensions/builtin/browser/AGENT.md +17 -17
- package/dist/extensions/builtin/browser/agent-workspace/agent_helpers.py +12 -12
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/amazon/product-search.md +198 -198
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/archive-org/scraping.md +341 -341
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv/scraping.md +311 -311
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv-bulk/scraping.md +333 -333
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/atlas/overview.md +70 -70
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/booking-com/scraping.md +578 -578
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/capterra/scraping.md +440 -440
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/centilebrain/generate-estimates.md +110 -110
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coingecko/scraping.md +325 -325
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coinmarketcap/scraping.md +463 -463
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coursera/scraping.md +360 -360
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/craigslist/scraping.md +390 -390
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/crossref/scraping.md +568 -568
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/dev-to/scraping.md +323 -323
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/duckduckgo/scraping.md +349 -349
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/ebay/scraping.md +435 -435
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/etsy/scraping.md +506 -506
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/eventbrite/scraping.md +363 -363
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/expedia/automation.md +168 -168
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/groups.md +236 -236
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/pages.md +295 -295
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/framer/editor.md +108 -108
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/fred/scraping.md +493 -493
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/g2/scraping.md +580 -580
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/genius/scraping.md +511 -511
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/repo-actions.md +65 -65
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/scraping.md +184 -184
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/glassdoor/scraping.md +543 -543
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gmail/compose.md +122 -122
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/goodreads/scraping.md +461 -461
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gutenberg/scraping.md +383 -383
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/hackernews/scraping.md +243 -243
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/howlongtobeat/scraping.md +473 -473
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/imdb/scraping.md +271 -271
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/itch-io/scraping.md +436 -436
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/job-boards/indeed-glassdoor.md +1021 -1021
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/letterboxd/scraping.md +349 -349
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/linkedin/invitation-manager.md +109 -109
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/loom/folder-enumeration.md +170 -170
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/macrotrends/scraping.md +537 -537
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/article-hydration.md +120 -120
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/scraping.md +414 -414
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/metacritic/scraping.md +477 -477
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/musicbrainz/scraping.md +478 -478
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/nasa/scraping.md +339 -339
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/news-aggregation/multi-source.md +205 -205
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/open-library/scraping.md +472 -472
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openalex/scraping.md +470 -470
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openstreetmap/scraping.md +490 -490
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/package-registries/npm-pypi.md +478 -478
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/polymarket/scraping.md +234 -234
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/producthunt/scraping.md +307 -307
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/pubmed/scraping.md +421 -421
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/quora/scraping.md +364 -364
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rawg/scraping.md +352 -352
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/reddit/scraping.md +124 -124
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rest-countries/scraping.md +233 -233
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/sec-edgar/scraping.md +361 -361
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/README.md +36 -36
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/embedded-apps.md +72 -72
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/knowledge-base.md +109 -109
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/polaris-inputs.md +137 -137
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/soundcloud/scraping.md +362 -362
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/spotify/scraping.md +339 -339
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/stackoverflow/scraping.md +435 -435
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/steam/scraping.md +575 -575
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/substack/scraping.md +338 -338
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/thetechgeeks/pricing.md +52 -52
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tiktok/upload.md +107 -107
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tradingview/scraping.md +309 -309
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trello/boards-and-lists.md +88 -88
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trustpilot/scraping.md +375 -375
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/walmart/scraping.md +444 -444
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wayback-machine/scraping.md +306 -306
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/weather/scraping.md +398 -398
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wellfound/scraping.md +596 -596
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/world-bank/scraping.md +356 -356
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/xiaohongshu/scraping.md +84 -84
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/youtube/scraping.md +418 -418
- package/dist/extensions/builtin/browser/agent-workspace/domain-skills/zillow/scraping.md +433 -433
- package/dist/extensions/builtin/browser/browser.md +73 -73
- package/dist/extensions/builtin/browser/install.md +142 -142
- package/dist/extensions/builtin/browser/interaction-skills/connection.md +48 -48
- package/dist/extensions/builtin/browser/interaction-skills/cookies.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/cross-origin-iframes.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/dialogs.md +64 -64
- package/dist/extensions/builtin/browser/interaction-skills/downloads.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/drag-and-drop.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/dropdowns.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/iframes.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/network-requests.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/print-as-pdf.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/profile-sync.md +90 -90
- package/dist/extensions/builtin/browser/interaction-skills/screenshots.md +17 -17
- package/dist/extensions/builtin/browser/interaction-skills/scrolling.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/shadow-dom.md +3 -3
- package/dist/extensions/builtin/browser/interaction-skills/tabs.md +69 -69
- package/dist/extensions/builtin/browser/interaction-skills/uploads.md +1 -1
- package/dist/extensions/builtin/browser/interaction-skills/viewport.md +3 -3
- package/dist/extensions/builtin/browser/src/browser_harness/AGENT.md +15 -15
- package/dist/extensions/builtin/browser/src/browser_harness/__init__.py +8 -8
- package/dist/extensions/builtin/browser/src/browser_harness/_ipc.py +90 -90
- package/dist/extensions/builtin/browser/src/browser_harness/admin.py +722 -722
- package/dist/extensions/builtin/browser/src/browser_harness/daemon.py +328 -328
- package/dist/extensions/builtin/browser/src/browser_harness/helpers.py +396 -396
- package/dist/extensions/builtin/browser/src/browser_harness/run.py +103 -103
- package/dist/extensions/builtin/discipline/skills/brainstorming/SKILL.md +33 -33
- package/dist/extensions/builtin/discipline/skills/executing-plans/SKILL.md +25 -25
- package/dist/extensions/builtin/discipline/skills/finishing-development-branch/SKILL.md +25 -25
- package/dist/extensions/builtin/discipline/skills/receiving-code-review/SKILL.md +22 -22
- package/dist/extensions/builtin/discipline/skills/requesting-code-review/SKILL.md +31 -31
- package/dist/extensions/builtin/discipline/skills/systematic-debugging/SKILL.md +28 -28
- package/dist/extensions/builtin/discipline/skills/test-driven-development/SKILL.md +32 -32
- package/dist/extensions/builtin/discipline/skills/using-git-worktrees/SKILL.md +25 -25
- package/dist/extensions/builtin/discipline/skills/verification-before-completion/SKILL.md +27 -27
- package/dist/extensions/builtin/discipline/skills/writing-plans/SKILL.md +26 -26
- package/dist/extensions/builtin/goal/README.md +67 -67
- package/dist/extensions/builtin/grub/README.md +112 -112
- package/dist/extensions/builtin/link-world/agent-workspace/README.md +16 -16
- package/dist/extensions/builtin/link-world/internet-search/internet-search.md +65 -65
- package/dist/extensions/builtin/link-world/link-world-agent.md +82 -82
- package/dist/extensions/builtin/link-world/linkworld.md +313 -313
- package/dist/extensions/builtin/link-world/network-routing/network-routing.md +67 -67
- package/dist/extensions/builtin/loop/README.md +92 -92
- package/dist/extensions/builtin/mcp/figma-design.md +68 -68
- package/dist/extensions/builtin/mcp/mcp-management.md +85 -85
- package/dist/extensions/builtin/recap/AGENT.md +15 -15
- package/dist/extensions/builtin/sal/README.md +72 -72
- package/dist/extensions/builtin/security-audit/README.md +289 -289
- package/dist/extensions/builtin/team/AGENT.md +112 -112
- package/dist/extensions/builtin/team/TESTING.md +299 -299
- package/dist/extensions/builtin/token-save/README.md +56 -56
- package/dist/extensions/optional/AGENT.md +10 -10
- package/dist/modes/interactive/controllers/input-submit-controller.js +2 -2
- package/dist/modes/interactive/controllers/stream-render-controller.js +2 -2
- package/dist/modes/interactive/interactive-mode.js +19 -19
- package/dist/modes/interactive/theme/dark.json +85 -85
- package/dist/modes/interactive/theme/light.json +84 -84
- package/dist/modes/interactive/theme/theme-schema.json +335 -335
- package/dist/modes/interactive/theme/warm.json +81 -81
- package/dist/node_modules/@pencil-agent/ai/dist/cli.js +0 -0
- package/dist/node_modules/@pencil-agent/ai/dist/models.generated.js +1 -1
- 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
- package/docs/SDK-TESTING.md +364 -0
- package/docs/codex-goal-command-impl.md +1055 -1055
- package/docs/codex-goal-vs-grub.md +500 -500
- package/docs/custom-provider.md +27 -27
- package/docs/extensions.md +27 -27
- package/docs/keybindings.md +27 -27
- package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/200/273/347/273/223.md" +250 -250
- package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/212/245/345/221/212.md" +122 -122
- package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210.md" +1222 -1222
- 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
- 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
- package/docs/loop /351/207/215/346/236/204/350/256/241/345/210/222.md" +320 -320
- package/docs/loop-usage-examples.md +214 -214
- package/docs/mem-core/346/212/200/346/234/257/346/226/207/346/241/243.md +593 -0
- package/docs/models.md +27 -27
- package/docs/packages.md +27 -27
- package/docs/pi-design-philosophy.md +457 -457
- package/docs/planmode.md +1987 -1987
- package/docs/prompt-templates.md +27 -27
- package/docs/providers.md +27 -27
- package/docs/sdk.md +27 -27
- package/docs/skills.md +27 -27
- package/docs/startup-performance-optimization.md +301 -0
- package/docs/themes.md +27 -27
- package/docs/tui.md +27 -27
- package/docs//350/256/244/347/237/245/345/234/260/345/233/276.md +47 -0
- package/package.json +190 -190
- package/docs/cc-agent-design.md +0 -1297
- package/docs/cc-tui-design.md +0 -1333
- package/docs/nanoPencil-/345/255/246/344/271/240/350/256/241/345/210/222.md +0 -170
- package/docs/scan-report.md +0 -3820
- package/docs//345/257/271/346/240/207Claude-Code.md +0 -1775
- package/docs//351/230/277/351/207/214/345/267/264/345/267/264/350/264/242/346/212/245/345/210/206/346/236/220/344/271/246.md +0 -261
|
@@ -1,323 +1,323 @@
|
|
|
1
|
-
# DEV Community (dev.to) — Data Extraction
|
|
2
|
-
|
|
3
|
-
`https://dev.to` — developer blogging platform. Everything useful is available via a public REST API with no auth required. No browser needed for any read task.
|
|
4
|
-
|
|
5
|
-
## Do this first
|
|
6
|
-
|
|
7
|
-
**Use the REST API — it returns clean JSON in ~150–250ms with no browser, no login, no JS rendering.**
|
|
8
|
-
|
|
9
|
-
```python
|
|
10
|
-
import json
|
|
11
|
-
articles = json.loads(http_get("https://dev.to/api/articles?per_page=10&tag=python"))
|
|
12
|
-
# Each article: id, title, description, url, cover_image, tag_list, tags,
|
|
13
|
-
# published_at, published_timestamp, readable_publish_date,
|
|
14
|
-
# reading_time_minutes, positive_reactions_count,
|
|
15
|
-
# public_reactions_count, comments_count, user, organization,
|
|
16
|
-
# flare_tag, collection_id, slug, path, canonical_url,
|
|
17
|
-
# social_image, language, subforem_id
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
The API serves **V0 (beta) by default** and emits a `Warning: 299` header on every response. Suppress it silently with the V1 `Accept` header (same data, no deprecated warning):
|
|
21
|
-
|
|
22
|
-
```python
|
|
23
|
-
import json
|
|
24
|
-
import urllib.request, gzip
|
|
25
|
-
|
|
26
|
-
def dev_get(url):
|
|
27
|
-
h = {
|
|
28
|
-
"User-Agent": "Mozilla/5.0",
|
|
29
|
-
"Accept-Encoding": "gzip",
|
|
30
|
-
"Accept": "application/vnd.forem.api-v1+json",
|
|
31
|
-
}
|
|
32
|
-
with urllib.request.urlopen(urllib.request.Request(url, headers=h), timeout=20) as r:
|
|
33
|
-
data = r.read()
|
|
34
|
-
if r.headers.get("Content-Encoding") == "gzip":
|
|
35
|
-
data = gzip.decompress(data)
|
|
36
|
-
return data.decode()
|
|
37
|
-
|
|
38
|
-
articles = json.loads(dev_get("https://dev.to/api/articles?per_page=10&tag=python"))
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Or just use `http_get` directly if you don't care about the warning header noise.
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
## Common workflows
|
|
46
|
-
|
|
47
|
-
### Articles by tag
|
|
48
|
-
|
|
49
|
-
```python
|
|
50
|
-
import json
|
|
51
|
-
articles = json.loads(http_get("https://dev.to/api/articles?per_page=10&tag=python"))
|
|
52
|
-
# Paginate with &page=2, &page=3 etc. (1-indexed)
|
|
53
|
-
for a in articles:
|
|
54
|
-
print(a['id'], a['positive_reactions_count'], a['title'][:60])
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Confirmed working tags: `python`, `javascript`, `typescript`, `rust`, `go`, `webdev`, `tutorial`, `react`, `devops`, `ai`, `beginners`.
|
|
58
|
-
|
|
59
|
-
### Top articles by time window
|
|
60
|
-
|
|
61
|
-
```python
|
|
62
|
-
import json
|
|
63
|
-
# top=N means "top articles from the last N days"
|
|
64
|
-
top_day = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=1"))
|
|
65
|
-
top_week = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=7"))
|
|
66
|
-
top_month = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=30"))
|
|
67
|
-
top_year = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=365"))
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
### Articles by username
|
|
71
|
-
|
|
72
|
-
```python
|
|
73
|
-
import json
|
|
74
|
-
articles = json.loads(http_get("https://dev.to/api/articles?per_page=10&username=ben"))
|
|
75
|
-
# Paginates cleanly: page=1, page=2 etc. Return distinct IDs, no overlap.
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### New and rising articles
|
|
79
|
-
|
|
80
|
-
```python
|
|
81
|
-
import json
|
|
82
|
-
fresh = json.loads(http_get("https://dev.to/api/articles?per_page=10&state=fresh")) # very new
|
|
83
|
-
rising = json.loads(http_get("https://dev.to/api/articles?per_page=10&state=rising")) # gaining traction
|
|
84
|
-
# state=all returns 0 results (requires auth, not useful unauthenticated)
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Single article by ID (adds body_html and body_markdown)
|
|
88
|
-
|
|
89
|
-
```python
|
|
90
|
-
import json
|
|
91
|
-
article = json.loads(http_get("https://dev.to/api/articles/3442047"))
|
|
92
|
-
# Full article adds two fields not in list response:
|
|
93
|
-
# body_html — rendered HTML (safe to display directly)
|
|
94
|
-
# body_markdown — raw Markdown source
|
|
95
|
-
print(len(article['body_html']), len(article['body_markdown']))
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### Single article by username/slug
|
|
99
|
-
|
|
100
|
-
```python
|
|
101
|
-
import json
|
|
102
|
-
# path field from list response is "/username/slug"
|
|
103
|
-
article = json.loads(http_get("https://dev.to/api/articles/ben/some-article-slug"))
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### Tags — popular list with colors
|
|
107
|
-
|
|
108
|
-
```python
|
|
109
|
-
import json
|
|
110
|
-
tags = json.loads(http_get("https://dev.to/api/tags?per_page=10"))
|
|
111
|
-
# Fields: id, name, bg_color_hex, text_color_hex, short_summary
|
|
112
|
-
# Sorted by popularity. Paginate with &page=2 etc.
|
|
113
|
-
for t in tags:
|
|
114
|
-
print(t['name'], t['bg_color_hex'], t['text_color_hex'])
|
|
115
|
-
# e.g. webdev #562765 #ffffff
|
|
116
|
-
# javascript #f7df1e #000000
|
|
117
|
-
# ai #17fd1a #ffffff
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
### User profile
|
|
121
|
-
|
|
122
|
-
```python
|
|
123
|
-
import json
|
|
124
|
-
user = json.loads(http_get("https://dev.to/api/users/by_username?url=ben"))
|
|
125
|
-
# Fields: type_of, id, username, name, twitter_username, github_username,
|
|
126
|
-
# summary, location, website_url, joined_at, profile_image
|
|
127
|
-
print(user['id'], user['username'], user['summary'])
|
|
128
|
-
# e.g. 1 ben "A Canadian software developer who thinks he's funny."
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
`joined_at` is a human string like `"Dec 27, 2015"` — not ISO 8601. Parse with `datetime.strptime(user['joined_at'], "%b %d, %Y")`.
|
|
132
|
-
|
|
133
|
-
### Comments on an article
|
|
134
|
-
|
|
135
|
-
```python
|
|
136
|
-
import json
|
|
137
|
-
comments = json.loads(http_get("https://dev.to/api/comments?a_id=3442047"))
|
|
138
|
-
# Returns top-level comments only (replies nested under children key)
|
|
139
|
-
# Fields per comment: id_code (string, not int!), type_of, body_html,
|
|
140
|
-
# created_at, user (dict), children (list of same shape)
|
|
141
|
-
for c in comments:
|
|
142
|
-
print(c['id_code'], c['user']['username'], c['created_at'])
|
|
143
|
-
for reply in c.get('children', []):
|
|
144
|
-
print(" reply:", reply['id_code'], reply['user']['username'])
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
### Single comment by id_code
|
|
148
|
-
|
|
149
|
-
```python
|
|
150
|
-
import json
|
|
151
|
-
comment = json.loads(http_get("https://dev.to/api/comments/36lnc"))
|
|
152
|
-
# Same fields as above: id_code, body_html, created_at, user, children
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
### Bulk tag fetch (parallel)
|
|
156
|
-
|
|
157
|
-
```python
|
|
158
|
-
import json
|
|
159
|
-
from concurrent.futures import ThreadPoolExecutor
|
|
160
|
-
|
|
161
|
-
tags = ['python', 'javascript', 'typescript', 'rust', 'go',
|
|
162
|
-
'devops', 'webdev', 'tutorial', 'productivity', 'react']
|
|
163
|
-
|
|
164
|
-
def fetch_tag(tag):
|
|
165
|
-
data = json.loads(http_get(f"https://dev.to/api/articles?per_page=5&tag={tag}"))
|
|
166
|
-
return tag, data
|
|
167
|
-
|
|
168
|
-
with ThreadPoolExecutor(max_workers=3) as ex:
|
|
169
|
-
results = dict(ex.map(lambda t: fetch_tag(t), tags))
|
|
170
|
-
# 10 tags × 5 articles each: ~0.67s total with max_workers=3
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
---
|
|
174
|
-
|
|
175
|
-
## Endpoint reference
|
|
176
|
-
|
|
177
|
-
| Endpoint | Auth | Key params | Latency |
|
|
178
|
-
|----------|------|-----------|---------|
|
|
179
|
-
| `GET /api/articles` | None | `tag`, `username`, `top`, `state`, `page`, `per_page` | ~200ms |
|
|
180
|
-
| `GET /api/articles/{id}` | None | — | ~80ms |
|
|
181
|
-
| `GET /api/articles/{username}/{slug}` | None | — | ~200ms |
|
|
182
|
-
| `GET /api/tags` | None | `page`, `per_page` | ~190ms |
|
|
183
|
-
| `GET /api/users/by_username?url={username}` | None | — | ~190ms |
|
|
184
|
-
| `GET /api/comments?a_id={article_id}` | None | — | ~160ms |
|
|
185
|
-
| `GET /api/comments/{id_code}` | None | — | ~150ms |
|
|
186
|
-
| `GET /api/listings` | None | `category`, `page`, `per_page` | ~260ms (returns 0) |
|
|
187
|
-
|
|
188
|
-
**Listings endpoint returns 0 results.** The `/api/listings` endpoint is documented but returns an empty array for all categories (`jobs`, `forsale`, `education`, `cfp`) without auth. Skip it.
|
|
189
|
-
|
|
190
|
-
---
|
|
191
|
-
|
|
192
|
-
## Pagination
|
|
193
|
-
|
|
194
|
-
All list endpoints paginate with `page=` (1-indexed) and `per_page=`:
|
|
195
|
-
|
|
196
|
-
```python
|
|
197
|
-
import json
|
|
198
|
-
|
|
199
|
-
def get_all_articles_by_tag(tag, max_pages=5):
|
|
200
|
-
results = []
|
|
201
|
-
for page in range(1, max_pages + 1):
|
|
202
|
-
batch = json.loads(http_get(
|
|
203
|
-
f"https://dev.to/api/articles?per_page=30&tag={tag}&page={page}"
|
|
204
|
-
))
|
|
205
|
-
if not batch:
|
|
206
|
-
break
|
|
207
|
-
results.extend(batch)
|
|
208
|
-
return results
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
- `per_page` supports up to **1000** (confirmed). No documented max, but 1000 works in testing.
|
|
212
|
-
- No `total_count` field in list responses — you paginate until an empty array.
|
|
213
|
-
- Page ordering is consistent — confirmed no ID overlap between page 1 and page 2.
|
|
214
|
-
|
|
215
|
-
---
|
|
216
|
-
|
|
217
|
-
## Article field reference
|
|
218
|
-
|
|
219
|
-
All fields returned in list responses (single article adds `body_html` and `body_markdown`):
|
|
220
|
-
|
|
221
|
-
```
|
|
222
|
-
id int — article ID, stable, use for single-article fetch
|
|
223
|
-
title str
|
|
224
|
-
description str — auto-excerpt, never null
|
|
225
|
-
slug str — URL slug component
|
|
226
|
-
path str — "/username/slug"
|
|
227
|
-
url str — full canonical URL
|
|
228
|
-
canonical_url str — same as url for native posts; author's site URL for cross-posts
|
|
229
|
-
cover_image str|null — CDN URL or null (~30% of articles have no cover image)
|
|
230
|
-
social_image str — always present (generated if no cover_image)
|
|
231
|
-
tag_list list — e.g. ['python', 'ai', 'tutorial'] ← use this for code
|
|
232
|
-
tags str — same tags as comma-separated string "python, ai, tutorial"
|
|
233
|
-
published_at str — ISO 8601 UTC e.g. "2026-04-18T03:49:36Z"
|
|
234
|
-
published_timestamp str — identical to published_at
|
|
235
|
-
readable_publish_date str — human string e.g. "Apr 18"
|
|
236
|
-
reading_time_minutes int
|
|
237
|
-
positive_reactions_count int — hearts/likes count
|
|
238
|
-
public_reactions_count int — total reactions (usually same as positive_reactions_count)
|
|
239
|
-
comments_count int
|
|
240
|
-
user dict — name, username, twitter_username, github_username,
|
|
241
|
-
user_id, website_url, profile_image, profile_image_90
|
|
242
|
-
organization dict|null — present when posted under an org: name, username, slug,
|
|
243
|
-
profile_image, profile_image_90
|
|
244
|
-
flare_tag dict|null — {name, bg_color_hex, text_color_hex} — discussion/challenge badge
|
|
245
|
-
collection_id int|null — series/collection ID if part of a series
|
|
246
|
-
language str — e.g. "en"
|
|
247
|
-
subforem_id int|null
|
|
248
|
-
crossposted_at str|null — ISO datetime if cross-posted
|
|
249
|
-
edited_at str|null
|
|
250
|
-
last_comment_at str|null
|
|
251
|
-
created_at str — ISO 8601
|
|
252
|
-
type_of str — always "article"
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
---
|
|
256
|
-
|
|
257
|
-
## Rate limits
|
|
258
|
-
|
|
259
|
-
- **Burst limit: ~6 rapid sequential requests**, then HTTP 429.
|
|
260
|
-
- **Recovery: `Retry-After: 1` second** — wait 1s after a 429 and you're good again.
|
|
261
|
-
- No `X-RateLimit-*` headers in 200 responses — you only see `Retry-After` on the 429 itself.
|
|
262
|
-
- With `ThreadPoolExecutor(max_workers=3)`, 10 concurrent requests succeed without hitting the limit.
|
|
263
|
-
- No difference in limits between V0 (default) and V1 (`Accept` header) — same underlying rate limit.
|
|
264
|
-
- **No auth token tested** — all endpoints above work without `api_key`. Authenticated requests likely have higher limits.
|
|
265
|
-
|
|
266
|
-
Safe pattern for bulk fetching:
|
|
267
|
-
|
|
268
|
-
```python
|
|
269
|
-
import json, time
|
|
270
|
-
from concurrent.futures import ThreadPoolExecutor
|
|
271
|
-
|
|
272
|
-
def safe_fetch(url):
|
|
273
|
-
for attempt in range(3):
|
|
274
|
-
try:
|
|
275
|
-
return json.loads(http_get(url))
|
|
276
|
-
except Exception as e:
|
|
277
|
-
if '429' in str(e):
|
|
278
|
-
time.sleep(1) # Retry-After is 1s
|
|
279
|
-
continue
|
|
280
|
-
raise
|
|
281
|
-
return []
|
|
282
|
-
|
|
283
|
-
urls = [
|
|
284
|
-
f"https://dev.to/api/articles?per_page=10&tag={tag}"
|
|
285
|
-
for tag in ['python', 'javascript', 'typescript', 'rust']
|
|
286
|
-
]
|
|
287
|
-
with ThreadPoolExecutor(max_workers=3) as ex:
|
|
288
|
-
results = list(ex.map(safe_fetch, urls))
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
---
|
|
292
|
-
|
|
293
|
-
## Gotchas
|
|
294
|
-
|
|
295
|
-
- **`tag_list` (list) vs `tags` (string)** — both fields always present. `tag_list` is a Python list; `tags` is the same data as a comma-separated string. Use `tag_list` in code.
|
|
296
|
-
|
|
297
|
-
- **Comments have `id_code`, not `id`** — comment identifiers are alphanumeric strings like `"36lnc"`, not integers. The integer `id` field is absent from comment objects. Use `id_code` to fetch a specific comment via `GET /api/comments/{id_code}`.
|
|
298
|
-
|
|
299
|
-
- **Comments endpoint returns top-level only** — replies are nested under `children` recursively, not returned as a flat list. A thread with 100 total comments may only show 60 top-level objects; walk `children` recursively to count all.
|
|
300
|
-
|
|
301
|
-
- **`cover_image` can be null** — ~30% of articles have no cover image. Always guard: `a.get('cover_image') or a['social_image']` for a guaranteed image URL.
|
|
302
|
-
|
|
303
|
-
- **`flare_tag` is null for most articles** — only discussion/challenge posts carry it. It's a dict `{name, bg_color_hex, text_color_hex}` when present.
|
|
304
|
-
|
|
305
|
-
- **`published_at` == `published_timestamp`** — both fields contain identical ISO 8601 UTC strings. `readable_publish_date` is human-only (`"Apr 18"`, no year).
|
|
306
|
-
|
|
307
|
-
- **`joined_at` on user profile is not ISO** — it's `"Dec 27, 2015"`. Parse: `datetime.strptime(u['joined_at'], "%b %d, %Y")`.
|
|
308
|
-
|
|
309
|
-
- **`state=all` returns 0 results unauthenticated** — it's for the authenticated user's own feed. `state=fresh` and `state=rising` work without auth.
|
|
310
|
-
|
|
311
|
-
- **`top=N` means last N days** — `top=1` is last 24h, `top=7` is last week, `top=30` is last month, `top=365` is last year. Results differ from the `state=` param.
|
|
312
|
-
|
|
313
|
-
- **V0 warning header on every response** — `Warning: 299 - This endpoint is part of the V0 (beta) API…` appears on all responses without the `Accept` header. It's harmless but noisy. Suppress with `"Accept": "application/vnd.forem.api-v1+json"`.
|
|
314
|
-
|
|
315
|
-
- **No `total_count` in list responses** — paginate until an empty array. There is no way to know upfront how many total results exist.
|
|
316
|
-
|
|
317
|
-
- **Listings endpoint returns empty** — `GET /api/listings` and all category variants return `[]` without auth. Documented but non-functional publicly.
|
|
318
|
-
|
|
319
|
-
- **`/api/articles/{id}/comments` returns 404** — comments must be fetched via `GET /api/comments?a_id={id}`, not as a sub-resource of articles.
|
|
320
|
-
|
|
321
|
-
- **`canonical_url` may point off-site** — for cross-posted articles, `canonical_url` is the author's original blog URL, not dev.to. Use `url` for the dev.to link.
|
|
322
|
-
|
|
323
|
-
- **`organization` field is null for personal posts** — only present when the article was posted under an org account. Check before accessing sub-fields.
|
|
1
|
+
# DEV Community (dev.to) — Data Extraction
|
|
2
|
+
|
|
3
|
+
`https://dev.to` — developer blogging platform. Everything useful is available via a public REST API with no auth required. No browser needed for any read task.
|
|
4
|
+
|
|
5
|
+
## Do this first
|
|
6
|
+
|
|
7
|
+
**Use the REST API — it returns clean JSON in ~150–250ms with no browser, no login, no JS rendering.**
|
|
8
|
+
|
|
9
|
+
```python
|
|
10
|
+
import json
|
|
11
|
+
articles = json.loads(http_get("https://dev.to/api/articles?per_page=10&tag=python"))
|
|
12
|
+
# Each article: id, title, description, url, cover_image, tag_list, tags,
|
|
13
|
+
# published_at, published_timestamp, readable_publish_date,
|
|
14
|
+
# reading_time_minutes, positive_reactions_count,
|
|
15
|
+
# public_reactions_count, comments_count, user, organization,
|
|
16
|
+
# flare_tag, collection_id, slug, path, canonical_url,
|
|
17
|
+
# social_image, language, subforem_id
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The API serves **V0 (beta) by default** and emits a `Warning: 299` header on every response. Suppress it silently with the V1 `Accept` header (same data, no deprecated warning):
|
|
21
|
+
|
|
22
|
+
```python
|
|
23
|
+
import json
|
|
24
|
+
import urllib.request, gzip
|
|
25
|
+
|
|
26
|
+
def dev_get(url):
|
|
27
|
+
h = {
|
|
28
|
+
"User-Agent": "Mozilla/5.0",
|
|
29
|
+
"Accept-Encoding": "gzip",
|
|
30
|
+
"Accept": "application/vnd.forem.api-v1+json",
|
|
31
|
+
}
|
|
32
|
+
with urllib.request.urlopen(urllib.request.Request(url, headers=h), timeout=20) as r:
|
|
33
|
+
data = r.read()
|
|
34
|
+
if r.headers.get("Content-Encoding") == "gzip":
|
|
35
|
+
data = gzip.decompress(data)
|
|
36
|
+
return data.decode()
|
|
37
|
+
|
|
38
|
+
articles = json.loads(dev_get("https://dev.to/api/articles?per_page=10&tag=python"))
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Or just use `http_get` directly if you don't care about the warning header noise.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Common workflows
|
|
46
|
+
|
|
47
|
+
### Articles by tag
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
import json
|
|
51
|
+
articles = json.loads(http_get("https://dev.to/api/articles?per_page=10&tag=python"))
|
|
52
|
+
# Paginate with &page=2, &page=3 etc. (1-indexed)
|
|
53
|
+
for a in articles:
|
|
54
|
+
print(a['id'], a['positive_reactions_count'], a['title'][:60])
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Confirmed working tags: `python`, `javascript`, `typescript`, `rust`, `go`, `webdev`, `tutorial`, `react`, `devops`, `ai`, `beginners`.
|
|
58
|
+
|
|
59
|
+
### Top articles by time window
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
import json
|
|
63
|
+
# top=N means "top articles from the last N days"
|
|
64
|
+
top_day = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=1"))
|
|
65
|
+
top_week = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=7"))
|
|
66
|
+
top_month = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=30"))
|
|
67
|
+
top_year = json.loads(http_get("https://dev.to/api/articles?per_page=10&top=365"))
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Articles by username
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
import json
|
|
74
|
+
articles = json.loads(http_get("https://dev.to/api/articles?per_page=10&username=ben"))
|
|
75
|
+
# Paginates cleanly: page=1, page=2 etc. Return distinct IDs, no overlap.
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### New and rising articles
|
|
79
|
+
|
|
80
|
+
```python
|
|
81
|
+
import json
|
|
82
|
+
fresh = json.loads(http_get("https://dev.to/api/articles?per_page=10&state=fresh")) # very new
|
|
83
|
+
rising = json.loads(http_get("https://dev.to/api/articles?per_page=10&state=rising")) # gaining traction
|
|
84
|
+
# state=all returns 0 results (requires auth, not useful unauthenticated)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Single article by ID (adds body_html and body_markdown)
|
|
88
|
+
|
|
89
|
+
```python
|
|
90
|
+
import json
|
|
91
|
+
article = json.loads(http_get("https://dev.to/api/articles/3442047"))
|
|
92
|
+
# Full article adds two fields not in list response:
|
|
93
|
+
# body_html — rendered HTML (safe to display directly)
|
|
94
|
+
# body_markdown — raw Markdown source
|
|
95
|
+
print(len(article['body_html']), len(article['body_markdown']))
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Single article by username/slug
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
import json
|
|
102
|
+
# path field from list response is "/username/slug"
|
|
103
|
+
article = json.loads(http_get("https://dev.to/api/articles/ben/some-article-slug"))
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Tags — popular list with colors
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
import json
|
|
110
|
+
tags = json.loads(http_get("https://dev.to/api/tags?per_page=10"))
|
|
111
|
+
# Fields: id, name, bg_color_hex, text_color_hex, short_summary
|
|
112
|
+
# Sorted by popularity. Paginate with &page=2 etc.
|
|
113
|
+
for t in tags:
|
|
114
|
+
print(t['name'], t['bg_color_hex'], t['text_color_hex'])
|
|
115
|
+
# e.g. webdev #562765 #ffffff
|
|
116
|
+
# javascript #f7df1e #000000
|
|
117
|
+
# ai #17fd1a #ffffff
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### User profile
|
|
121
|
+
|
|
122
|
+
```python
|
|
123
|
+
import json
|
|
124
|
+
user = json.loads(http_get("https://dev.to/api/users/by_username?url=ben"))
|
|
125
|
+
# Fields: type_of, id, username, name, twitter_username, github_username,
|
|
126
|
+
# summary, location, website_url, joined_at, profile_image
|
|
127
|
+
print(user['id'], user['username'], user['summary'])
|
|
128
|
+
# e.g. 1 ben "A Canadian software developer who thinks he's funny."
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
`joined_at` is a human string like `"Dec 27, 2015"` — not ISO 8601. Parse with `datetime.strptime(user['joined_at'], "%b %d, %Y")`.
|
|
132
|
+
|
|
133
|
+
### Comments on an article
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
import json
|
|
137
|
+
comments = json.loads(http_get("https://dev.to/api/comments?a_id=3442047"))
|
|
138
|
+
# Returns top-level comments only (replies nested under children key)
|
|
139
|
+
# Fields per comment: id_code (string, not int!), type_of, body_html,
|
|
140
|
+
# created_at, user (dict), children (list of same shape)
|
|
141
|
+
for c in comments:
|
|
142
|
+
print(c['id_code'], c['user']['username'], c['created_at'])
|
|
143
|
+
for reply in c.get('children', []):
|
|
144
|
+
print(" reply:", reply['id_code'], reply['user']['username'])
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Single comment by id_code
|
|
148
|
+
|
|
149
|
+
```python
|
|
150
|
+
import json
|
|
151
|
+
comment = json.loads(http_get("https://dev.to/api/comments/36lnc"))
|
|
152
|
+
# Same fields as above: id_code, body_html, created_at, user, children
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Bulk tag fetch (parallel)
|
|
156
|
+
|
|
157
|
+
```python
|
|
158
|
+
import json
|
|
159
|
+
from concurrent.futures import ThreadPoolExecutor
|
|
160
|
+
|
|
161
|
+
tags = ['python', 'javascript', 'typescript', 'rust', 'go',
|
|
162
|
+
'devops', 'webdev', 'tutorial', 'productivity', 'react']
|
|
163
|
+
|
|
164
|
+
def fetch_tag(tag):
|
|
165
|
+
data = json.loads(http_get(f"https://dev.to/api/articles?per_page=5&tag={tag}"))
|
|
166
|
+
return tag, data
|
|
167
|
+
|
|
168
|
+
with ThreadPoolExecutor(max_workers=3) as ex:
|
|
169
|
+
results = dict(ex.map(lambda t: fetch_tag(t), tags))
|
|
170
|
+
# 10 tags × 5 articles each: ~0.67s total with max_workers=3
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
## Endpoint reference
|
|
176
|
+
|
|
177
|
+
| Endpoint | Auth | Key params | Latency |
|
|
178
|
+
|----------|------|-----------|---------|
|
|
179
|
+
| `GET /api/articles` | None | `tag`, `username`, `top`, `state`, `page`, `per_page` | ~200ms |
|
|
180
|
+
| `GET /api/articles/{id}` | None | — | ~80ms |
|
|
181
|
+
| `GET /api/articles/{username}/{slug}` | None | — | ~200ms |
|
|
182
|
+
| `GET /api/tags` | None | `page`, `per_page` | ~190ms |
|
|
183
|
+
| `GET /api/users/by_username?url={username}` | None | — | ~190ms |
|
|
184
|
+
| `GET /api/comments?a_id={article_id}` | None | — | ~160ms |
|
|
185
|
+
| `GET /api/comments/{id_code}` | None | — | ~150ms |
|
|
186
|
+
| `GET /api/listings` | None | `category`, `page`, `per_page` | ~260ms (returns 0) |
|
|
187
|
+
|
|
188
|
+
**Listings endpoint returns 0 results.** The `/api/listings` endpoint is documented but returns an empty array for all categories (`jobs`, `forsale`, `education`, `cfp`) without auth. Skip it.
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## Pagination
|
|
193
|
+
|
|
194
|
+
All list endpoints paginate with `page=` (1-indexed) and `per_page=`:
|
|
195
|
+
|
|
196
|
+
```python
|
|
197
|
+
import json
|
|
198
|
+
|
|
199
|
+
def get_all_articles_by_tag(tag, max_pages=5):
|
|
200
|
+
results = []
|
|
201
|
+
for page in range(1, max_pages + 1):
|
|
202
|
+
batch = json.loads(http_get(
|
|
203
|
+
f"https://dev.to/api/articles?per_page=30&tag={tag}&page={page}"
|
|
204
|
+
))
|
|
205
|
+
if not batch:
|
|
206
|
+
break
|
|
207
|
+
results.extend(batch)
|
|
208
|
+
return results
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
- `per_page` supports up to **1000** (confirmed). No documented max, but 1000 works in testing.
|
|
212
|
+
- No `total_count` field in list responses — you paginate until an empty array.
|
|
213
|
+
- Page ordering is consistent — confirmed no ID overlap between page 1 and page 2.
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Article field reference
|
|
218
|
+
|
|
219
|
+
All fields returned in list responses (single article adds `body_html` and `body_markdown`):
|
|
220
|
+
|
|
221
|
+
```
|
|
222
|
+
id int — article ID, stable, use for single-article fetch
|
|
223
|
+
title str
|
|
224
|
+
description str — auto-excerpt, never null
|
|
225
|
+
slug str — URL slug component
|
|
226
|
+
path str — "/username/slug"
|
|
227
|
+
url str — full canonical URL
|
|
228
|
+
canonical_url str — same as url for native posts; author's site URL for cross-posts
|
|
229
|
+
cover_image str|null — CDN URL or null (~30% of articles have no cover image)
|
|
230
|
+
social_image str — always present (generated if no cover_image)
|
|
231
|
+
tag_list list — e.g. ['python', 'ai', 'tutorial'] ← use this for code
|
|
232
|
+
tags str — same tags as comma-separated string "python, ai, tutorial"
|
|
233
|
+
published_at str — ISO 8601 UTC e.g. "2026-04-18T03:49:36Z"
|
|
234
|
+
published_timestamp str — identical to published_at
|
|
235
|
+
readable_publish_date str — human string e.g. "Apr 18"
|
|
236
|
+
reading_time_minutes int
|
|
237
|
+
positive_reactions_count int — hearts/likes count
|
|
238
|
+
public_reactions_count int — total reactions (usually same as positive_reactions_count)
|
|
239
|
+
comments_count int
|
|
240
|
+
user dict — name, username, twitter_username, github_username,
|
|
241
|
+
user_id, website_url, profile_image, profile_image_90
|
|
242
|
+
organization dict|null — present when posted under an org: name, username, slug,
|
|
243
|
+
profile_image, profile_image_90
|
|
244
|
+
flare_tag dict|null — {name, bg_color_hex, text_color_hex} — discussion/challenge badge
|
|
245
|
+
collection_id int|null — series/collection ID if part of a series
|
|
246
|
+
language str — e.g. "en"
|
|
247
|
+
subforem_id int|null
|
|
248
|
+
crossposted_at str|null — ISO datetime if cross-posted
|
|
249
|
+
edited_at str|null
|
|
250
|
+
last_comment_at str|null
|
|
251
|
+
created_at str — ISO 8601
|
|
252
|
+
type_of str — always "article"
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## Rate limits
|
|
258
|
+
|
|
259
|
+
- **Burst limit: ~6 rapid sequential requests**, then HTTP 429.
|
|
260
|
+
- **Recovery: `Retry-After: 1` second** — wait 1s after a 429 and you're good again.
|
|
261
|
+
- No `X-RateLimit-*` headers in 200 responses — you only see `Retry-After` on the 429 itself.
|
|
262
|
+
- With `ThreadPoolExecutor(max_workers=3)`, 10 concurrent requests succeed without hitting the limit.
|
|
263
|
+
- No difference in limits between V0 (default) and V1 (`Accept` header) — same underlying rate limit.
|
|
264
|
+
- **No auth token tested** — all endpoints above work without `api_key`. Authenticated requests likely have higher limits.
|
|
265
|
+
|
|
266
|
+
Safe pattern for bulk fetching:
|
|
267
|
+
|
|
268
|
+
```python
|
|
269
|
+
import json, time
|
|
270
|
+
from concurrent.futures import ThreadPoolExecutor
|
|
271
|
+
|
|
272
|
+
def safe_fetch(url):
|
|
273
|
+
for attempt in range(3):
|
|
274
|
+
try:
|
|
275
|
+
return json.loads(http_get(url))
|
|
276
|
+
except Exception as e:
|
|
277
|
+
if '429' in str(e):
|
|
278
|
+
time.sleep(1) # Retry-After is 1s
|
|
279
|
+
continue
|
|
280
|
+
raise
|
|
281
|
+
return []
|
|
282
|
+
|
|
283
|
+
urls = [
|
|
284
|
+
f"https://dev.to/api/articles?per_page=10&tag={tag}"
|
|
285
|
+
for tag in ['python', 'javascript', 'typescript', 'rust']
|
|
286
|
+
]
|
|
287
|
+
with ThreadPoolExecutor(max_workers=3) as ex:
|
|
288
|
+
results = list(ex.map(safe_fetch, urls))
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## Gotchas
|
|
294
|
+
|
|
295
|
+
- **`tag_list` (list) vs `tags` (string)** — both fields always present. `tag_list` is a Python list; `tags` is the same data as a comma-separated string. Use `tag_list` in code.
|
|
296
|
+
|
|
297
|
+
- **Comments have `id_code`, not `id`** — comment identifiers are alphanumeric strings like `"36lnc"`, not integers. The integer `id` field is absent from comment objects. Use `id_code` to fetch a specific comment via `GET /api/comments/{id_code}`.
|
|
298
|
+
|
|
299
|
+
- **Comments endpoint returns top-level only** — replies are nested under `children` recursively, not returned as a flat list. A thread with 100 total comments may only show 60 top-level objects; walk `children` recursively to count all.
|
|
300
|
+
|
|
301
|
+
- **`cover_image` can be null** — ~30% of articles have no cover image. Always guard: `a.get('cover_image') or a['social_image']` for a guaranteed image URL.
|
|
302
|
+
|
|
303
|
+
- **`flare_tag` is null for most articles** — only discussion/challenge posts carry it. It's a dict `{name, bg_color_hex, text_color_hex}` when present.
|
|
304
|
+
|
|
305
|
+
- **`published_at` == `published_timestamp`** — both fields contain identical ISO 8601 UTC strings. `readable_publish_date` is human-only (`"Apr 18"`, no year).
|
|
306
|
+
|
|
307
|
+
- **`joined_at` on user profile is not ISO** — it's `"Dec 27, 2015"`. Parse: `datetime.strptime(u['joined_at'], "%b %d, %Y")`.
|
|
308
|
+
|
|
309
|
+
- **`state=all` returns 0 results unauthenticated** — it's for the authenticated user's own feed. `state=fresh` and `state=rising` work without auth.
|
|
310
|
+
|
|
311
|
+
- **`top=N` means last N days** — `top=1` is last 24h, `top=7` is last week, `top=30` is last month, `top=365` is last year. Results differ from the `state=` param.
|
|
312
|
+
|
|
313
|
+
- **V0 warning header on every response** — `Warning: 299 - This endpoint is part of the V0 (beta) API…` appears on all responses without the `Accept` header. It's harmless but noisy. Suppress with `"Accept": "application/vnd.forem.api-v1+json"`.
|
|
314
|
+
|
|
315
|
+
- **No `total_count` in list responses** — paginate until an empty array. There is no way to know upfront how many total results exist.
|
|
316
|
+
|
|
317
|
+
- **Listings endpoint returns empty** — `GET /api/listings` and all category variants return `[]` without auth. Documented but non-functional publicly.
|
|
318
|
+
|
|
319
|
+
- **`/api/articles/{id}/comments` returns 404** — comments must be fetched via `GET /api/comments?a_id={id}`, not as a sub-resource of articles.
|
|
320
|
+
|
|
321
|
+
- **`canonical_url` may point off-site** — for cross-posted articles, `canonical_url` is the author's original blog URL, not dev.to. Use `url` for the dev.to link.
|
|
322
|
+
|
|
323
|
+
- **`organization` field is null for personal posts** — only present when the article was posted under an org account. Check before accessing sub-fields.
|