---
title: "Search extensions via text entered by a user"
method: GET
path: "/api/-/search"
tags: ["registry-api"]
---

# Search extensions via text entered by a user

`GET /api/-/search`

## Query parameters

- `query` string
- `category` string
- `targetPlatform` 'win32-x64' | 'win32-ia32' | 'win32-arm64' | 'linux-x64' | 'linux-arm64' | 'linux-armhf' | 'alpine-x64' | 'alpine-arm64' | 'darwin-x64' | 'darwin-arm64' | 'web' | 'universal'
- `size` integer
- `offset` integer
- `sortOrder` 'asc' | 'desc'
- `sortBy` 'relevance' | 'timestamp' | 'rating' | 'downloadCount'
- `includeAllVersions` boolean

## Response `200`

The search results are returned in JSON format

- SearchResult — List of extensions matching a search query
  - `success` string — Indicates success of the operation (omitted if a more specific result type is returned)
  - `warning` string — Indicates a warning; when this is present, other properties can still be used
  - `error` string — Indicates an error; when this is present, all other properties should be ignored
  - `offset` integer, required — Number of skipped entries according to the search query
  - `totalSize` integer, required — Total number of entries that match the search query
  - `extensions` SearchEntry[], required — List of matching entries, limited to the size specified in the search query
    - `url` string, required — URL to get the full metadata of the extension
    - `files` object, required — Map of file types (download, manifest, icon, readme, license, changelog) to their respective URLs
    - `name` string, required — Name of the extension
    - `namespace` string, required — Namespace of the extension
    - `version` string, required — The latest published version
    - `timestamp` string, required — Date and time when this version was published (ISO-8601)
    - `verified` boolean, required — The value 'true' means the publishing user is a privileged user or the publishing user is a member of the extension's namespace and the namespace has at least one owner.
    - `allVersions` VersionReference[] — Essential metadata of all available versions. Deprecated: only returns the last 100 versions. Use allVersionsUrl instead.
      - `url` string — URL to get the full metadata of this version
      - `files` object — Map of file types (download, manifest, icon, readme, license, changelog) to their respective URLs
      - `version` string
      - `targetPlatform` 'win32-x64' | 'win32-ia32' | 'win32-arm64' | 'linux-x64' | 'linux-arm64' | 'linux-armhf' | 'alpine-x64' | 'alpine-arm64' | 'darwin-x64' | 'darwin-arm64' | 'web' | 'universal' — Name of the target platform
      - `engines` object — Map of engine names to the respective version constraints
    - `allVersionsUrl` string — URL to get essential metadata of all available versions.
    - `averageRating` number, double — Average rating
    - `reviewCount` integer — Number of reviews
    - `downloadCount` integer — Number of downloads of the extension package
    - `displayName` string — Name to be displayed in user interfaces
    - `description` string
    - `deprecated` boolean — Indicates whether the extension is deprecated

## Other responses

- `400` — The request contains an invalid parameter value
- `429` — A client has sent too many requests in a given amount of time

---

[API](https://skmtc.net/livesession/apis/open-vsx-registry-api.md) · [All operations](https://skmtc.net/livesession/apis/open-vsx-registry-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/livesession/open-vsx-registry-api/versions/badd706d3136/schema)