Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RubyGems Profiles API

Endpoints for retrieving user profile information from RubyGems.org.

RubyGems Profiles API is one of 9 APIs that RubyGems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://rubygems.org/api/v1.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://rubygems.org/api/v1
Terms of Service
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Profiles 2

Endpoints for retrieving user profile information from RubyGems.org.

GET
/profiles/{userHandle}.json
Get User Profile
getUserProfile 1 param → 200404
GET
/profile/me.json
Get Authenticated User Profile
getMyProfile → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ProfileWithMfa (3 properties), Profile (2 properties), Error (1 property). Each schema is shown below with its type and property counts.

ProfileWithMfa
object
A RubyGems.org user profile with multi-factor authentication status
3 properties
Profile
object
A RubyGems.org user profile
2 properties
Error
object
Error response from the RubyGems.org API
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rubygems-profiles-api-openapi.yml Raw ↑

Other APIs RubyGems publishes across the network.

RubyGems Gems API
RubyGems Downloads API
RubyGems Search API
RubyGems Activity API
RubyGems Webhooks API
RubyGems Dependencies API
RubyGems Owners API
RubyGems Versions API