@datafire/data_gov

Client library for Regulations.gov

Installation and Usage

npm install --save @datafire/data_gov

let data_gov = require('@datafire/data_gov').create({
  api_key: ""
});

.then(data => {
  console.log(data);
});

Description

Provides public users access to federal regulatory content.

Actions

docket

Returns Docket information

data_gov.docket({
  "response_format": "",
  "docketId": ""
}, context)

Input

• input object
  • response_format required string (values: json, xml): Format
  • docketId required string: Docket ID

Output

Output schema unknown

document

Returns Document information

data_gov.document({
  "response_format": ""
}, context)

Input

• input object
  • response_format required string (values: json, xml): Format
  • documentId string: FDMS Document ID
  • federalRegisterNumber string: Federal Register Document Number

Output

Output schema unknown

documents

This API allows users to build a query based on any of the parameters below. If you have trouble building queries, you may wish to try them through the Advanced Search page on the Regulations.gov website.

data_gov.documents({
  "response_format": ""
}, context)

Input

• input object
  • response_format required string (values: json, xml): Format
  • countsOnly integer (values: 0, 1): Counts Only: 1 (will return only the document count for a search query)0 (will return documents as well)
  • encoded integer (values: 0, 1): Encoded: 1 (will accept Regulations.gov style encoded parameters)0 (will not accept such encoded parameters)
  • s string: Keyword(s)
  • dct string (values: N, PR, FR, O, SR, PS): Document Type: N: NoticePR: Proposed RuleFR: RuleO: OtherSR: Supporting & Related MaterialPS: Public Submission
  • dktid string: Valid Docket ID (ex. SEC-2012-0044)
  • dkt string (values: N, R): Docket Type: R: RulemakingN: NonrulemakingA Docket Type is either Rulemaking or Nonrulemaking. A Rulemaking docket includes the type of regulation that establishes a rule. While a Non-Rulemaking docket does not include a rule.
  • cp string (values: O, C): Comment Period: O: OpenC: Closed
  • a string: Federal Agency: List of accepted Federal Agency values. This field allows multiple values. Ex. a=FMCSA%252BEPA%252BFDA
  • rpp string (values: 10, 25, 100, 500, 1000): Results Per Page 10, 25, 100, 500, 1,000. Results per page may not exceed 1,000.
  • po integer: Enter the page offset (always starts with 0). This is used in conjunction with results per page to provide large data sets. For example, if a search produces 82 results and the result per page is set to 25, this will generate 4 pages. 3 pages will have 25 results and the last page will have 7 results. Page offset values for each page will be: Page 1: po=0 Page 2: po=25 Page 3: po=50 Page 4: po=75 The total number of pages is [total results/results per page] and page offset for page X is [X-1 * results per page]
  • cs integer (values: 0, 3, 15, 30, 90): Comment Period Closing Soon: 0 (closing today)3 (closing within 3 days)15 (closing within 15 days)30 (closing within 30 days)90 (closing within 90 days)
  • np integer (values: 0, 3, 15, 30, 90): Newly Posted: 0 (posted today)3 (posted within last 3 days)15 (posted within last 15 days)30 (posted within last 30 days)90 (posted within last 90 days) For periods of time beyond 90-days, please use a date range with the Posted Date parameter.
  • cmsd string: Comment Period Start Date: Enter a date in the form of MM/DD/YY. Note: If the Comment Period End Date is also provided, then ensure the Comment Period Start date is earlier.
  • cmd string: Comment Period End Date: Enter a date in the form of MM/DD/YY. Note: If the Comment Period Start Date is also provided, then ensure the Comment Period End date is after.* Comment Period Start and End Dates are mutually exclusive with the 'closing soon' parameter. If both are provided, 'closing soon' will be ignored.
  • crd string: Creation Date: Enter a date in the form of MM/DD/YY. Accepts a single date or a date range. Ex. crd=11/06/13-03/06/14
  • rd string: Received Date: Enter a date in the form of MM/DD/YY. Accepts a single date or a date range. Ex. rd=11/06/13-03/06/14
  • pd string: Posted Date: Enter a date in the form of MM/DD/YY. Accepts a single date or a date range. Ex. pd=11/06/13-03/06/14
  • cat string (values: AD, AEP, BFS, CT, LES, EELS, EUMM, HCFP, PRE, ITT): Document Category: AD (Aerospace and Transportation) AEP (Agriculture, Environment, and Public Lands) BFS (Banking and Financial) CT (Commerce and International) LES (Defense, Law Enforcement, and Security) EELS (Education, Labor, Presidential, and Government Services) EUMM (Energy, Natural Resources, and Utilities) HCFP (Food Safety, Health, and Pharmaceutical) PRE (Housing, Development, and Real Estate) ITT (Technology and Telecommunications)
  • sb string (values: docketId, docId, title, postedDate, agency, documentType, submitterName, organization): Sort By: docketId (Docket ID)docId (Document ID)title (Title)postedDate (Posted Date)agency (Agency)documentType (Document Type)submitterName (Submitter Name)organization (Organization) Sort Order is REQUIRED if this parameter is included.
  • so string (values: ASC, DESC): Sort Order: ASC: AscendingDESC: Descending
  • dktst string: Docket Subtype: Only one docket subtype at a time may be selected. One or more agency values must be part of the request. Only values valid for the selected agency will be returned.
  • dktst2 string: Docket Sub-subtype: Only one docket sub-subtype at a time may be selected. One or more agency values must be part of the request. Only values valid for the selected agency will be returned.
  • docst string: Document Subtype: Single or multiple document subtypes may be included. Multiple values should be passed as follows: docst=%20Certificate+of+Service%252BCorrespondence

Output

Output schema unknown

Definitions

This integration has no definitions