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

    Class HearingClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseUrl endpoint

    Methods

    get getHearing getHearings getHearingsByCongress getHearingsByCongressAndChamber

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns detailed information for a specified hearing.

      Parameters

      • congress: number

        The congress of the hearing

      • chamber: Chamber

        The chamber of the hearing

      • jacketNumber: string

        The jacket number of the hearing

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

        {BaseParams} - Accepts format parameters

      Returns Promise<
          {
              hearing: {
                  associatedMeeting: { eventId: string; url: string };
                  chamber: string;
                  citation: string;
                  committees: { name: string; systemCode: string; url: string }[];
                  congress: number;
                  dates: { date: string }[];
                  formats: { type: string; url: string }[];
                  jacketNumber: number;
                  libraryOfCongressIdentifier: string;
                  title: string;
                  updateDate: string;
              };
          } & { rateLimit: RateLimitInfo },
      >

      Detailed information for the specified hearing

    • Returns a list of hearings.

      Parameters

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              hearings: {
                  chamber: string;
                  congress: number;
                  jacketNumber: number;
                  number?: number;
                  part?: number;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of hearings

    • Returns a list of hearings filtered by the specified congress.

      Parameters

      • congress: number

        The congress to filter by

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              hearings: {
                  chamber: string;
                  congress: number;
                  jacketNumber: number;
                  number?: number;
                  part?: number;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of hearings for the specified congress

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

      Parameters

      • congress: number

        The congress to filter by

      • chamber: Chamber

        The chamber to filter by

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

        {PaginationParams} - Pagination parameters

      Returns Promise<
          BasePaginatedResponse & {
              hearings: {
                  chamber: string;
                  congress: number;
                  jacketNumber: number;
                  number?: number;
                  part?: number;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of hearings for the specified congress and chamber

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods