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&context=broad

import requests

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&context=broad"

response = requests.request("GET", url)

print(response.text)

const response = await fetch('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&context=broad', {
  method: 'GET'
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_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&context=broad',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	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&context=broad"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("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&context=broad"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('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&context=broad')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Response

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

<string>

{
  "error": "validation_error",
  "message": "Library name is required"
}

{
  "error": "invalid_library_id",
  "message": "Invalid library ID format. Expected: `/owner/repo` for GitHub repositories, or `/<source>/<id>` for other sources (the URL path of the library on context7.com)"
}

{
  "error": "invalid_api_key",
  "message": "Invalid API key. Please check your API key. API keys should start with 'ctx7sk' prefix."
}

{
  "error": "spending_limit_exceeded",
  "message": "Monthly spending limit of $5.00 reached for this teamspace. An owner or admin can raise the limit at https://context7.com/dashboard/billing, or the cap will reset at the start of next month."
}

{
  "error": "no_documentation_found",
  "message": "No documentation library matched the request. Check the library hint or name."
}

{
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Please try again later."
}

{
  "error": "search_failed",
  "message": "The documentation search could not be completed."
}

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, including when the ID is searched by its product name.

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, the newest stable release of the requested line when it is newer than the request (v2.3.1 for 2.0.0; below 1.0, the same minor) or else 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). A prerelease tag serves only a request for that prerelease. 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

contextenum<string>#

Optional. broad appends more sections of the best-matching documentation pages, up to about 3,500 extra tokens, after the ranked results. How-to, migration, troubleshooting, and overview questions get these sections without it; use it when a question needs several facts but reads as a single-fact question.

Options:broad

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

rankintegerrequired#

1-based position in the text response, shared by codeSnippets and infoSnippets. Sort both lists together by rank to read the snippets in the order the text response gives them (the selection model's relevance order when it ranked them).

Range: >= 1

infoSnippetsobject[]required#

Relevant documentation snippets

Show child attributes

pageIdstring#

URL to source page

contentstringrequired#

The documentation content

contentTokensintegerrequired#

Token count for the content

rankintegerrequired#

Range: >= 1

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 only when the library ID names a version that is not indexed. Says what was served instead, with the fields of each entry of the Search API's version.libraries. The text response states the same in a leading version note when the status is unverified.

Show child attributes

libraryIdstringrequired#

The library id served, including the served tag when one was matched.

requestedstringrequired#

The version named by the library ID.

servedstringrequired#

The indexed tag served: the matching tag or, when unverified, the newest stable release of the requested line that is newer than the request. Null when current documentation was served instead.

statusenum<string>required#

verified when the served tag matches the requested version (15 served by v15.1.11); unverified when another release or current documentation was served.

Options:verifiedunverified

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: the matching tag or, when unverified, the newest stable release of the requested line that is newer than the request. The requested version when the source id pins it. Null when current documentation was served instead.

statusenum<string>required#

Options:verifiedunverified

Search for libraries Read one web page, optionally narrowed to a question