GovInfo

opencollection: 1.0.0
info:
  name: GovInfo API
  version: '2.0'
items:
- info:
    name: Search
    type: folder
  items:
  - info:
      name: search
      type: http
    http:
      method: POST
      url: https://api.govinfo.gov/search
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: This service can be used to query the GovInfo search engine and return results that are the equivalent to what is
      returned by the main user interface. You can use field operators, such as congress, publishdate, branch, and others
      to construct complex queries that will return only matching documents. For additional information, please see our <a
      href='https://www.govinfo.gov/features/search-service-overview' target='blank' style='text-decoration:underline'>search
      service overview</a>.
- info:
    name: Related
    type: folder
  items:
  - info:
      name: Get a list of relationships for a given accessId
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/related/:accessId
      params:
      - name: accessId
        value: ''
        type: path
        description: The unique accessId (packageId or granuleId) for a given piece of GovInfo content
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Get a list of relationships for a given accessId
  - info:
      name: Get a list of relationships for a given accessId
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/related/:accessId/:collection
      params:
      - name: accessId
        value: ''
        type: path
        description: The unique accessId (packageId or granuleId) for a given piece of GovInfo content
      - name: collection
        value: ''
        type: path
        description: CollectionCode associated with a given relationshp - e.g. BILLS would display all related Bill Versions
      - name: granuleClass
        value: ''
        type: query
      - name: subGranuleClass
        value: ''
        type: query
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Get a list of relationships for a given accessId
- info:
    name: Published
    type: folder
  items:
  - info:
      name: Retrieve list of packages based on dateIssued value
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/published/:dateIssuedStartDate
      params:
      - name: dateIssuedStartDate
        value: ''
        type: path
        description: The earliest dateIssued requested - YYYY-MM-DD
      - name: offsetMark
        value: ''
        type: query
        description: Indicates starting record for a given request. Use in conjunction with pageSize to paginate through the
          results. For the first request, use * - for subsequent requests, this information will be provided in the nextPage
          field of the current response.
      - name: offset
        value: ''
        type: query
        description: 'This is the starting record you wish to retrieve-- 0 is the first record. This parameter is being deprecated
          and will be removed in the future. Please begin transitioning to use offsetMark instead. For more information see
          the deprecation warning announcement and discussion on this <a href="https://github.com/usgpo/api/issues/187" target="blank">
          GitHub issue (usgpo/api #187) <i class="bi bi-github"></i></a>'
      - name: pageSize
        value: ''
        type: query
        description: The number of records to return for a given request. Max value is 1000
      - name: collection
        value: ''
        type: query
        description: comma-separated list of collections that you are requesting, e.g. https://api.govinfo.gov/published/2019-01-01/2019-12-31?offset=0&pageSize=100&collection=BILLS,BILLSTATUS&api_key=DEMO_KEY
          - see /collections for a list of collections by code and human-readable name.
      - name: congress
        value: ''
        type: query
        description: congress number (e.g. 116)
      - name: docClass
        value: ''
        type: query
        description: 'Filter the results by overarching collection-specific categories. The values vary from collection to
          collection. For example, docClass in BILLS corresponds with Bill Type --e.g. s, hr, hres, sconres. CREC (the Congressional
          Record) has docClass by CREC section: HOUSE, SENATE, DIGEST, and EXTENSIONS'
      - name: billVersion
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories.
      - name: modifiedSince
        value: ''
        type: query
        description: equivalent to the lastModifiedStartDate parameter in the collections service which is based on lastModified-
          allows you to request only packages that have been modified since a given date/time - useful for tracking updates.
          Requires ISO 8601 format -- e.g. 2020-02-28T00:00:00Z
      - name: courtCode
        value: ''
        type: query
      - name: courtType
        value: ''
        type: query
      - name: state
        value: ''
        type: query
      - name: topic
        value: ''
        type: query
      - name: isGLP
        value: ''
        type: query
      - name: natureSuitCode
        value: ''
        type: query
      - name: natureSuit
        value: ''
        type: query
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Retrieve list of packages based on dateIssued value
  - info:
      name: Retrieve list of packages based on dateIssued value range
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/published/:dateIssuedStartDate/:dateIssuedEndDate
      params:
      - name: dateIssuedStartDate
        value: ''
        type: path
        description: The earliest dateIssued requested - YYYY-MM-DD
      - name: dateIssuedEndDate
        value: ''
        type: path
        description: The last dateIssued requested - YYYY-MM-DD
      - name: offsetMark
        value: ''
        type: query
        description: Indicates starting record for a given request. Use in conjunction with pageSize to paginate through the
          results. For the first request, use * - for subsequent requests, this information will be provided in the nextPage
          field of the current response.
      - name: offset
        value: ''
        type: query
        description: 'This is the starting record you wish to retrieve-- 0 is the first record. This parameter is being deprecated
          and will be removed in the future. Please begin transitioning to use offsetMark instead. For more information see
          the deprecation warning announcement and discussion on this <a href="https://github.com/usgpo/api/issues/187" target="blank">
          GitHub issue (usgpo/api #187) <i class="bi bi-github"></i></a>'
      - name: pageSize
        value: ''
        type: query
        description: The number of records to return for a given request. Max value is 1000
      - name: collection
        value: ''
        type: query
        description: comma-separated list of collections that you are requesting, e.g. https://api.govinfo.gov/published/2019-01-01/2019-12-31?offset=0&pageSize=100&collection=BILLS,BILLSTATUS&api_key=DEMO_KEY
          - see /collections for a list of collections by code and human-readable name.
      - name: congress
        value: ''
        type: query
        description: congress number (e.g. 116)
      - name: docClass
        value: ''
        type: query
        description: 'Filter the results by overarching collection-specific categories. The values vary from collection to
          collection. For example, docClass in BILLS corresponds with Bill Type --e.g. s, hr, hres, sconres. CREC (the Congressional
          Record) has docClass by CREC section: HOUSE, SENATE, DIGEST, and EXTENSIONS'
      - name: billVersion
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories.
      - name: modifiedSince
        value: ''
        type: query
        description: equivalent to the lastModifiedStartDate parameter in the collections service which is based on lastModified-
          allows you to request only packages that have been modified since a given date/time - useful for tracking updates.
          Requires ISO 8601 format -- e.g. 2020-02-28T00:00:00Z
      - name: courtCode
        value: ''
        type: query
      - name: courtType
        value: ''
        type: query
      - name: state
        value: ''
        type: query
      - name: topic
        value: ''
        type: query
      - name: natureSuitCode
        value: ''
        type: query
      - name: natureSuit
        value: ''
        type: query
      - name: isGLP
        value: ''
        type: query
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Retrieve list of packages based on dateIssued value range
- info:
    name: Packages
    type: folder
  items:
  - info:
      name: Return json summary for specified package
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/packages/:packageId/summary
      params:
      - name: packageId
        value: ''
        type: path
        description: 'The Package Id. Ex: CREC-2018-01-04'
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Return json summary for specified package
  - info:
      name: Get a list of granules associated with a package
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/packages/:packageId/granules
      params:
      - name: packageId
        value: ''
        type: path
        description: 'The Package Id. Ex: CREC-2018-01-04'
      - name: offsetMark
        value: ''
        type: query
        description: Indicates starting record for a given request. Use in conjunction with pageSize to paginate through the
          results. For the first request, use * - for subsequent requests, this information will be provided in the nextPage
          field of the current response.
      - name: offset
        value: ''
        type: query
        description: 'This is the starting record you wish to retrieve-- 0 is the first record. This parameter is being deprecated
          and will be removed in the future. Please begin transitioning to use offsetMark instead. For more information see
          the deprecation warning announcement and discussion on this <a href="https://github.com/usgpo/api/issues/187" target="blank">
          GitHub issue (usgpo/api #187) <i class="bi bi-github"></i></a>'
      - name: pageSize
        value: ''
        type: query
        description: The number of records to return for a given request. Max value is 1000
      - name: md5
        value: ''
        type: query
        description: md5 hash value of the html content file - can be used to identify changes in individual granules for
          the HOB and CRI collections.
      - name: granuleClass
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories. The values vary from collection to
          collection. For example, For example, granuleClass in CREC corresponds with Congressional Record Section ---e.g.
          . DAILYDIGEST, EXTENSIONS, SENATE, HOUSE
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Get a list of granules associated with a package
  - info:
      name: Return json summary for specified granule
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/packages/:packageId/granules/:granuleId/summary
      params:
      - name: packageId
        value: ''
        type: path
        description: 'The Package Id. Ex: CREC-2018-01-04'
      - name: granuleId
        value: ''
        type: path
        description: The granule ID, e.g. CREC-2018-01-04-pt1-PgD7-2
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Return json summary for specified granule
- info:
    name: Collections
    type: folder
  items:
  - info:
      name: Request list of collections. Response includes collectionCode,collectionName, package and granule counts
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/collections
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Request list of collections. Response includes collectionCode,collectionName, package and granule counts
  - info:
      name: Retrieve new or updated packages for a collection given a start date and time
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/collections/:collection/:lastModifiedStartDate
      params:
      - name: collection
        value: ''
        type: path
        description: The collectionCode that you want to retrieve (e.g. BILLS, CREC, FR, PLAW, USCOURTS)
      - name: lastModifiedStartDate
        value: ''
        type: path
        description: 'This is the start date and time in ISO8601 format (yyyy-MM-dd''T''HH:mm:ss''Z'') Example: 2018-01-28T20:18:10Z'
      - name: offsetMark
        value: ''
        type: query
        description: Indicates starting record for a given request. Use in conjunction with pageSize to paginate through the
          results. For the first request, use * - for subsequent requests, this information will be provided in the nextPage
          field of the current response.
      - name: offset
        value: ''
        type: query
        description: 'This is the starting record you wish to retrieve-- 0 is the first record. This parameter is being deprecated
          and will be removed in the future. Please begin transitioning to use offsetMark instead. For more information see
          the deprecation warning announcement and discussion on this <a href="https://github.com/usgpo/api/issues/187" target="blank">
          GitHub issue (usgpo/api #187) <i class="bi bi-github"></i></a>'
      - name: pageSize
        value: ''
        type: query
        description: The number of records to return for a given request. Max value is 1000
      - name: congress
        value: ''
        type: query
        description: Filters results by Congress, where applicable. For example 113 or 114.
      - name: docClass
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories. The values vary from collection to
          collection. For example, docClass in BILLS corresponds with Bill Type --e.g. s, hr, hres, sconres.
      - name: billVersion
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories.
      - name: courtCode
        value: ''
        type: query
      - name: courtType
        value: ''
        type: query
      - name: state
        value: ''
        type: query
      - name: topic
        value: ''
        type: query
      - name: isGLP
        value: ''
        type: query
      - name: natureSuitCode
        value: ''
        type: query
      - name: natureSuit
        value: ''
        type: query
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Retrieve new or updated packages for a collection given a start date and time
  - info:
      name: Retrieve new or updated packages for a collection within a date range
      type: http
    http:
      method: GET
      url: https://api.govinfo.gov/collections/:collection/:lastModifiedStartDate/:lastModifiedEndDate
      params:
      - name: collection
        value: ''
        type: path
        description: The collectionCode that you want to retrieve (e.g. BILLS, CREC, FR, PLAW, USCOURTS)
      - name: lastModifiedStartDate
        value: ''
        type: path
        description: 'This is the start date and time in ISO8601 format (yyyy-MM-dd''T''HH:mm:ss''Z'') Example: 2018-01-28T20:18:10Z'
      - name: lastModifiedEndDate
        value: ''
        type: path
        description: 'This is the end date and time in ISO8601 format (yyyy-MM-dd''T''HH:mm:ss''Z'') Example: 2018-01-28T20:18:10Z'
      - name: offsetMark
        value: ''
        type: query
        description: Indicates starting record for a given request. Use in conjunction with pageSize to paginate through the
          results. For the first request, use * - for subsequent requests, this information will be provided in the nextPage
          field of the current response.
      - name: offset
        value: ''
        type: query
        description: 'This is the starting record you wish to retrieve-- 0 is the first record. This parameter is being deprecated
          and will be removed in the future. Please begin transitioning to use offsetMark instead. For more information see
          the deprecation warning announcement and discussion on this <a href="https://github.com/usgpo/api/issues/187" target="blank">
          GitHub issue (usgpo/api #187) <i class="bi bi-github"></i></a>'
      - name: pageSize
        value: ''
        type: query
        description: The number of records to return for a given request. Max value is 1000
      - name: docClass
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories. The values vary from collection to
          collection. For example, docClass in BILLS corresponds with Bill Type --e.g. s, hr, hres, sconres.
      - name: congress
        value: ''
        type: query
        description: Filters results by Congress, where applicable. For example 113 or 114.
      - name: billVersion
        value: ''
        type: query
        description: Filter the results by overarching collection-specific categories.
      - name: courtCode
        value: ''
        type: query
      - name: courtType
        value: ''
        type: query
      - name: state
        value: ''
        type: query
      - name: topic
        value: ''
        type: query
      - name: isGLP
        value: ''
        type: query
      - name: natureSuitCode
        value: ''
        type: query
      - name: natureSuit
        value: ''
        type: query
      auth:
        type: apikey
        key: api_key
        value: '{{api_key}}'
        placement: query
    docs: Retrieve new or updated packages for a collection within a date range
bundled: true