Gsa

Regulations.gov API

US federal rulemaking comments and dockets

Government & public#government

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

US federal rulemaking comments and dockets

Endpoints 10

documents

  • GETList of documents/documentsThis endpoint returns list of documents
  • GETGet detailed information for specified documentId/documents/:documentIdGets the detailed information of a specific document with the passed documentId.

comments

  • GETList of comments/commentsThis endpoint returns list of comments
  • POSTCreates a new comment./comments
  • GETGet detailed information for specified commentId/comments/:commentIdGets the detailed information of a specific comment with the passed commentId.

dockets

  • GETList of dockets/docketsThis endpoint returns list of dockets
  • GETGet detailed information for specified docketId/dockets/:docketIdGets the detailed information of a specific docket with the passed docketId.

comment submission utilities

  • GETReturns a list of categories/agency-categories?filter[acronym]=stringThis endpoint returns list of categories
  • POSTCreates the unique submission key/submission-keys
  • POSTCreates a presigned url to upload file/file-upload-urlsReturns a pre-signed URL to upload a file to the S3 bucket

API details

Base URL
https://api.regulations.gov/v4
Authentication
An API key in the X-Api-Key header
Operations
10 operations on 9 pathsGET 7POST 3
Main resources
comment submission utilities 3comments 3dockets 2documents 2
Response formats
application/vnd.api+json
Description format
OpenAPI 3.0.0, API version 4.0

How to test the Regulations.gov API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Regulations.gov API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Api-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List of documents” (GET /documents), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Regulations.gov API?

US federal rulemaking comments and dockets It is listed under Government & public and has 10 endpoints.

Who publishes the Regulations.gov API?

It is listed from Gsa's public API description (an OpenAPI document), not published by Gsa on Swastik Codes. Anyone who controls gsa.gov can claim the profile by adding a DNS TXT record.

What is the base URL of the Regulations.gov API?

Requests go to https://api.regulations.gov/v4. Endpoint paths are added to this base URL.

How do I authenticate with the Regulations.gov API?

With an API key in the X-Api-Key header.

How many endpoints does the Regulations.gov API have?

10 operations on 9 paths (7 GET, 3 POST). The largest groups are comment submission utilities, comments, dockets, documents.

Is forking the Regulations.gov API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.