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

Hex.pm Packages API

Package search and metadata.

Hex.pm Packages API is one of 12 APIs that Hex.pm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Packages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://hex.pm/api.

3 operations 3 paths 5 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://hex.pm/api
Authentication
API Key, HTTP Bearer, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 3

Hex.pm Packages API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API token authentication. Pass the token directly: Authorization: token. For OAuth2 Bearer tokens use: Authorization: Bearer token.
  • BearerAuth — OAuth2 Bearer token obtained via Device Authorization Grant (RFC 8628).
  • BasicAuth — Deprecated. Basic authentication with username and password. Only allowed on specific endpoints for generating API tokens.

Paths & Operations 3

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

Packages 3

Package search and metadata.

GET
/packages
List all Packages
listPackages 3 params → 200
GET
/packages/{name}
Fetch a Package
getPackage 1 param → 200404
GET
/packages/{name}/audit-logs
Fetch Package Audit Logs
getPackageAuditLogs 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Package (10 properties), AuditLog (4 properties), Error (3 properties), Owner (3 properties). Each schema is shown below with its type and property counts.

AuditLog
object
4 properties
Package
object
10 properties
ReleaseSummary
object
3 properties
Owner
object
3 properties
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-pm-packages-api-openapi.yml Raw ↑

Other APIs Hex.pm publishes across the network.

Hex.pm API Keys API
Hex.pm Authentication API
Hex.pm Documentation API
Hex.pm Index API
Hex.pm OAuth API
Hex.pm Organizations API
Hex.pm Package Owners API
Hex.pm Releases API
Hex.pm Repositories API
Hex.pm Users API
Hex.pm Utilities API