Nuxt APInuxt.com ↗
Query Nuxt documentation to access detailed information about components, composables, utilities, and commands directly in your application. Retrieve structured reference content from specific documentation pages to integrate Nuxt knowledge into your development workflow.
curl -X GET 'https://api.parse.bot/scraper/9da5b97b-5ab4-4940-8c7d-3e9eeb410053/list_api_reference?category=components' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace nuxt-com-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: Nuxt Documentation API — browse API reference entries and read page content."""
from parse_apis.nuxt_com_api import NuxtDocs, Category, PathFormatInvalid
client = NuxtDocs()
# List composable entries (capped to 5 total items).
for entry in client.page_summaries.list(category=Category.COMPOSABLES, limit=5):
print(entry.title, entry.path)
# Drill into the first component page via summary -> detail navigation.
component = client.page_summaries.list(category=Category.COMPONENTS, limit=1).first()
if component is not None:
page = component.details()
print(page.title, "-", page.description)
for section in page.sections:
print(f" [{section.level}] {section.title}: {section.content[:80]}")
# Direct page lookup using path discovered from the listing above.
if component is not None:
try:
full = client.pages.get(path=component.path)
print(f"{full.title} ({full.content_length} chars)")
except PathFormatInvalid as e:
print("Invalid path:", e.message)
print("exercised: page_summaries.list / details / pages.get")
Lists all Nuxt API reference documentation entries (components, composables, utils, commands, kit, advanced), optionally filtered by category. Returns the title and path for each entry. One request to the Nuxt docs index page.
| Param | Type | Description |
|---|---|---|
| category | string | Filter results to a specific API category. When omitted, returns all entries across all categories. |
{
"type": "object",
"fields": {
"items": "array of API reference entries with title and path",
"total": "integer count of items returned",
"filter": "the applied category filter or null",
"categories": "array of available category strings"
},
"sample": {
"data": {
"items": [
{
"path": "/docs/4.x/api/composables/create-use-async-data",
"title": "createUseAsyncData"
},
{
"path": "/docs/4.x/api/composables/create-use-fetch",
"title": "createUseFetch"
},
{
"path": "/docs/4.x/api/composables/on-prehydrate",
"title": "onPrehydrate"
}
],
"total": 33,
"filter": "composables",
"categories": [
"components",
"composables",
"utils",
"commands",
"kit",
"advanced"
]
},
"status": "success"
}
}About the Nuxt API
The Nuxt API on Parse exposes 2 endpoints for the publicly available data on nuxt.com. Calls return JSON over HTTPS and are billed per successful response.
Pin a release with the API-Snapshot-Version header so canonical updates don't silently change your contract.