---
title: "Provides metadata of extensions matching the given parameters"
method: GET
path: "/api/-/query"
tags: ["registry-api"]
---

# Provides metadata of extensions matching the given parameters

`GET /api/-/query`

## Query parameters

- `namespaceName` string
- `extensionName` string
- `extensionVersion` string
- `extensionId` string
- `extensionUuid` string
- `namespaceUuid` string
- `includeAllVersions` boolean
- `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

## Response `200`

Returns the (possibly empty) query results

- QueryResult — Metadata query result
  - `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 query
  - `totalSize` integer, required — Total number of entries that match the query
  - `extensions` Extension[] — Extensions that match the given query (may be empty)
    - `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
    - `namespaceUrl` string, required — URL to get metadata of the extension's namespace
    - `reviewsUrl` string, required — URL to get the list of reviews of this extension
    - `files` object — 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
    - `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
    - `version` string, required — Selected version, or the latest version if none was specified
    - `preRelease` boolean — Indicates whether this is a pre-release version
    - `publishedBy` User, required — User data
      - `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
      - `loginName` string, required — Login name
      - `fullName` string — Full name
      - `avatarUrl` string — URL to the user's avatar image
      - `homepage` string — URL to the user's profile page
      - `provider` string — Authentication provider (e.g. github)
    - `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.
    - `unrelatedPublisher` boolean, required — Deprecated: use 'verified' instead (this property is just the negation of 'verified')
    - `namespaceAccess` 'public' | 'restricted', required — Access level of the extension's namespace. Deprecated: namespaces are now always restricted
    - `allVersions` object — Map of available versions to their metadata URLs. Deprecated: only returns the last 100 versions. Use allVersionsUrl instead.
    - `allVersionsUrl` string — URL to get a map of available versions to their metadata URLs.
    - `averageRating` number, double — Average rating
    - `downloadCount` integer — Number of downloads of the extension package
    - `reviewCount` integer — Number of reviews
    - `versionAlias` string[] — Available version aliases ('latest' or 'pre-release')
    - `timestamp` string, required — Date and time when this version was published (ISO-8601)
    - `preview` boolean — Indicates whether this is a preview extension
    - `displayName` string — Name to be displayed in user interfaces
    - `namespaceDisplayName` string, required — Namespace name to be displayed in user interfaces
    - `description` string
    - `engines` object — Map of engine names to the respective version constraints
    - `categories` string[]
    - `extensionKind` string[] — A list that indicates where the extension should run in remote configurations. Values are "ui" (run locally), "workspace" (run on remote machine) and "web"
    - `tags` string[]
    - `license` string — License identifier
    - `homepage` string — URL of the extension's homepage
    - `repository` string — URL of the extension's source repository
    - `sponsorLink` string — URL to sponsor the extension
    - `bugs` string — URL of the extension's bug tracker
    - `markdown` 'standard' | 'github' — Markdown rendering engine to use in user interfaces
    - `galleryColor` string — CSS color to use as background in user interfaces
    - `galleryTheme` 'light' | 'dark' — Theme type for user interfaces
    - `localizedLanguages` string[] — Languages the extension has been translated in
    - `qna` string — URL of the extension's Q&A page
    - `badges` Badge[] — List of badges to display in user interfaces
      - `url` string — Image URL of the badge
      - `href` string — The link users will follow when clicking the badge
      - `description` string
    - `dependencies` ExtensionReference[] — List of dependencies to other extensions
      - `url` string, required — URL to get metadata of the referenced extension
      - `namespace` string, required — Namespace of the referenced extension
      - `extension` string, required — Name of the referenced extension
    - `bundledExtensions` ExtensionReference[] — List of extensions bundled with this extension
      - `url` string, required — URL to get metadata of the referenced extension
      - `namespace` string, required — Namespace of the referenced extension
      - `extension` string, required — Name of the referenced extension
    - `downloads` object — Map of download links by target platform
    - `allTargetPlatformVersions` VersionTargetPlatformsJson[] — Map of target platforms by extension version
      - `version` string
      - `targetPlatforms` string[]
    - `url` string — version metadata URL
    - `deprecated` boolean — Indicates whether the extension is deprecated
    - `replacement` ExtensionReplacement — Metadata of an extension replacement
      - `url` string — URL of the extension replacement
      - `displayName` string — Name to be displayed in user interfaces
    - `downloadable` boolean — Whether to show downloads in user interfaces

## 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)