congress-dot-gov - v0.4.3
    Preparing search index...

    Class CommitteeReportClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseUrl endpoint

    Methods

    get getCommitteeReports getReports getReportsByCongress getReportsByCongressAndChamber getReportTexts

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns detailed information for a specified committee report.

      Parameters

      • congress: number

        The congress of the report

      • reportType: CommitteeReportType

        The type of the report

      • reportNumber: string

        The report number

      • params: { format?: Format } = {}

        {BaseParams} - Accepts format parameters

      Returns Promise<
          {
              committeeReports: {
                  associatedBill: {
                      congress: number;
                      number: string;
                      type: string;
                      url: string;
                  }[];
                  associatedTreaties?: {
                      congress: number;
                      number: string;
                      part: string;
                      url: string;
                  }[];
                  chamber: Chamber;
                  citation: string;
                  committees?: {
                      congress: number;
                      number: string;
                      part: string;
                      url: string;
                  }[];
                  congress: number;
                  isConferenceReport: boolean;
                  issueDate: string;
                  number: number;
                  part: number;
                  reportType: CommitteeReportReportType;
                  sessionNumber: 1
                  | 2;
                  text: { count: number; url: string };
                  title: string;
                  type: CommitteeReportType;
                  updateDate: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      Detailed information for the specified committee report

    • Returns a list of committee reports.

      Parameters

      • params: { format?: Format; limit?: number; offset?: number } & DateFilterParams & {
            conference?: boolean;
        } = {}

        {PaginationParams & DateFilterParams & { conference: boolean}} - Accepts pagination, date range, and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              reports: {
                  chamber: Chamber;
                  citation: string;
                  congress: number;
                  number: number;
                  part?: number;
                  type: CommitteeReportType;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of committee reports

    • Returns a list of committee reports filtered by the specified congress.

      Parameters

      • congress: number

        The congress to filter by

      • params: { format?: Format; limit?: number; offset?: number } & DateFilterParams & {
            conference?: boolean;
        } = {}

        {PaginationParams & DateFilterParams & { conference: boolean}} - Accepts pagination, date range, and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              reports: {
                  chamber: Chamber;
                  citation: string;
                  congress: number;
                  number: number;
                  part?: number;
                  type: CommitteeReportType;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of committee reports for the specified congress

    • Returns a list of committee reports filtered by the specified congress and chamber.

      Parameters

      • congress: number

        The congress to filter by

      • reportType: CommitteeReportType

        The type of the report

      • params: { format?: Format; limit?: number; offset?: number } & DateFilterParams & {
            conference?: boolean;
        } = {}

        {PaginationParams & DateFilterParams & { conference: boolean}} - Accepts pagination, date range, and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              reports: {
                  chamber: Chamber;
                  citation: string;
                  congress: number;
                  number: number;
                  part?: number;
                  type: CommitteeReportType;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of committee reports for the specified congress and chamber

    • Returns the list of texts for a specified committee report.

      Parameters

      • congress: number

        The congress of the report

      • reportType: CommitteeReportType

        The type of the report

      • reportNumber: string

        The report number

      • params: { format?: Format; limit?: number; offset?: number } = {}

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              text: {
                  formats: {
                      isErrata: "Y"
                      | "N";
                      type: CommitteeReportFormat;
                      url: string;
                  }[];
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of report texts

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods