openvsx.extension

stable Standard

Open VSX extension by namespace and name.

GET /v1/openvsx/extension

What you get#

One Openvsx record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`namespace`	string	yes	(required)	Publisher namespace	max 64 chars; must match `[A-Za-z0-9][A-Za-z0-9_.-]{0,63}`; trimmed
`name`	string	yes	(required)	Extension name	max 100 chars; must match `[A-Za-z0-9][A-Za-z0-9_.-]{0,99}`; trimmed

Request#

curl "https://api.onekey.dev/v1/openvsx/extension?namespace=redhat&name=java" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Openvsx response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "package": {
      "namespace": "redhat",
      "version": "1.57.2026092608",
      "license": "EPL-2.0"
    },
    "entity": {
      "id": "java",
      "name": "Language Support for Java(TM) by Red Hat",
      "description": "Java Linting, Intellisense, formatting, refactoring, Maven/Gradle support and more...",
      "stats": {
        "downloads": 42898895,
        "rating": 5,
        "ratingCount": 16
      },
      "url": "https://github.com/redhat-developer/vscode-java#readme"
    },
    "ext": {
      "developer": "rhdevelopers-ci",
      "repository": "https://github.com/redhat-developer/vscode-java.git"
    },
    "content": {
      "updatedAt": "2026-09-26T08:21:29Z"
    },
    "media": {
      "thumbnailUrl": "https://open-vsx.org/api/redhat/java/1.57.2026092608/file/icon128.png"
    }
  },
  "metadata": {
    "platform": "openvsx",
    "endpoint": "extension",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`namespace`	`package.namespace`	-
`name`	`entity.id`	-
`displayName`	`entity.name`	-
`description`	`entity.description`	-
`version`	`package.version`	-
`publishedBy.loginName`	`ext.developer`	-
`license`	`package.license`	-
`downloadCount`	`entity.stats.downloads`	`toNumber`
`averageRating`	`entity.stats.rating`	`toNumber`
`reviewCount`	`entity.stats.ratingCount`	`toNumber`
`repository`	`ext.repository`	`safeUrl`
`homepage`	`entity.url`	`safeUrl`
`timestamp`	`content.updatedAt`	`toIsoDate`
`files.icon`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).