Congress.gov API committee-print API

Returns committee print data from the API

OpenAPI Specification

congress-gov-committee-print-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  description: 'Congress.gov shares its application programming interface (API) with the public to ingest the Congressional data. <a href="sign-up/" target="_blank">Sign up for an API key</a> from api.data.gov that you can use to access web services provided by Congress.gov. To learn more, view our <a href="https://github.com/LibraryOfCongress/api.congress.gov/" target="_blank">GitHub repository</a>.

    '
  title: Congress.gov amendments committee-print API
  version: '3'
servers:
- url: /v3
security:
- ApiKeyAuth: []
tags:
- name: committee-print
  description: Returns committee print data from the API
paths:
  /committee-print:
    get:
      tags:
      - committee-print
      summary: Returns a list of committee prints.
      description: Returns a list of committee prints.
      parameters:
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/fromDateTime'
      - $ref: '#/components/parameters/toDateTime'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitteePrint'
            application/xml:
              schema:
                $ref: '#/components/schemas/CommitteePrint'
        '400':
          description: Invalid status value
  /committee-print/{congress}:
    get:
      tags:
      - committee-print
      summary: Returns a list of committee prints filtered by the specified congress.
      description: Returns a list of committee prints filtered by the specified congress.
      parameters:
      - $ref: '#/components/parameters/congress'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/fromDateTime'
      - $ref: '#/components/parameters/toDateTime'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitteePrint'
            application/xml:
              schema:
                $ref: '#/components/schemas/CommitteePrint'
        '400':
          description: Invalid status value
  /committee-print/{congress}/{chamber}:
    get:
      tags:
      - committee-print
      summary: Returns a list of committee prints filtered by the specified congress and chamber.
      description: Returns a list of committee prints filtered by the specified congress and chamber.
      parameters:
      - $ref: '#/components/parameters/congress'
      - $ref: '#/components/parameters/chamber'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/fromDateTime'
      - $ref: '#/components/parameters/toDateTime'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitteePrint'
            application/xml:
              schema:
                $ref: '#/components/schemas/CommitteePrint'
        '400':
          description: Invalid status value
  /committee-print/{congress}/{chamber}/{jacketNumber}:
    get:
      tags:
      - committee-print
      summary: Returns detailed information for a specified committee print.
      description: Returns detailed information for a specified committee print.
      parameters:
      - $ref: '#/components/parameters/congress'
      - $ref: '#/components/parameters/chamber'
      - $ref: '#/components/parameters/jacketNumber'
      - $ref: '#/components/parameters/format'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitteePrintDetail'
            application/xml:
              schema:
                $ref: '#/components/schemas/CommitteePrintDetail'
        '400':
          description: Invalid status value
  /committee-print/{congress}/{chamber}/{jacketNumber}/text:
    get:
      tags:
      - committee-print
      summary: Returns the list of texts for a specified committee print.
      description: Returns the list of texts for a specified committee print.
      parameters:
      - $ref: '#/components/parameters/congress'
      - $ref: '#/components/parameters/chamber'
      - $ref: '#/components/parameters/jacketNumber'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitteePrintDetailText'
            application/xml:
              schema:
                $ref: '#/components/schemas/CommitteePrintDetailText'
        '400':
          description: Invalid status value
components:
  parameters:
    limit:
      name: limit
      in: query
      description: The number of records returned. The maximum limit is 250.
      required: false
      schema:
        type: integer
    congress:
      name: congress
      in: path
      description: The congress number. For example, can be 117.
      required: true
      schema:
        type: integer
        format: int32
    jacketNumber:
      name: jacketNumber
      in: path
      description: The jacket number for the print. For example, the value can be 48144.
      required: true
      schema:
        type: integer
    offset:
      name: offset
      in: query
      description: The starting record returned. 0 is the first record.
      required: false
      schema:
        type: integer
    format:
      name: format
      in: query
      description: The data format. Value can be xml or json.
      required: false
      schema:
        type: string
        default: xml
        enum:
        - xml
        - json
    toDateTime:
      name: toDateTime
      in: query
      description: 'The ending timestamp to filter by update date. Use format: YYYY-MM-DDT00:00:00Z.'
      required: false
      schema:
        type: string
    chamber:
      name: chamber
      in: path
      description: The chamber name. Value can be house, senate, or joint.
      required: true
      schema:
        type: string
        enum:
        - house
        - senate
        - joint
    fromDateTime:
      name: fromDateTime
      in: query
      description: 'The starting timestamp to filter by update date. Use format: YYYY-MM-DDT00:00:00Z.'
      required: false
      schema:
        type: string
  schemas:
    CommitteePrint:
      type: array
      items:
        $ref: '#/components/schemas/committeePrints'
    committeePrintText:
      type: object
      properties:
        type:
          type: string
          example: Formatted Text
        url:
          type: string
          format: url
          example: https://www.congress.gov/117/cprt/HPRT48144/CPRT-117HPRT48144.htm
    CommitteePrintDetail:
      type: object
      properties:
        associatedBills:
          type: array
          items:
            $ref: '#/components/schemas/associatedBill'
        chamber:
          type: string
          example: House
        citation:
          type: string
          example: 117-62
        committees:
          type: array
          items:
            $ref: '#/components/schemas/committeePrintCommittees'
        congress:
          type: integer
          example: 117
        jacketNumber:
          type: integer
          example: 48144
        text:
          type: object
          properties:
            count:
              type: integer
              example: 4
            url:
              type: string
              format: url
              example: https://api.congress.gov/v3/committee-print/117/house/48144/text?format=json
        number:
          type: string
          example: '62'
        title:
          type: string
          example: RULES COMMITTEE PRINT 117-62 TEXT OF H.R. 5768, VIOLENT INCIDENT CLEAR- ANCE AND TECHNOLOGICAL INVESTIGATIVE METHODS ACT OF 2022
        updateDate:
          type: string
          format: date-time
          example: '2022-08-01 21:19:33+00:00'
    associatedBill:
      type: object
      properties:
        congress:
          type: integer
          example: 116
        number:
          type: string
          example: '6395'
        type:
          type: string
          example: HR
        url:
          type: string
          format: url
          example: https://api.congress.gov/v3/bill/116/hr/6395?format=json
    committeePrints:
      type: object
      properties:
        chamber:
          type: string
          example: House
        congress:
          type: integer
          example: 117
        jacketNumber:
          type: integer
          example: 48144
        updateDate:
          type: string
          format: date-time
          example: '2022-08-01 21:19:33+00:00'
        url:
          type: string
          format: url
          example: https://api.congress.gov/v3/committee-print/117/house/48144?format=json
    committeePrintCommittees:
      type: object
      properties:
        name:
          type: string
          example: Rules Committee
        systemCode:
          type: string
          example: hsru00
        url:
          type: string
          format: url
          example: https://api.congress.gov/v3/committee/house/hsru00?format=json
    CommitteePrintDetailText:
      type: array
      items:
        $ref: '#/components/schemas/committeePrintText'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: api_key