gpo_collections {govinfoR}R Documentation

Retrieve GPO collections data

Description

The following params correspond to those listed in the GovInfo API documentation], but the offset param is not supported. GovInfo documentation indicates that it was to be deprecated in December, 2022, and though it is still available through the API, the offsetMark parameter is supported instead. Parameter descriptions are adapted from GovInfo API documentation.

Usage

gpo_collections(
  collection = NULL,
  start_date = NULL,
  end_date = NULL,
  page_size = 10,
  doc_class = NULL,
  congress = NULL,
  bill_version = NULL,
  court_code = NULL,
  court_type = NULL,
  state = NULL,
  topic = NULL,
  is_glp = NULL,
  nature_suit_code = NULL,
  nature_suit = NULL,
  offset_mark = "*"
)

Arguments

collection

The collectionCode that you want to retrieve (e.g. BILLS, CREC, FR, PLAW, USCOURTS)

start_date

ISO8601 date and time formatted string (yyyy-MM-dd'T'HH:mm:ss'Z') Example: 2018-01-28T20:18:10Z

end_date

ISO8601 date and time formatted string (yyyy-MM-dd'T'HH:mm:ss'Z') Example: 2018-01-28T20:18:10Z

page_size

The number of records to return for a given request.

doc_class

Filter by collection-specific categories, which vary among collections.

congress

Filter by Congress, e.g., 116, 117

bill_version

Specific to the BILLS collection. Filter by bill text version code.

court_code

USCOURTScollection specific.

court_type

USCOURTS collection specific.

state

Collection specific.

topic

Collection specific.

is_glp

Collection specific.

nature_suit_code

Collection specific.

nature_suit

Collection specific.

offset_mark

Indicates starting record for a given request.

Details

Calling gpo_collections() without specifying a collection returns metadata about all collections.

Value

A tibble

Examples



gpo_collections(collection = "BILLS", start_date = "2024-02-17T00:00:00Z")
gpo_collections()


[Package govinfoR version 0.0.3 Index]