/federalregister/public_inspection_documents/search

POST /api/federalregister/public_inspection_documents/search

Price: 10 credits

Search public inspection documents (early-access filings)

How to use it

Search US Federal Register public inspection documents (filed and available for early access before official publication). Filter by keyword, availability date, document type, agency and docket id, or set current to list everything currently on public inspection. Returns title, type, subjects, filing type and time, agencies, expected publication date and document links.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• current boolean — Return all documents currently on public inspection (ignores other filters) (default: false)
• term string nullable — Full-text search keyword
• available_on string nullable — Filter by public inspection availability date (YYYY-MM-DD)
• type array nullable — Filter by document type (one of: "RULE", "PRORULE", "NOTICE", "PRESDOCU")
• agencies array nullable — Filter by agency slug(s)
• agency_ids array nullable — Filter by numeric agency id(s)
• docket_id string nullable — Filter by docket id
• count integer required — Number of documents to return (min: 1)

Response

• @type string (default: "FederalregisterPublicInspectionDocument")
• document_number string required
• type string nullable
• subject_1 string nullable
• subject_2 string nullable
• subject_3 string nullable
• toc_doc string nullable
• toc_subject string nullable
• editorial_note string nullable
• excerpts string nullable
• filing_type string nullable
• filed_at string nullable
• publication_date string nullable
• last_public_inspection_issue string nullable
• num_pages integer nullable
• docket_numbers array (default: [])
• agency_names array (default: [])
• agencies array (default: [])
  • @type string (default: "FederalregisterAgencyRef")
  • id integer nullable
  • name string nullable
  • raw_name string nullable
  • slug string nullable
  • parent_id integer nullable
  • url string nullable
  • json_url string nullable
• pdf_file_name string nullable
• pdf_file_size integer nullable
• pdf_updated_at string nullable
• page_view_count integer nullable
• html_url string nullable
• pdf_url string nullable
• raw_text_url string nullable
• json_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.