Skip to main content
GET
One Rules Committee record with its page text

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

record_id
string
required

Committee record id from the list, rcr_ and 24 hex characters.

Required string length: 28
Pattern: ^rcr_[0-9a-f]{24}$
Example:

"rcr_0123456789abcdef01234567"

Query Parameters

pageFrom
integer
default:1

First page of the record's text to return, counting from 1. Page through a long record by passing the page after the last one you received.

Required range: 1 <= x <= 100000
pageLimit
integer
default:50

Pages per call.

Required range: 1 <= x <= 200

Response

Successful Response

recordId
string
required

Stable id of this document.

Example:

"rcr_0123456789abcdef01234567"

committee
string
required

Standing, Appellate, Bankruptcy, Civil, Criminal, Evidence or General.

Example:

"Civil"

docType
string
required

meeting_minutes, agenda_books, committee_reports, rules_packages, preliminary_drafts, superseded_pamphlets, rules_comments, rules_suggestions, or a static page family.

Example:

"agenda_books"

textStatus
enum<string>
required

complete: every page with text is served. partial_needs_ocr: some pages are scans and have no text yet. needs_ocr: no page has text yet. blank: no page has text or images. not_extracted: the text layer was not read or could not be aligned with its pages.

Available options:
complete,
partial_needs_ocr,
needs_ocr,
blank,
not_extracted
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
meetingDate
string<date> | null

The meeting, for minutes and agenda books.

meetingDatePrecision
enum<string> | null
Available options:
day,
month,
year
publishedDate
string<date> | null

The publisher's date: release date, or the date submitted for a comment or suggestion.

publishedDatePrecision
enum<string> | null
Available options:
day,
month,
year
year
integer | null
sourceUrl
string | null

The PDF on uscourts.gov.

itemUrl
string | null

The uscourts.gov page that lists the PDF.

filename
string | null
sha256
string | null

SHA-256 of the mirrored bytes.

bytes
integer | null
pageCount
integer | null
textQuality
TextQuality · object | null

Page counts by quality; null means the page verdicts were not read, never zero pages.

textWithheld
boolean
default:false

True for public comments and suggestions: title, filename and page text are withheld (private names).

withdrawn
boolean
default:false

True when the publisher no longer lists the document.

asOf
string<date-time> | null

When we last saw the document listed.

dockets
RecordDocketLink · object[]
rules
RecordRuleLink · object[]
pages
RecordPage · object[]
pagesReturned
integer
default:0
nextPage
integer | null

Pass as pageFrom for the next window of pages.

textNotice
string | null

Present when some or all page text is not available yet, and why.