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

    Class BoundCongressionalRecordClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseUrl endpoint

    Methods

    get getRecords getRecordsByDate getRecordsByYear getRecordsByYearAndMonth

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns a list of bound Congressional Records sorted by most recent.

      Parameters

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

        {PaginationParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              boundCongressionalRecord: {
                  congress: number;
                  date: string;
                  sessionNumber: 1
                  | 2;
                  updateDate: string;
                  url: string;
                  volumeNumber: number;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of bound Congressional Records

    • Returns a list of bound Congressional Records filtered by the specified year, month, and day.

      Parameters

      • year: string

        The year to filter by

      • month: string

        The month to filter by (01-12)

      • day: string

        The day to filter by (01-31)

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

        {PaginationParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              boundCongressionalRecord: {
                  congress: number;
                  dailyDigest?: {
                      endPage: number;
                      startPage: number;
                      text: { type: string; url: string }[];
                  };
                  date: string;
                  sections: { endPage: number; name: string; startPage: number }[];
                  sessionNumber: 1 | 2;
                  updateDate: string;
                  volumeNumber: number;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of bound Congressional Records for the specified date

    • Returns a list of bound Congressional Records filtered by the specified year.

      Parameters

      • year: string

        The year to filter by

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

        {PaginationParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              boundCongressionalRecord: {
                  congress: number;
                  date: string;
                  sessionNumber: 1
                  | 2;
                  updateDate: string;
                  url: string;
                  volumeNumber: number;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of bound Congressional Records for the specified year

    • Returns a list of bound Congressional Records filtered by the specified year and month.

      Parameters

      • year: string

        The year to filter by

      • month: string

        The month to filter by (01-12)

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

        {PaginationParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              boundCongressionalRecord: {
                  congress: number;
                  date: string;
                  sessionNumber: 1
                  | 2;
                  updateDate: string;
                  url: string;
                  volumeNumber: number;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of bound Congressional Records for the specified year and month

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods