# jetbrains.plugin

**stable** **Standard**

JetBrains Marketplace plugin by numeric id.

`GET /v1/jetbrains/plugin`

## What you get

One Jetbrains 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 |
| --- | --- | --- | --- | --- | --- |
| `id` | string | yes | (required) | Plugin id | max 9 chars; must match `[0-9]{1,9}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/jetbrains/plugin?id=7495" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/jetbrains/plugin",
    params={"id": "7495"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ id: "7495" });
const res = await fetch(`https://api.onekey.dev/v1/jetbrains/plugin?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

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

```json
{
  "success": true,
  "data": {
    "entity": {
      "id": "7495",
      "name": ".ignore",
      "slug": "mobi.hsz.idea.gitignore",
      "description": ".ignore is a plugin for: .bzrignore (Bazaar) .chefignore (Chef) .cfignore (CloudFoundry) .cvsignore (Cvs) .boringignore (Darcs) .deployignore (DeployHQ) .distignore (WP-CLI) .dockerignore (Docker) .ebignore (ElasticBeanstalk) .eleventyignore (Eleventy) .eslintignore (ESLint) .flooignore (Floobits) ignore-glob (Fossil) .gitignore (Git) .gcloudignore (GoogleCloud) .helmignore (Kubernetes Helm) .jpmignore (Jetpack) .jshintignore (JSHint) .hgignore (Mercurial) .mtn-ignore (Monotone) .nodemonignore (Nodemon) .npmignore (Npm) .nuxtignore (NuxtJS) .openapi-generator-ignore (OpenAPI Generator) .p4ignore (Perforce) .prettierignore (Prettier) .ignore (Sourcegraph) .stylelintignore (StyleLint) .stylintignore (Stylint) .swagger-codegen-ignore (SwaggerCodegen) .terraformignore (Terraform) .tfignore (TF) .tokeignore (Tokei) .upignore (Up) .vercelignore (Vercel) .yarnignore (Yarn) files in your project. It supports the following IDEs: Android Studio AppCode CLion GoLand IntelliJ IDEA PhpStorm PyCharm RubyMine WebStorm DataGrip Features Files syntax highlight Templates filtering and selecting in rules generator by name and content User custom templates Show ignored files by specified Gitignore file (right-click on .gitignore file) Create a file in the currently selected directory Generate Gitignore rules basing on [GitHub's templates collection][github-gitignore] Add a selected file/directory to Gitignore rules from the popup menu Suggesting .gitignore file creation for a new project Entries inspection (duplicated, covered, unused, incorrect syntax, relative entries) with quick-fix actions Comments and brackets support Navigation to entries in Project view Renaming entries from a dot-ignore file Close opened ignored files action Custom user templates with import/export features",
      "stats": {
        "downloads": 19904578
      },
      "url": null
    },
    "ext": {
      "entitySummary": ".ignore is a plugin for: .bzrignore (Bazaar).chefignore (Chef).cfignore (CloudFoundry).cvsignore (Cvs).boringignore (Darcs).deployignore (DeployHQ).distignore...",
      "developer": "JetBrains",
      "pricing": "FREE"
    },
    "content": {
      "createdAt": "2026-01-19T12:28:33Z"
    }
  },
  "metadata": {
    "platform": "jetbrains",
    "endpoint": "plugin",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | `toString` |
| `name` | `entity.name` | - |
| `xmlId` | `entity.slug` | - |
| `preview` | `ext.entitySummary` | - |
| `description` | `entity.description` | `stripHtml` |
| `vendor.name` | `ext.developer` | - |
| `downloads` | `entity.stats.downloads` | `toNumber` |
| `cdate` | `content.createdAt` | `toIsoDate` |
| `pricingModel` | `ext.pricing` | - |
| `urls.url` | `entity.url` | `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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).
