Custom Connector
Federal Register Connector
US
The Federal Register Connector integrates with the Federal Register API, providing access to published documents, public-inspection documents, agency details, images, and suggested searches. It acts as a proxy for fetching individual or multiple documents, searching, retrieving issue tables of contents, and accessing agency and search metadata — in JSON, XML, and CSV, optimized for GCP.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Federal Register Connector.
- getDocument / getMultipleDocuments. Fetch a single or multiple Federal Register documents by document number.
- searchDocuments. Search all Federal Register documents with various conditions.
- getFacetCounts. Retrieve counts of documents grouped by a specified facet.
- getIssueTOC. Fetch the table of contents for a specific Federal Register issue.
- getPublicInspectionDocument / getMultiple / getCurrent. Fetch single, multiple, or all current public-inspection documents.
- searchPublicInspectionDocuments. Search all public-inspection documents.
- getAllAgencies / getAgency. Retrieve details for all agencies or a specific agency by slug.
- getImage. Retrieve image variants and metadata by identifier.
- getSuggestedSearches / getSuggestedSearch. Fetch all suggested searches or a specific one by slug.
Documentation
Detailed Integration Documentation
Single Document Retrieval
| Action | getDocument |
|---|---|
| Purpose | Retrieves metadata and details for a specific Federal Register document by document number. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: document_number (e.g. 2019-24499); format (json, xml, csv). Optional: fields[] — fields to include (e.g. title,abstract). |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Multiple Documents Retrieval
| Action | getMultipleDocuments |
|---|---|
| Purpose | Retrieves details for multiple documents by document numbers — batch processing. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: document_numbers — comma-separated (e.g. 2019-24499,2019-24500); format (json, xml, csv). Optional: fields[]. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Document Search
| Action | searchDocuments |
|---|---|
| Purpose | Searches all Federal Register documents with conditions (type, agency, date, term, president, docket). |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: format (json, xml, csv). Optional: fields[]; per_page (default 20, max 1000); page; order (relevance, newest, oldest, executive_order_number); conditions[type]; conditions[agency_ids][]; conditions[publication_date][year|gte|lte]; conditions[term]; conditions[president]; conditions[presidential_document_type]; conditions[docket_id]. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Facet Counts
| Action | getFacetCounts |
|---|---|
| Purpose | Retrieves counts of documents grouped by a facet (e.g. agency, type). |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: facet (e.g. agency, type). Optional: conditions[type]; conditions[agency_ids][]; conditions[publication_date][year]. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Issue Table of Contents
| Action | getIssueTOC |
|---|---|
| Purpose | Retrieves the table of contents for a specific Federal Register issue. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: publication_date (YYYY-MM-DD, e.g. 2023-01-01); format (json, xml, csv). |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Single Public-Inspection Document
| Action | getPublicInspectionDocument |
|---|---|
| Purpose | Retrieves metadata and a PDF link for a specific public-inspection document. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: document_number; format (json, xml, csv). Optional: fields[]. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Multiple Public-Inspection Documents
| Action | getMultiplePublicInspectionDocuments |
|---|---|
| Purpose | Retrieves details for multiple public-inspection documents — batch processing. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: document_numbers — comma-separated; format (json, xml, csv). Optional: fields[]. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Current Public-Inspection Documents
| Action | getCurrentPublicInspectionDocuments |
|---|---|
| Purpose | Retrieves all current public-inspection documents — monitoring recent filings. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: format (json, xml, csv). Optional: fields[]; per_page (default 20); page. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Public-Inspection Search
| Action | searchPublicInspectionDocuments |
|---|---|
| Purpose | Searches all public-inspection documents. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: format (json, xml, csv). Optional: fields[]; per_page; page; order (relevance, newest, oldest). |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
All Agencies
| Action | getAllAgencies |
|---|---|
| Purpose | Retrieves details for all federal agencies listed in the Federal Register. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Optional: fields[] (e.g. name,slug). |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Single Agency
| Action | getAgency |
|---|---|
| Purpose | Retrieves details for a specific agency by slug. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: slug (e.g. environmental-protection-agency). Optional: fields[] (e.g. name,description). |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Image Retrieval
| Action | getImage |
|---|---|
| Purpose | Retrieves image variants and metadata by identifier. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: identifier. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Suggested Searches
| Action | getSuggestedSearches |
|---|---|
| Purpose | Retrieves all suggested searches, optionally filtered by section. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Optional: section — Federal Register section filter. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Single Suggested Search
| Action | getSuggestedSearch |
|---|---|
| Purpose | Retrieves details for a specific suggested search by slug. |
| Configuration | Configure the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP, deploy in a Cloud Function or Cloud Run service. |
| Parameters | Required: slug. |
| Output | Successful: JSON/XML/CSV with the requested document(s) or metadata. Failure: error details (e.g. 404 not found, 400 invalid parameters). |
Example Workflow: Regulatory Document Analysis
| Retrieve agency information | Use getAllAgencies to identify agencies of interest (e.g. environmental-protection-agency). |
|---|---|
| Search relevant documents | Execute searchDocuments with format=json, conditions[agency_ids][] for selected agencies, and conditions[type]=RULE. |
| Export & analyze | Use getDocument with document_number and format=csv, store CSVs in Cloud Storage, and analyze in BigQuery. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.