roadmap APIroadmap.sh ↗
Access roadmap.sh learning roadmaps, topic trees, guides, interview questions, and project specs via API. 14 endpoints returning structured JSON.
What is the roadmap API?
The roadmap.sh API provides 14 endpoints for accessing the full catalog of developer learning roadmaps, guides, interview question sets, and community project ideas from roadmap.sh. The get_roadmap_topics endpoint returns a hierarchical topic tree with node IDs, label paths, and associated guides, while get_topic_detail returns markdown descriptions and typed learning resources (articles, videos, courses) for any individual node. All catalog endpoints return the complete dataset in a single response with no pagination.
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, group, metadata tags, and last updated date. The full catalog is returned in a single response with no pagination.
No input parameters required.
{
"type": "object",
"fields": {
"roadmaps": "array of roadmap summary objects"
},
"sample": {
"data": {
"roadmaps": [
{
"id": "frontend",
"url": "/frontend",
"group": "Roadmaps",
"title": "Frontend Developer",
"metadata": {
"tags": [
"role-roadmap"
]
},
"renderer": "editor",
"updatedAt": "2026-06-08T07:39:29.714Z",
"shortTitle": "Frontend",
"description": "Step by step guide to becoming a modern frontend developer in @currentYear@"
}
]
},
"status": "success"
}
}About the roadmap API
Roadmaps and Topic Trees
list_roadmaps returns the full catalog of available roadmaps as an array of summary objects — each with an id, title, description, group, metadata tags, and updatedAt date. Passing a slug to get_roadmap_detail returns the complete node graph: an edges array connecting node pairs and a nodes array where each node carries positional and type metadata. This raw graph reflects the visual flowchart structure. For a normalized, hierarchical view, get_clean_roadmap_nodes processes the same source into a tree with inferred parent-child relationships, semantic type fields, and attached resources per node. get_drawio_roadmap_nodes produces the same graph as Draw.io-compatible flat cells with semantic metadata tags on each node.
Topic Detail and Resource Links
get_roadmap_topics returns all topic nodes for a roadmap as an array, each including nodeId, a hierarchical text label (e.g., Frontend > Internet > How does the internet work?), subjects, guides, and an isOptional flag. Those nodeId values feed directly into get_topic_detail, which requires node_id, topic_slug, and roadmap_slug and returns a markdown description plus a resources array — each resource carries type (article, video, course), title, and url.
Guides, Questions, and Projects
list_guides and list_questions each return a flat array of summary objects with id, title, description, and updatedAt. Fetching get_guide_content or get_question_content by slug delivers full rich-text content in TipTap JSON format alongside author info and related items. list_projects returns project summaries, and get_project_detail adds content (rich text), difficulty, skills, topics, and roadmapIds linking each project back to relevant roadmaps.
Search and Relations
search_roadmaps accepts a query string and returns matching items across roadmaps, guides, questions, and projects — each result includes id, url, title, description, group, and updatedAt. get_roadmap_relations accepts an array of slugs and returns, for each, referencedRoadmaps (directly linked in the graph), relatedRoadmaps (sorted by shared topic count), associated projects, guides, and questions.
The roadmap API is a managed, monitored endpoint for roadmap.sh — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when roadmap.sh changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official roadmap.sh API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build a custom learning tracker that maps a user's progress against a specific roadmap's topic tree from
get_roadmap_topics - Populate a study resource database with curated article, video, and course links from
get_topic_detailresources arrays - Generate Draw.io diagrams of technology learning paths using
get_drawio_roadmap_nodescell output - Surface related roadmaps and shared topic overlaps for curriculum recommendation using
get_roadmap_relations - Index all interview question sets from
list_questionsandget_question_contentfor a technical interview prep tool - Catalog community project ideas with difficulty and skill tags from
get_project_detailfor a project-matching app - Search across the full roadmap.sh content catalog by keyword using
search_roadmapsto build a unified learning search interface
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 200 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
| Team | $300/mo | 20,000 | 300 req/min |
| Company | $1,000/mo | 100,000 | 500 req/min |
Each endpoint has a fixed posted price per successful call — most fall between 1 and 10 credits — shown on this API's page before you run it. 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_clean_roadmap_nodes` return that `get_roadmap_detail` doesn't?+
get_roadmap_detail returns the raw node and edge arrays as they exist in the graph definition, without hierarchy. get_clean_roadmap_nodes processes the same data into a tree structure with inferred parent-child children arrays, normalized type fields, attached resources per node, and a totalNodes count — making it easier to traverse programmatically without reconstructing the graph yourself.Can I retrieve user profile data, community submissions, or roadmap completion statistics?+
Do the catalog endpoints (`list_roadmaps`, `list_guides`, `list_questions`, `list_projects`) support filtering or pagination?+
search_roadmaps accepts a query parameter and handles cross-catalog matching server-side.Is rich text content from guides and question sets accessible as plain text or HTML?+
content field in get_guide_content and get_question_content is returned as TipTap JSON (a structured document format), not as pre-rendered HTML or plain text. You will need a TipTap-compatible renderer or a custom serializer to convert it to HTML or plain text. If you need a different output format, you can fork the API on Parse and revise it to add a serialization step.