### Agencies API Source: https://www.federalregister.gov/developers/documentation/api/v1/index Endpoints for retrieving information about federal agencies, including fetching all agency details or the details of a specific agency by its slug. ```APIDOC ## GET /agencies ### Description Fetch all agency details. ### Method GET ### Endpoint /api/v1/agencies ### Parameters None ### Request Example ``` GET /api/v1/agencies ``` ### Response #### Success Response (200) - **agencies** (array) - A list of all federal agencies with their details. #### Response Example ```json { "agencies": [ { "name": "Environmental Protection Agency", "slug": "epa" }, { "name": "Department of Agriculture", "slug": "usda" } ] } ``` ## GET /agencies/{slug} ### Description Fetch a particular agency's details using its unique slug. ### Method GET ### Endpoint /api/v1/agencies/{slug} ### Parameters #### Path Parameters - **slug** (string) - Required - The unique identifier (slug) of the agency. ### Request Example ``` GET /api/v1/agencies/epa ``` ### Response #### Success Response (200) - **agency** (object) - Contains the details of the specified agency. #### Response Example ```json { "agency": { "name": "Environmental Protection Agency", "slug": "epa" } } ``` ``` -------------------------------- ### Suggested Searches API Source: https://www.federalregister.gov/developers/documentation/api/v1/index Endpoints for retrieving suggested search terms, either all suggestions or suggestions limited by a FederalRegister.gov section, or details for a specific suggested search by its slug. ```APIDOC ## GET /suggested_searches ### Description Fetch all suggested searches or limit by FederalRegister.gov section. ### Method GET ### Endpoint /api/v1/suggested_searches ### Parameters #### Query Parameters - **section** (string) - Optional - Filter suggested searches by a specific section (e.g., 'rules'). ### Request Example ``` GET /api/v1/suggested_searches?section=proposed-rules ``` ### Response #### Success Response (200) - **suggestions** (array) - A list of suggested search terms. #### Response Example ```json { "suggestions": [ "Example Search 1", "Another Search Term" ] } ``` ## GET /suggested_searches/{slug} ### Description Fetch a particular suggested search by its unique slug. ### Method GET ### Endpoint /api/v1/suggested_searches/{slug} ### Parameters #### Path Parameters - **slug** (string) - Required - The unique identifier (slug) of the suggested search. ### Request Example ``` GET /api/v1/suggested_searches/popular-topics ``` ### Response #### Success Response (200) - **suggestion** (object) - Contains the details of the specified suggested search. #### Response Example ```json { "suggestion": { "term": "Climate Change Policies", "slug": "climate-change" } } ``` ``` -------------------------------- ### Images API Source: https://www.federalregister.gov/developers/documentation/api/v1/index Endpoint for fetching image variants and their metadata for a given image identifier. ```APIDOC ## GET /images/{identifier} ### Description Fetch the available image variants and their metadata for a single image identifier. ### Method GET ### Endpoint /api/v1/images/{identifier} ### Parameters #### Path Parameters - **identifier** (string) - Required - The unique identifier of the image. ### Request Example ``` GET /api/v1/images/img_abc123 ``` ### Response #### Success Response (200) - **image_data** (object) - Contains information about the image and its variants. #### Response Example ```json { "image_data": { "id": "img_abc123", "variants": [ { "url": "/images/img_abc123_thumb.jpg", "size": "thumbnail" }, { "url": "/images/img_abc123_large.jpg", "size": "large" } ] } } ``` ``` -------------------------------- ### Public Inspection Documents API Source: https://www.federalregister.gov/developers/documentation/api/v1/index Endpoints for retrieving documents that are currently on public inspection, including fetching single or multiple documents and searching the current public inspection list. ```APIDOC ## GET /public-inspection-documents/{document_number}.{format} ### Description Fetch a single public inspection document. ### Method GET ### Endpoint /api/v1/public-inspection-documents/{document_number}.{format} ### Parameters #### Path Parameters - **document_number** (string) - Required - The unique identifier of the document. - **format** (string) - Required - The desired format for the document (e.g., json, xml). ### Request Example ``` GET /api/v1/public-inspection-documents/PI-12345.json ``` ### Response #### Success Response (200) - **document** (object) - Contains the details of the public inspection document. #### Response Example ```json { "document": { "title": "Public Notice", "publication_date": "2024-07-26" } } ``` ## GET /public-inspection-documents/{document_numbers}.{format} ### Description Fetch multiple public inspection documents. ### Method GET ### Endpoint /api/v1/public-inspection-documents/{document_numbers}.{format} ### Parameters #### Path Parameters - **document_numbers** (string) - Required - A comma-separated list of document identifiers. - **format** (string) - Required - The desired format for the documents (e.g., json, xml). ### Request Example ``` GET /api/v1/public-inspection-documents/PI-12345,PI-67890.json ``` ### Response #### Success Response (200) - **documents** (array) - A list of public inspection documents. #### Response Example ```json { "documents": [ { "title": "Notice A", "publication_date": "2024-07-26" }, { "title": "Notice B", "publication_date": "2024-07-26" } ] } ``` ## GET /public-inspection-documents/current.{format} ### Description Fetch all the public inspection documents that are currently on public inspection. ### Method GET ### Endpoint /api/v1/public-inspection-documents/current.{format} ### Parameters #### Path Parameters - **format** (string) - Required - The desired format for the documents (e.g., json, xml). ### Request Example ``` GET /api/v1/public-inspection-documents/current.json ``` ### Response #### Success Response (200) - **documents** (array) - A list of current public inspection documents. #### Response Example ```json { "documents": [ { "title": "Current Notice 1", "publication_date": "2024-07-26" } ] } ``` ## GET /public-inspection-documents.{format} ### Description Search all the public inspection documents that are currently on public inspection. Use the document search to find documents that have been published. ### Method GET ### Endpoint /api/v1/public-inspection-documents.{format} ### Parameters #### Query Parameters - **query** (string) - Optional - Search terms to filter documents. - **start_date** (string) - Optional - Start date for the search (YYYY-MM-DD). - **end_date** (string) - Optional - End date for the search (YYYY-MM-DD). - **limit** (integer) - Optional - Number of results to return. - **offset** (integer) - Optional - Number of results to skip. - **format** (string) - Required - The desired format for the results (e.g., json, xml). ### Request Example ``` GET /api/v1/public-inspection-documents.json?query=regulation&start_date=2024-07-25 ``` ### Response #### Success Response (200) - **documents** (array) - A list of matching public inspection documents. #### Response Example ```json { "documents": [ { "title": "Proposed Regulation Notice", "publication_date": "2024-07-26" } ] } ``` ``` -------------------------------- ### Federal Register Documents API Source: https://www.federalregister.gov/developers/documentation/api/v1/index Endpoints for retrieving Federal Register documents, including fetching single or multiple documents by number, searching all documents, and retrieving counts grouped by facets. ```APIDOC ## GET /documents/{document_number}.{format} ### Description Fetch a single Federal Register document. ### Method GET ### Endpoint /api/v1/documents/{document_number}.{format} ### Parameters #### Path Parameters - **document_number** (string) - Required - The unique identifier of the document. - **format** (string) - Required - The desired format for the document (e.g., json, xml). ### Request Example ``` GET /api/v1/documents/12345.json ``` ### Response #### Success Response (200) - **document** (object) - Contains the details of the Federal Register document. #### Response Example ```json { "document": { "title": "Example Document", "publication_date": "2024-01-01" } } ``` ## GET /documents/{document_numbers}.{format} ### Description Fetch multiple Federal Register documents. ### Method GET ### Endpoint /api/v1/documents/{document_numbers}.{format} ### Parameters #### Path Parameters - **document_numbers** (string) - Required - A comma-separated list of document identifiers. - **format** (string) - Required - The desired format for the documents (e.g., json, xml). ### Request Example ``` GET /api/v1/documents/12345,67890.json ``` ### Response #### Success Response (200) - **documents** (array) - A list of Federal Register documents. #### Response Example ```json { "documents": [ { "title": "Document One", "publication_date": "2024-01-01" }, { "title": "Document Two", "publication_date": "2024-01-02" } ] } ``` ## GET /documents.{format} ### Description Search all Federal Register documents published since 1994. ### Method GET ### Endpoint /api/v1/documents.{format} ### Parameters #### Query Parameters - **query** (string) - Optional - Search terms to filter documents. - **start_date** (string) - Optional - Start date for the search (YYYY-MM-DD). - **end_date** (string) - Optional - End date for the search (YYYY-MM-DD). - **limit** (integer) - Optional - Number of results to return. - **offset** (integer) - Optional - Number of results to skip. - **format** (string) - Required - The desired format for the results (e.g., json, xml). ### Request Example ``` GET /api/v1/documents.json?query=environment&start_date=2023-01-01&end_date=2023-12-31 ``` ### Response #### Success Response (200) - **documents** (array) - A list of matching Federal Register documents. #### Response Example ```json { "documents": [ { "title": "Environmental Protection Rule", "publication_date": "2023-05-15" } ] } ``` ## GET /documents/facets/{facet}.{format} ### Description Fetch counts of matching Federal Register Documents grouped by a facet. ### Method GET ### Endpoint /api/v1/documents/facets/{facet}.{format} ### Parameters #### Path Parameters - **facet** (string) - Required - The facet to group documents by (e.g., agency, document_type). - **format** (string) - Required - The desired format for the counts (e.g., json, xml). #### Query Parameters - **query** (string) - Optional - Search terms to filter documents before grouping. ### Request Example ``` GET /api/v1/documents/facets/agency.json?query=regulation ``` ### Response #### Success Response (200) - **facet_counts** (object) - An object containing counts for each value within the specified facet. #### Response Example ```json { "facet_counts": { "EPA": 150, "USDA": 75 } } ``` ## GET /issues/{publication_date}.{format} ### Description Fetch the document table of contents based on the print edition for a specific publication date. ### Method GET ### Endpoint /api/v1/issues/{publication_date}.{format} ### Parameters #### Path Parameters - **publication_date** (string) - Required - The date of the issue (YYYY-MM-DD). - **format** (string) - Required - The desired format for the table of contents (e.g., json, xml). ### Request Example ``` GET /api/v1/issues/2024-01-01.json ``` ### Response #### Success Response (200) - **table_of_contents** (array) - A list of documents included in the issue. #### Response Example ```json { "table_of_contents": [ { "title": "Notice of Proposed Rulemaking", "document_number": "2024-00001" } ] } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.