roadmap.sh APIroadmap.sh ↗
Access roadmap.sh learning roadmaps, guides, interview questions, and projects via API. Get topic trees, node details, and structured learning content.
No input parameters required.
curl -X GET 'https://api.parse.bot/scraper/e532bb5b-2c0c-4c43-a138-11bf4ab04ad5/list_roadmaps' \ -H 'X-API-Key: $PARSE_API_KEY'
List all available roadmaps. Returns an array of roadmap summaries including id, title, description, and last updated date.
No input parameters required.
{
"type": "object",
"fields": {
"roadmaps": "array of roadmap summary objects with id, url, title, description, group, metadata, and updatedAt"
},
"sample": {
"data": {
"roadmaps": [
{
"id": "sql",
"url": "/sql",
"group": "Roadmaps",
"title": "SQL",
"metadata": {
"tags": [
"skill-roadmap"
]
},
"renderer": "editor",
"updatedAt": "2026-02-26T08:46:21.599Z",
"shortTitle": "SQL",
"description": "Step by step guide to learning SQL in @currentYear@"
}
]
},
"status": "success"
}
}About the roadmap.sh API
The roadmap.sh API exposes 11 endpoints covering learning roadmaps, guides, interview question sets, and community projects from roadmap.sh. The get_roadmap_detail endpoint returns the full node graph — including edges, nodes, titles, and descriptions — for any roadmap slug like frontend or backend. Other endpoints surface hierarchical topic trees, per-topic markdown content with linked resources, and searchable indexes across all content types.
Roadmaps and Topic Trees
The list_roadmaps endpoint returns every available roadmap as a summary object with id, url, title, description, group, metadata, and updatedAt. From there, get_roadmap_detail accepts a slug parameter (e.g., react, sql, devops) and returns the full graph structure: an array of nodes defining each step in the path and an array of edges describing how nodes connect. get_roadmap_topics goes further, returning a hierarchical topic tree for a given roadmap slug, with each node carrying a nodeId, text label, subjects, guides, and an isOptional flag that distinguishes required from supplementary topics.
Topic Detail and Learning Resources
get_topic_detail takes three parameters — node_id, topic_slug, and roadmap_slug — and returns a description field containing full markdown prose for that topic plus a resources array. Each resource object includes a type, title, and url, covering things like articles, videos, and official docs associated with that node. This makes it straightforward to build per-topic resource lists without assembling them manually.
Guides, Interview Questions, and Projects
list_guides and get_guide_content cover the guide catalog. The detail endpoint returns rich-text content, author info, and a related guides list under the routes/guides.$guideSlug key. Similarly, list_questions and get_question_content expose interview question sets by technology slug (e.g., javascript, python), returning structured rich-text content and author attribution. list_projects and get_project_detail cover community project ideas, with the detail endpoint exposing difficulty, skills, topics, roadmapIds, and rich-text content.
Search
search_roadmaps accepts a query string and matches it against titles and descriptions across all content types — roadmaps, guides, questions, and projects — returning a unified results array with id, url, title, description, group, and updatedAt per match. This is useful for discovery workflows where the target slug isn't known in advance.
- Build a learning path browser that renders the node graph from
get_roadmap_detailas an interactive skill tree - Generate per-topic reading lists by pulling
resourcesarrays fromget_topic_detailfor every node in a roadmap - Create a curriculum tool that marks optional versus required topics using the
isOptionalfield fromget_roadmap_topics - Index all interview question sets from
list_questionsto power a searchable interview prep tool - Surface project ideas by difficulty using
get_project_detailfields likedifficulty,skills, andtopics - Build a search interface over roadmap.sh content using
search_roadmapswith keyword queries - Track content freshness by comparing
updatedAttimestamps across roadmaps, guides, and projects
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does roadmap.sh have an official developer API?+
What does `get_roadmap_topics` return compared to `get_roadmap_detail`?+
get_roadmap_detail returns the raw graph structure — node and edge arrays suitable for rendering the visual roadmap. get_roadmap_topics returns a processed hierarchical topic tree with nodeId, human-readable text, associated guides, subjects, and an isOptional flag. Use the latter when you need a labeled, navigable tree rather than raw graph data.Does the API return user progress, completion status, or community-contributed roadmap data?+
Can I retrieve resources for every topic in a roadmap in a single call?+
get_topic_detail requires individual calls per topic using node_id, topic_slug, and roadmap_slug. You can retrieve the full topic list from get_roadmap_topics first, then iterate. You can fork this API on Parse and revise it to add a bulk topic-content endpoint if that workflow matters for your use case.What content types does `search_roadmaps` cover, and can results be filtered by type?+
search_roadmaps matches across all four content types — roadmaps, guides, questions, and projects — and each result includes a group field that indicates which type the result belongs to. The endpoint does not accept a type filter parameter directly. You can fork this API on Parse and revise it to add type-filtering logic on top of the group field in responses.