/federalregister/documents/search

POST /api/federalregister/documents/search

Price: 1 credit

Search Federal Register documents with full-text and structured filters

How to use it

Search US Federal Register documents by keyword and rich filters: document type (Rule, Proposed Rule, Notice, Presidential Document), presidential document type, agency, topic, section, publication and effective date ranges, CFR title/part, docket id, regulation id number (RIN), president, and significance. Returns title, type, abstract, agencies, dates, citation, topics and document links.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• term string nullable — Full-text search keyword
• type array nullable — Filter by document type (one of: "RULE", "PRORULE", "NOTICE", "PRESDOCU")
• presidential_document_type array nullable — Filter presidential documents by their type (one of: "executive_order", "proclamation", "presidential_memorandum", "determination", "notice", "other")
• agencies array nullable — Filter by agency slug(s)
• agency_ids array nullable — Filter by numeric agency id(s)
• topics array nullable — Filter by topic / CFR indexing term(s)
• sections array nullable — Filter by Federal Register section (one of: "money", "environment", "world", "science-and-technology", "business-and-industry", "health-and-public-welfare")
• publication_date_is string nullable — Exact publication date (MM/DD/YYYY)
• publication_date_gte string nullable — Earliest publication date, inclusive (MM/DD/YYYY)
• publication_date_lte string nullable — Latest publication date, inclusive (MM/DD/YYYY)
• publication_date_year integer nullable — Publication year
• effective_date_is string nullable — Exact effective date (MM/DD/YYYY)
• effective_date_gte string nullable — Earliest effective date, inclusive (MM/DD/YYYY)
• effective_date_lte string nullable — Latest effective date, inclusive (MM/DD/YYYY)
• cfr_title integer nullable — Filter by referenced CFR title number
• cfr_part string nullable — Filter by referenced CFR part
• docket_id string nullable — Filter by docket id
• regulation_id_number string nullable — Filter by regulation id number (RIN)
• president array nullable — Filter by president identifier(s)
• significant boolean nullable — Only documents deemed significant
• order string — Result ordering (default: "relevance"; one of: "relevance", "newest", "oldest", "executive_order_number")
• count integer required — Number of documents to return (min: 1)

Response

• @type string (default: "FederalregisterDocument")
• document_number string required
• type string nullable
• subtype string nullable
• toc_doc string nullable
• toc_subject string nullable
• abstract string nullable
• action string nullable
• dates string nullable
• excerpts string nullable
• publication_date string nullable
• effective_on string nullable
• comments_close_on string nullable
• signing_date string nullable
• citation string nullable
• volume integer nullable
• start_page integer nullable
• end_page integer nullable
• page_length integer nullable
• significant boolean nullable
• executive_order_number string nullable
• proclamation_number string nullable
• presidential_document_number string nullable
• docket_ids array (default: [])
• regulation_id_numbers array (default: [])
• regulation_id_number_info array (default: [])
  • @type string (default: "FederalregisterRegulationIdNumber")
  • regulation_id_number string nullable
  • issue string nullable
  • priority_category string nullable
  • html_url string nullable
  • xml_url string nullable
• topics 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
• cfr_references array (default: [])
  • @type string (default: "FederalregisterCfrReference")
  • chapter string nullable
  • part string nullable
  • citation_url string nullable
• dockets array (default: [])
  • @type string (default: "FederalregisterDocket")
  • id string nullable
  • agency_name string nullable
  • supporting_documents_count integer nullable
  • supporting_documents array (default: [])
    • @type string (default: "FederalregisterSupportingDocument")
    • document_id string nullable
  • documents array (default: [])
    • @type string (default: "FederalregisterDocketDocument")
    • id string nullable
    • comment_count integer nullable
    • comment_url string nullable
    • comment_start_date string nullable
    • comment_end_date string nullable
    • allow_late_comments boolean nullable
    • regulations_dot_gov_open_for_comment boolean nullable
    • updated_at string nullable
• page_view_count integer nullable
• comment_url string nullable
• html_url string nullable
• pdf_url string nullable
• public_inspection_pdf_url string nullable
• full_text_xml_url string nullable
• body_html_url string nullable
• raw_text_url string nullable
• mods_url string nullable
• json_url string nullable
• regulations_dot_gov_url string nullable
• regulations_dot_gov_info object nullable
  • @type string (default: "FederalregisterRegulationsDotGovInfo")
  • docket_id string nullable
  • document_id string nullable
  • agency_id string nullable
  • regulation_id_number string nullable
  • comments_count integer nullable
  • comments_url string nullable
  • supporting_documents_count integer nullable
  • supporting_documents array (default: [])
    • @type string (default: "FederalregisterSupportingDocument")
    • document_id string nullable
  • checked_at 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.