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

Regulations.gov comments API

Public comments submitted on regulatory documents

Regulations.gov comments API is one of 4 APIs that Regulations.gov publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 4.0.

Requests are made against a single base URL, https://api.regulations.gov/v4.

2 operations 2 paths 18 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0
Base URL
https://api.regulations.gov
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Regulations.gov comments API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (ApiKeyAuth). By default, every request must be authenticated.

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.

comments 2

Public comments submitted on regulatory documents

GET
/comments
List of comments
8 params → 200400403
GET
/comments/{commentId}
Get detailed information for specified commentId
2 params → 200400403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are BasicDetailModel (39 properties), Attachment (10 properties), FindAllResponseMetadata (9 properties), Comment (8 properties). Each schema is shown below with its type and property counts.

FindAllResponseMetadata
object
Pagination metadata for list responses
9 properties
CommentFindAllItem
object
A JSON:API document which represents a single comment in the list
4 properties
CommentFindAllResponse
object
A JSON:API document with a list of resources
2 properties
AttachmentFindAllItem
object
A JSON:API document which represents a single attachment in the list
4 properties
FileFormat
object
3 properties
CommentFindOneResponse
object
A JSON:API document which represents a single comment
6 properties
Attachment
object
10 properties
Link
string
A string containing the link URL.
CommentDetail
BasicDetailModel
object
39 properties
SelfLink
object
Link to self
1 property
DocumentType
string
type of document. This field is always returned in JSON response
Comment
object
8 properties
RelationshipToAttachment
array
An array of attachment objects as relationship resources.
RelationshipLinks
object
Relationship links to other related resources (attachments)
2 properties
JSONError
object
A JSON:API error document
1 property
Error
object
3 properties
Relationship
object
A single relationship object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

regulations-gov-comments-api-openapi.yml Raw ↑

Other APIs Regulations.gov publishes across the network.

Regulations.gov comment submission utilities API
Regulations.gov dockets API
Regulations.gov documents API