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

    Class SummariesClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseUrl endpoint

    Methods

    get getSummaries getSummariesByCongress getSummariesByCongressAndType

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns a list of summaries sorted by date of last update.

      Parameters

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

        {PaginationParams & DateFilterParams & SortParams} - Accepts pagination, date range filter, sort, and format parameter (json or xml)

      Returns Promise<
          BasePaginatedResponse & {
              summaries: {
                  actionDate: string;
                  actionDesc: string;
                  bill: {
                      congress: number;
                      number: string;
                      originChamber: string;
                      originChamberCode: string;
                      title: string;
                      type: BillType;
                      updateDateIncludingText: string;
                      url: string;
                  };
                  currentChamber: string;
                  currentChamberCode: string;
                  lastSummaryUpdateDate: string;
                  text: string;
                  updateDate: string;
                  versionCode: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of summaries sorted by date of last update

    • Returns a list of summaries filtered by congress, sorted by date of last update.

      Parameters

      • congress: number

        The Congress number (e.g., 117)

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

        {PaginationParams & DateFilterParams & SortParams} - Accepts pagination, date range filter, sort, and format parameter (json or xml)

      Returns Promise<
          BasePaginatedResponse & {
              summaries: {
                  actionDate: string;
                  actionDesc: string;
                  bill: {
                      congress: number;
                      number: string;
                      originChamber: string;
                      originChamberCode: string;
                      title: string;
                      type: BillType;
                      updateDateIncludingText: string;
                      url: string;
                  };
                  currentChamber: string;
                  currentChamberCode: string;
                  lastSummaryUpdateDate: string;
                  text: string;
                  updateDate: string;
                  versionCode: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      List of summaries filtered by congress, sorted by date of last update

    • Returns a list of summaries filtered by congress and by bill type, sorted by date of last update.

      Parameters

      • congress: number

        The Congress number (e.g., 117)

      • billType: BillType

        The type of bill (e.g., hr, s, hjres, sjres)

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

        {PaginationParams & DateFilterParams & SortParams} - Accepts pagination, date range filter, sort, and format parameter (json or xml)

      Returns Promise<
          BasePaginatedResponse & {
              summaries: {
                  actionDate: string;
                  actionDesc: string;
                  bill: {
                      congress: number;
                      number: string;
                      originChamber: string;
                      originChamberCode: string;
                      title: string;
                      type: BillType;
                      updateDateIncludingText: string;
                      url: string;
                  };
                  currentChamber: string;
                  currentChamberCode: string;
                  lastSummaryUpdateDate: string;
                  text: string;
                  updateDate: string;
                  versionCode: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      List of summaries filtered by congress and bill type, sorted by date of last update

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods