# RubyGems on Onekey

> 8 endpoints for RubyGems (8 stable, 0 beta), 1 to 5 credits each. Category: Developer platforms. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/rubygems
Reference (Markdown): https://onekey.dev/docs/api/rubygems.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 8 mapped RubyGems endpoints return each:

- `entity.stats.downloads` (integer): 6
- `package.version` (string): 6
- `entity.description` (string): 5
- `author.displayName` (string): 4
- `entity.name` (string): 4
- `entity.url` (URL): 4
- `package.documentationUrl` (URL): 4
- `package.homepageUrl` (URL): 4
- `package.repositoryUrl` (URL): 4
- `author.id` (string): 1
- `author.username` (string): 1
- `entity.createdAt` (ISO 8601 date): 1
- plus 6 platform-specific fields under `ext.`

## Endpoints

### rubygems.gem

Metadata of a RubyGem (latest version).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/rubygems/gem?name=rails` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): RubyGems gem name
- Fields returned: `entity.name`, `package.version`, `entity.description`, `entity.url`, `package.homepageUrl`, `package.repositoryUrl`, `package.documentationUrl`, `entity.stats.downloads`, `author.displayName`, `ext.versionDownloads`, `ext.licenses`
- Reference: https://onekey.dev/docs/api/rubygems/gem.md

### rubygems.just_updated

Gems most recently updated.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/rubygems/just_updated` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.name`, `package.version`, `entity.description`, `entity.url`, `package.homepageUrl`, `package.repositoryUrl`, `package.documentationUrl`, `entity.stats.downloads`, `author.displayName`, `ext.versionDownloads`, `ext.licenses`
- Reference: https://onekey.dev/docs/api/rubygems/just_updated.md

### rubygems.latest

Newest gems on RubyGems.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/rubygems/latest` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.name`, `package.version`, `entity.description`, `entity.url`, `package.homepageUrl`, `package.repositoryUrl`, `package.documentationUrl`, `entity.stats.downloads`, `author.displayName`, `ext.versionDownloads`, `ext.licenses`
- Reference: https://onekey.dev/docs/api/rubygems/latest.md

### rubygems.latest_version

Latest version number of a gem.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/rubygems/latest_version?name=rails` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): RubyGems gem name
- Fields returned: `package.version`
- Reference: https://onekey.dev/docs/api/rubygems/latest_version.md

### rubygems.owners

Owners of a gem.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/rubygems/owners?name=rails` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): RubyGems gem name
- Fields returned: `author.id`, `author.username`, `ext.role`
- Reference: https://onekey.dev/docs/api/rubygems/owners.md

### rubygems.search

Search RubyGems.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/rubygems/search?q=rails` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.name`, `package.version`, `entity.description`, `entity.url`, `package.homepageUrl`, `package.repositoryUrl`, `package.documentationUrl`, `entity.stats.downloads`, `author.displayName`, `ext.versionDownloads`, `ext.licenses`
- Reference: https://onekey.dev/docs/api/rubygems/search.md

### rubygems.version_downloads

Download counts of a gem version and the gem in total.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/rubygems/version_downloads?name=rails&version=7.0.0` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): RubyGems gem name
  - `version` (string, required): Gem version
- Fields returned: `entity.stats.downloads`, `ext.versionDownloads`
- Reference: https://onekey.dev/docs/api/rubygems/version_downloads.md

### rubygems.versions

All published versions of a gem.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/rubygems/versions?name=rails` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): RubyGems gem name
- Fields returned: `package.version`, `entity.createdAt`, `entity.stats.downloads`, `entity.description`, `ext.platform`, `ext.prerelease`, `ext.rubyVersion`
- Reference: https://onekey.dev/docs/api/rubygems/versions.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/rubygems/gem?name=rails" \
  -H "x-api-key: YOUR_API_KEY"
```