Discover/Nuxt API
live

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.

This API takes change requests — .
Endpoint health
verified 2h ago
list_api_reference
get_doc_page
2/2 passing latest checkself-healing
Endpoints
2
Updated
2h ago
This call costs1 credit / call— charged only on success
Try it
Filter results to a specific API category. When omitted, returns all entries across all categories.
api.parse.bot/scraper/9da5b97b-5ab4-4940-8c7d-3e9eeb410053/<endpoint>
Ready to send
Fill in the parameters and hit sign in to send to see live response data here.
Call it over HTTPgrab a free API key at signup
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'
Python SDK · recommended

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")
All endpoints · 2 totalmissing one? ·

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.

Input
ParamTypeDescription
categorystringFilter results to a specific API category. When omitted, returns all entries across all categories.
Response
{
  "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.

Related APIs
developers.notion.com API
Search and browse Notion's developer documentation to find specific pages and retrieve their full content in markdown format. Access comprehensive information about Notion's capabilities by listing available pages or looking up individual documentation entries.
Docs.copia.io API
Search and browse the complete Copia Automation documentation, discover available pages, and retrieve full text content from any page on docs.copia.io. Quickly find answers by searching documentation content or accessing specific guides and references.
halt.afroawi.com API
Browse comprehensive documentation for the halt-rate rate-limiting package and retrieve detailed content from any specific page you need. Quickly find information about all available documentation topics and access complete page details in a single request.
quickref.me API
Search and retrieve quick reference guides for hundreds of developer tools, languages, and frameworks from quickref.me. Browse all available cheatsheets, search by keyword, or fetch full content for any topic to instantly access the commands, syntax, and usage notes you need.
git-scm.com API
Access comprehensive Git documentation, browse command references across different versions, and explore chapters from the Pro Git book. Search Git documentation and glossary terms to quickly find answers about Git commands and concepts.
docs.livecode.com API
Access comprehensive LiveCode Script documentation to look up commands, functions, control structures, and language reference entries. Quickly find detailed information about any LiveCode language feature you need while coding.
help.perforce.com API
Access detailed documentation and reference materials for Perforce Helix Core commands, including command syntax, client configuration options, form fields, and system configurables. Search through the complete P4 command reference to find specific commands, view their parameters, and understand client submission and line ending options.
reactbits.dev API
Browse and search React component libraries from React Bits, then instantly retrieve component source code, installation commands, and prop definitions. Get organized access to all available components and their categories to speed up your development workflow.