# RubyGems Search - Gem Versions, Downloads and Licences (`alaudinburki/rubygems-search`) Actor

Search RubyGems and get flat rows - gem name, description, version, downloads and licence. Free public API, no key.

- **URL**: https://apify.com/alaudinburki/rubygems-search.md
- **Developed by:** [alaudin burki](https://apify.com/alaudinburki) (community)
- **Categories:** Developer tools
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## RubyGems Search — Gem Versions, Downloads and Licences

Search RubyGems and get flat rows — gem name, summary, version, downloads and licence. Free public
API, no key.

### What you get

`name`, `version`, `info`, `downloads`, `versionDownloads`, `authors`, `licenses`, `homepage`,
`sourceCode`, `url`.

### Sample output

```json
{ "name": "rails", "version": "8.1.4", "downloads": 802449131,
  "licenses": ["MIT"], "homepage": "https://rubyonrails.org" }
```

### Limitations

- Search matches names and descriptions and is **not ranked by relevance** the way a search engine is.
- `version` is the latest published version, which may be a pre-release.
- `licenses` is an array and is joined into one string, because a dataset row must be flat.
- Download counts include mirrors and automated installs.

### Inputs

| Input | Type | Default | What it does |
|---|---|---|---|
| `query` | string | — | Words to match in gem names and descriptions, e.g |

Stops after **500 rows** or **1 requests**, whichever comes first — raise
`maxItems` and `maxPages` for more. Requests are paced 200 ms apart.

The dataset's SUMMARY records `truncated` and `stopReason`, so a run that hit a cap says so
rather than looking like a source that had nothing more.

### Pricing

Pay per result.

### Fields

| Field | Type | What it holds |
|---|---|---|
| `name` | string | Display name as the source writes it. |
| `version` | string | Version of this record or artefact. |
| `info` | string | Descriptive text the source gives for the item. Free text, and its length and purpose vary by source. |
| `downloads` | number | Download or retrieval count over the period stated by the source. A popularity signal, never a user count. |
| `versionDownloads` | number | Downloads of this specific version, as the source counts them. |
| `authors` | string | Authors, joined into one string with a separator — see the README for which. |
| `licenses` | string | Licences declared for this package. |
| `homepage` | string | Homepage of the organisation or project. |
| `sourceCode` | string | Link to the item's source repository. |
| `url` | string | The URL this row describes. |

# Actor input Schema

## `query` (type: `string`):

Words to match in gem names and descriptions, e.g. rails, http, json.

## `maxItems` (type: `integer`):

Stop after this many rows.

## `maxPages` (type: `integer`):

Stop after this many pages.

## Actor input object example

```json
{
  "maxItems": 500,
  "maxPages": 5
}
```

# Actor output Schema

## `results` (type: `string`):

One row per item, with the 10 fields listed under Views.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "maxItems": 500,
    "maxPages": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("alaudinburki/rubygems-search").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "maxItems": 500,
    "maxPages": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("alaudinburki/rubygems-search").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "maxItems": 500,
  "maxPages": 5
}' |
apify call alaudinburki/rubygems-search --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,alaudinburki/rubygems-search"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/io9XHiquhb79OdUXN/builds/2p1pQd4Xnat4OcbIO/openapi.json