/Regulations.Gov.Client

Client for interacting with the Regulations.gov API

Primary LanguageC#MIT LicenseMIT

Regulations.Gov.Client

This is a client to access documents from the Regulations.gov API.

Quickstart

First, sign up for a Data.gov API key. Then, per a change in process as of 24 Jan 2018, request access to the Regulations.gov API at regulations@erulemakinghelpdesk.com.

Add the Regulations.Gov.Client package to your project:

dotnet add package Regulations.Gov.Client

Then use it to query for regulations documents. For example, all public submissions (comments) on "Review of Certain National Monuments Established Since 1996; Notice of Opportunity for Public Comment"

var client = new Regulations.Gov.Client.RegulationsGovClient();
var query = new DocumentsQuery
{
    DocketId = "DOI-2017-0002",
    Type = DocumentType.PublicSubmission,
    ResultsPerPage = 1000,
};
var pageOfResults = await _client.GetDocuments(query);

Building

Travis NuGet

Ensure you have installed .NET Core

To build a local/development cop, run the following:

dotnet restore
dotnet build

To run the tests:

dotnet test

Code of Conduct

We are committed to fostering an open and welcoming environment. Please read our code of conduct before participating in or contributing to this project.

Contributing

We welcome contributions and collaboration on this project. Please read our contributor's guide to understand how best to work with us.

License and Authors

Daniel James logo Daniel James

license GitHub contributors

This software is made available by Daniel James under the MIT license.