Search documentation in one request

get/v3/search

Request example

curl --request GET \
  --url https://context7.com/api/v3/search?query=How%20do%20I%20write%20optimistic%20updates%20with%20TanStack%20Query%20v5%3F&type=json&library=next.js&library=react&version=15.2&language=TypeScript

Response

{
  "codeSnippets": [
    {
      "codeTitle": "<string>",
      "codeDescription": "<string>",
      "codeLanguage": "<string>",
      "codeTokens": 1,
      "codeId": "<string>",
      "pageTitle": "<string>",
      "codeList": [
        {
          "language": "<string>",
          "code": "<string>"
        }
      ],
      "isDynamic": true,
      "sourceFile": "<string>"
    }
  ],
  "infoSnippets": [
    {
      "pageId": "<string>",
      "breadcrumb": "<string>",
      "content": "<string>",
      "contentTokens": 1
    }
  ],
  "rules": {
    "global": [
      "<string>"
    ],
    "libraryOwn": [
      "<string>"
    ],
    "libraryTeam": [
      "<string>"
    ],
    "libraries": [
      {
        "libraryId": "<string>",
        "libraryOwn": [
          "<string>"
        ],
        "libraryTeam": [
          "<string>"
        ]
      }
    ]
  },
  "version": {
    "requested": "15",
    "status": "verified",
    "libraries": [
      {
        "libraryId": "/vercel/next.js/v15.1.11",
        "requested": "15",
        "served": "v15.1.11",
        "status": "verified"
      }
    ]
  }
}

get/v3/search

Query parameters

querystringrequired#

The question or task to search documentation for. Long questions and pasted error output are accepted.

Length: 1–2000

typeenum<string>#

Response format type

Default: "txt"

Options:jsontxt

librarystring[]#

Optional library hints. Repeat for up to four values; each may be a fuzzy product name such as next.js or an exact Context7 ID such as /vercel/next.js. An exact ID that is not indexed, or has no documentation to serve, is searched by its product name instead. A version-like tag (/vercel/next.js@15) is resolved like the version parameter for that library.

Items: max 4

versionstring#

Optional version preference. latest (any case) is the same as no version. Without a library value, the version applies when the question names one product; when it names several, the version is ignored. With one library, verified matching documentation is preferred; if unavailable, current documentation is returned and the response says so (X-Context7-Search-Status: partial with reason versionUnverified, X-Context7-Search-Version, and the version field of JSON responses). When only a prerelease tag matches a stable request, the reason is versionPrerelease. With multiple libraries, the version is a preference and each returned library reports what it served. A version-like tag on a library value (/vercel/next.js@15) is the same request scoped to that library. A version that is not indexed for a public GitHub library is queued for indexing in the background, so a later request for it can be answered.

Pattern: ^([Ll][Aa][Tt][Ee][Ss][Tt]|[Vv]?[0-9]+([._][0-9]+){0,2}([-+][a-zA-Z0-9.-]+)?)$

languagestring#

Optional programming-language preference used for library selection, retrieval, and reranking. This is a soft preference and does not exclude language-neutral documentation.

Length: 1–40

Responses

Bounded documentation evidence from the selected libraries

codeSnippetsobject[]required#

Relevant code snippets

Show child attributes

codeTitlestringrequired#

Title of the code snippet

codeDescriptionstringrequired#

Description of what the code does

codeLanguagestringrequired#

Primary programming language

codeTokensintegerrequired#

Token count for the snippet

codeIdstringrequired#

URL to source location

pageTitlestringrequired#

Title of the documentation page

codeListobject[]required#

Code examples in different languages

Show child attributes

languagestringrequired#

Programming language

codestringrequired#

The actual code content

isDynamicboolean#

Whether this snippet was recovered from the dynamic source-code index instead of the primary docs index

sourceFilestring#

Repo-relative source file path for dynamic snippets

infoSnippetsobject[]required#

Relevant documentation snippets

Show child attributes

pageIdstring#

URL to source page

contentstringrequired#

The documentation content

contentTokensintegerrequired#

Token count for the content

rulesobject#

Optional library-specific rules and guidelines

Show child attributes

globalstring[]#

Global team rules

libraryOwnstring[]#

Rules defined by the library owner

libraryTeamstring[]#

Library-specific rules from the team

librariesobject[]#

Rules scoped to a specific returned library

Show child attributes

libraryIdstringrequired#

libraryOwnstring[]required#

libraryTeamstring[]required#

versionobject#

Present when a version was requested by the version parameter or a version-like library tag. Says what each returned library served.

Show child attributes

requestedstring#

The version parameter, when given.

statusenum<string>required#

Worst outcome across the returned libraries.

Options:verifiedprereleaseunverified

librariesobject[]required#

Show child attributes

libraryIdstringrequired#

The library id as it appears on the returned snippets, including the served tag when one was matched.

requestedstringrequired#

The version requested for this library.

servedstringrequired#

The indexed tag served, or the requested version when the source id pins it. Null when current documentation was served instead.

statusenum<string>required#

Options:verifiedprereleaseunverified

Search for libraries Get library usage metrics