Sign in
registry-api

Search extensions via text entered by a user

get/api/-/search

Query parameters

querystring

Query text for searching

categorystring

Extension category as shown in the UI

targetPlatform'win32-x64' | 'win32-ia32' | 'win32-arm64' | 'linux-x64' | 'linux-arm64' | 'linux-armhf' | 'alpine-x64' | 'alpine-arm64' | 'darwin-x64' | 'darwin-arm64' | 'web' | 'universal'

Target platform

sizeinteger

Maximal number of entries to return

offsetinteger

Number of entries to skip (usually a multiple of the page size)

sortOrder'asc' | 'desc'

Descending or ascending sort order

sortBy'relevance' | 'timestamp' | 'rating' | 'downloadCount'

Sort key (relevance is a weighted mix of various properties)

includeAllVersionsboolean

Whether to include information on all available versions for each returned entry

Response

The search results are returned in JSON format

successstring

Indicates success of the operation (omitted if a more specific result type is returned)

warningstring

Indicates a warning; when this is present, other properties can still be used

errorstring

Indicates an error; when this is present, all other properties should be ignored

offsetinteger required

Number of skipped entries according to the search query

totalSizeinteger required

Total number of entries that match the search query

Changes

No recorded changes to this endpoint across all 1 revision of this API.