Projects API

Like it's HTML counterpart project comparisons the projects API allows to query the data for an arbitrary selection of projects.

This allows you to programatically retrieve data for gems and their GitHub source repositories in a single place, as well as additional metrics specific to the Ruby Toolbox like popularity scores and project health status.

The API has currently no rate-limiting policy, however please use it reasonably. If you need larger scale access to data for analysis please use our production database exports instead.

A simple ruby API client is available on rubygems as rubytoolbox-api.

GET /api/projects/compare/rubocop,rspec-expectations,oj

This endpoint is limited to 100 projects per request. If you request more than that you will receive an error. Please batch requests in groups to retrieve more projects.


{
  "projects": [
    {
      "permalink": "oj",
      "categories": [
        {
          "permalink": "JSON_Parsers",
          "category_group": {
            "permalink": "Web_Apps_Services_Interaction",
            "description": null,
            "name": "Web Apps, Services & Interaction"
          },
          "description": "JSON parsers convert data serialized in the popular JSON data exchange format to and from Ruby objects",
          "name": "JSON Parsers",
          "urls": {
            "toolbox_url": "https://www.ruby-toolbox.com/categories/JSON_Parsers"
          }
        }
      ],
      "description": "The fastest JSON parser and object serializer.",
      "github_repo": {
        "path": "ohler55/oj",
        "average_recent_committed_at": "2019-11-28 19:20:46 UTC",
        "description": "Optimized JSON",
        "is_archived": false,
        "is_fork": false,
        "is_mirror": false,
        "issues": {
          "url": "https://github.com/ohler55/oj/issues",
          "open_count": 13,
          "closed_count": 433,
          "total_count": 446,
          "closure_rate": "97.09"
        },
        "license": "mit",
        "primary_language": "C",
        "pull_requests": {
          "url": "https://github.com/ohler55/oj/pulls",
          "open_count": 2,
          "closed_count": 17,
          "merged_count": 136,
          "total_count": 155,
          "acceptance_rate": "87.74"
        },
        "repo_pushed_at": "2020-05-16 14:26:04 UTC",
        "stats": {
          "stargazers_count": 2563,
          "forks_count": 177,
          "watchers_count": 36
        },
        "url": "https://github.com/ohler55/oj",
        "wiki_url": "https://github.com/ohler55/oj/wiki"
      },
      "health": {
        "overall_level": "green",
        "statuses": [
          {
            "key": "rubygem_long_running",
            "icon": "diamond",
            "label": "A long-lived project that still receives updates",
            "level": "green"
          }
        ]
      },
      "name": "oj",
      "rubygem": {
        "name": "oj",
        "current_version": "3.10.6",
        "first_release_on": "2012-02-19",
        "latest_release_on": "2020-04-04",
        "licenses": [
          "MIT"
        ],
        "stats": {
          "downloads": 54055470,
          "reverse_dependencies_count": 682,
          "quarterly_release_counts": {
            "2012-1": 18,
            "2012-2": 10,
            "2012-3": 6,
            "2012-4": 12,
            "2013-1": 10,
            "2013-2": 8,
            "2013-3": 1,
            "2013-4": 12,
            "2014-1": 8,
            "2014-2": 13,
            "2014-3": 4,
            "2014-4": 4,
            "2015-1": 6,
            "2015-2": 8,
            "2015-3": 5,
            "2015-4": 6,
            "2016-1": 4,
            "2016-2": 3,
            "2016-3": 5,
            "2016-4": 2,
            "2017-1": 5,
            "2017-2": 17,
            "2017-3": 8,
            "2017-4": 4,
            "2018-1": 2,
            "2018-2": 4,
            "2018-3": 8,
            "2018-4": 9,
            "2019-1": 5,
            "2019-2": 1,
            "2019-3": 4,
            "2019-4": 2,
            "2020-1": 4,
            "2020-2": 1
          },
          "releases_count": 219
        },
        "url": "https://rubygems.org/gems/oj"
      },
      "score": "6.49",
      "urls": {
        "bug_tracker_url": "https://github.com/ohler55/oj/issues",
        "changelog_url": null,
        "documentation_url": "http://www.ohler.com/oj/doc/index.html",
        "homepage_url": "http://www.ohler.com/oj/",
        "mailing_list_url": null,
        "source_code_url": "https://github.com/ohler55/oj",
        "toolbox_url": "https://www.ruby-toolbox.com/projects/oj",
        "wiki_url": "https://github.com/ohler55/oj/wiki"
      }
    },
    {
      "permalink": "rspec-expectations",
      "categories": [

      ],
      "description": "rspec-expectations provides a simple, readable API to express expected outcomes of a code example.",
      "github_repo": {
        "path": "rspec/rspec-expectations",
        "average_recent_committed_at": "2020-02-25 08:12:22 UTC",
        "description": "Provides a readable API to express expected outcomes of a code example",
        "is_archived": false,
        "is_fork": false,
        "is_mirror": false,
        "issues": {
          "url": "https://github.com/rspec/rspec-expectations/issues",
          "open_count": 30,
          "closed_count": 420,
          "total_count": 450,
          "closure_rate": "93.33"
        },
        "license": "other",
        "primary_language": "Ruby",
        "pull_requests": {
          "url": "https://github.com/rspec/rspec-expectations/pulls",
          "open_count": 7,
          "closed_count": 172,
          "merged_count": 551,
          "total_count": 730,
          "acceptance_rate": "75.48"
        },
        "repo_pushed_at": "2020-05-13 11:25:54 UTC",
        "stats": {
          "stargazers_count": 1070,
          "forks_count": 355,
          "watchers_count": 47
        },
        "url": "https://github.com/rspec/rspec-expectations",
        "wiki_url": null
      },
      "health": {
        "overall_level": "green",
        "statuses": [
          {
            "key": "rubygem_long_running",
            "icon": "diamond",
            "label": "A long-lived project that still receives updates",
            "level": "green"
          }
        ]
      },
      "name": "rspec-expectations",
      "rubygem": {
        "name": "rspec-expectations",
        "current_version": "3.9.2",
        "first_release_on": "2009-09-16",
        "latest_release_on": "2020-05-08",
        "licenses": [
          "MIT"
        ],
        "stats": {
          "downloads": 518568862,
          "reverse_dependencies_count": 442,
          "quarterly_release_counts": {
            "2009-3": 1,
            "2010-1": 13,
            "2010-2": 11,
            "2010-3": 6,
            "2010-4": 6,
            "2011-1": 2,
            "2011-2": 4,
            "2011-4": 4,
            "2012-1": 3,
            "2012-2": 2,
            "2012-3": 4,
            "2012-4": 2,
            "2013-1": 1,
            "2013-2": 1,
            "2013-3": 4,
            "2013-4": 3,
            "2014-1": 3,
            "2014-2": 7,
            "2014-3": 6,
            "2015-1": 1,
            "2015-2": 2,
            "2015-3": 1,
            "2015-4": 1,
            "2016-1": 2,
            "2016-2": 2,
            "2016-3": 1,
            "2016-4": 2,
            "2017-2": 1,
            "2017-4": 1,
            "2018-3": 2,
            "2018-4": 1,
            "2019-2": 2,
            "2019-4": 3,
            "2020-1": 1,
            "2020-2": 1
          },
          "releases_count": 107
        },
        "url": "https://rubygems.org/gems/rspec-expectations"
      },
      "score": "51.06",
      "urls": {
        "bug_tracker_url": "https://github.com/rspec/rspec-expectations/issues",
        "changelog_url": null,
        "documentation_url": "https://rspec.info/documentation/",
        "homepage_url": "https://github.com/rspec/rspec-expectations",
        "mailing_list_url": "https://groups.google.com/forum/#!forum/rspec",
        "source_code_url": "https://github.com/rspec/rspec-expectations",
        "toolbox_url": "https://www.ruby-toolbox.com/projects/rspec-expectations",
        "wiki_url": null
      }
    },
    {
      "permalink": "rubocop",
      "categories": [
        {
          "permalink": "code_metrics",
          "category_group": {
            "permalink": "Code_Quality",
            "description": null,
            "name": "Code Quality"
          },
          "description": "Utilities to improve code quality by reporting common code smells like complexity, unsafe defaults, unused variables or stylistic inconsistencies",
          "name": "Code Metrics",
          "urls": {
            "toolbox_url": "https://www.ruby-toolbox.com/categories/code_metrics"
          }
        }
      ],
      "description": "    Automatic Ruby code style checking tool.\n    Aims to enforce the community-driven Ruby Style Guide.\n",
      "github_repo": {
        "path": "rubocop-hq/rubocop",
        "average_recent_committed_at": "2020-05-07 20:59:58 UTC",
        "description": "A Ruby static code analyzer and formatter, based on the community Ruby style guide.",
        "is_archived": false,
        "is_fork": false,
        "is_mirror": false,
        "issues": {
          "url": "https://github.com/rubocop-hq/rubocop/issues",
          "open_count": 171,
          "closed_count": 3418,
          "total_count": 3589,
          "closure_rate": "95.24"
        },
        "license": "mit",
        "primary_language": "Ruby",
        "pull_requests": {
          "url": "https://github.com/rubocop-hq/rubocop/pulls",
          "open_count": 34,
          "closed_count": 457,
          "merged_count": 3857,
          "total_count": 4348,
          "acceptance_rate": "88.71"
        },
        "repo_pushed_at": "2020-05-16 18:18:01 UTC",
        "stats": {
          "stargazers_count": 10758,
          "forks_count": 2312,
          "watchers_count": 203
        },
        "url": "https://github.com/rubocop-hq/rubocop",
        "wiki_url": "https://github.com/rubocop-hq/rubocop/wiki"
      },
      "health": {
        "overall_level": "green",
        "statuses": [
          {
            "key": "rubygem_long_running",
            "icon": "diamond",
            "label": "A long-lived project that still receives updates",
            "level": "green"
          }
        ]
      },
      "name": "rubocop",
      "rubygem": {
        "name": "rubocop",
        "current_version": "0.83.0",
        "first_release_on": "2012-05-03",
        "latest_release_on": "2020-05-11",
        "licenses": [
          "MIT"
        ],
        "stats": {
          "downloads": 96666887,
          "reverse_dependencies_count": 8340,
          "quarterly_release_counts": {
            "2012-2": 1,
            "2012-4": 1,
            "2013-1": 4,
            "2013-2": 18,
            "2013-3": 8,
            "2013-4": 4,
            "2014-1": 5,
            "2014-2": 6,
            "2014-3": 4,
            "2014-4": 3,
            "2015-1": 2,
            "2015-2": 5,
            "2015-3": 4,
            "2015-4": 2,
            "2016-1": 6,
            "2016-2": 3,
            "2016-3": 3,
            "2016-4": 4,
            "2017-1": 3,
            "2017-2": 3,
            "2017-3": 1,
            "2017-4": 3,
            "2018-1": 2,
            "2018-2": 5,
            "2018-3": 6,
            "2018-4": 3,
            "2019-1": 6,
            "2019-2": 9,
            "2019-3": 3,
            "2019-4": 4,
            "2020-1": 3,
            "2020-2": 3
          },
          "releases_count": 137
        },
        "url": "https://rubygems.org/gems/rubocop"
      },
      "score": "17.61",
      "urls": {
        "bug_tracker_url": "https://github.com/rubocop-hq/rubocop/issues",
        "changelog_url": null,
        "documentation_url": "https://docs.rubocop.org/",
        "homepage_url": "https://www.rubocop.org/",
        "mailing_list_url": null,
        "source_code_url": "https://github.com/rubocop-hq/rubocop/",
        "toolbox_url": "https://www.ruby-toolbox.com/projects/rubocop",
        "wiki_url": "https://github.com/rubocop-hq/rubocop/wiki"
      }
    }
  ]
}