Skip to main content
GET
Everything we hold for one RIN

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

rin
string
required

Regulation Identifier Number NNNN-XXNN; lower case is accepted.

Maximum string length: 32
Pattern: ^[0-9]{4}[- ][A-Za-z]{2}[0-9]{2}$
Example:

"2060-AV16"

Response

Successful Response

Response for GET /us/rulemaking/rins/{rin}: everything we hold about one rulemaking.

rin
string
required
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.

title
string | null
agencyCode
string | null
status
string | null

Spine status: pending, final, final_only, ambiguous, withdrawn, umbrella_excluded.

stage
string | null

Stage of the newest Unified Agenda entry.

isUmbrella
boolean | null

An umbrella RIN covers many unrelated documents; no proposal-to-final pairing is claimed.

umbrellaBasis
string | null
agenda
AgendaSummary · object | null
reviews
ReviewItem · object[]
dockets
DocketLink · object[]
federalRegister
FederalRegisterLink · object[]
cfrParts
CfrPartLink · object[]
publicLaws
SimpleLink · object[]
craDisapprovals
SimpleLink · object[]
coverage
CoverageNote · object[]

What we hold and do not hold for this RIN.

asOf
string<date-time> | null

When the cross-link spine was last built.