Skip to main content
GET
One Regulations.gov docket

Authorizations

Authorization
string
header
required

API key issued from the developer dashboard. Pass as Authorization: Bearer vq_key_... (preferred).

Headers

Idempotency-Key
string | null

Optional. 16 to 255 visible ASCII characters (a UUIDv4 works). Repeating the same request with the same key replays the original 2xx response for 24 hours without charging again. The same key on a different request is rejected. With the account's cacheQueryDerivedData retention setting off, no body is stored and a retry answers 409 idempotency_replay_unavailable, still without a second charge.

Required string length: 16 - 255
Pattern: ^[\x21-\x7e]+$
Example:

"3f9c2a1e-7b44-4d0a-9c1e-5a6b7c8d9e0f"

Path Parameters

docket_id
string
required

Regulations.gov docket id, for example EPA-HQ-OAR-2021-0208. Case is kept as printed.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]*$
Example:

"EPA-HQ-OAR-2021-0208"

Response

Successful Response

Response for GET /us/rulemaking/dockets/{docketId}.

docketId
string
required

Regulations.gov docket id.

Example:

"EPA-HQ-OAR-2021-0208"

agencyId
string
required

Regulations.gov agency id.

Example:

"EPA"

sourceUrl
string
required

The docket page on regulations.gov.

processingTimeMs
number
default:0

Server-side time in milliseconds, not billed on.

creditsConsumed
number
default:0

Credits charged for this call. 0 when not charged or refunded.

docketType
string | null

Rulemaking or Nonrulemaking.

title
string | null
rin
string | null

Regulation Identifier Number, normalised. Regulations.gov's value when it has one, otherwise the single RIN our cross-link spine holds as verified for this docket (see rinSource). Null when neither exists, or when the spine names several RINs (no pick is made).

Example:

"2060-AV16"

rinSource
enum<string> | null

Where rin came from: regulations_gov (the publisher) or spine (our verified cross-link). Null when rin is null.

Available options:
regulations_gov,
spine
Example:

"spine"

spineRin
string | null

Set only when the spine holds a verified RIN that DIFFERS from the publisher's rin. rin stays the publisher's value.

Example:

"2120-AA64"

lastModifiedAt
string<date-time> | null

Regulations.gov lastModifiedDate.

commentCount
integer | null

Comments received. Null means NOT MEASURED, never zero. See commentCountAsOf.

commentCountAsOf
string<date-time> | null

When we measured commentCount.

asOf
string<date-time> | null

When we last saw this docket at the publisher.

abstract
string | null
modifyDate
string<date-time> | null
documentCount
integer
default:0

Documents of this docket that we hold.

documentTypeCounts
Documenttypecounts · object