Class CongressClient

Hierarchy (View Summary)

BaseClient
- CongressClient

Index

Constructors

constructor

new CongressClient(__namedParameters: { apiKey: string }): CongressClient
Parameters
- __namedParameters: { apiKey: string }
Returns CongressClient
Overrides BaseClient.constructor
- Defined in src/clients/congress.ts:34

Properties

`Protected` `Readonly`apiKey

apiKey: string

`Protected` `Readonly`baseUrl

baseUrl: string

`Protected` `Readonly`endpoint

endpoint: string

Methods

`Protected`get

get<T>(
endpoint: string,
params: Params,
): Promise<T & { rateLimit: RateLimitInfo }>
Type Parameters
- T
Parameters
- endpoint: string
- params: Params
Returns Promise<T & { rateLimit: RateLimitInfo }>
Inherited from BaseClient.get
- Defined in src/clients/base.ts:78

getCongress

getCongress(
    congress: number,
    params?: { format?: Format },
): Promise<
    {
        congress: {
            endYear: string;
            name: string;
            number: number;
            sessions: {
                chamber: CongressChamber;
                endDate?: string;
                number: number;
                startDate: string;
                type: Session;
            }[];
            startYear: string;
            updateDate: string;
            url: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for a specified congress.
Parameters
- congress: number
  The Congress number (e.g., 117)
- params: { format?: Format } = {}
  BaseParams - Accepts format parameter (json or xml)
Returns Promise<
    {
        congress: {
            endYear: string;
            name: string;
            number: number;
            sessions: {
                chamber: CongressChamber;
                endDate?: string;
                number: number;
                startDate: string;
                type: Session;
            }[];
            startYear: string;
            updateDate: string;
            url: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Congress Detail information for the specified congress
- Defined in src/clients/congress.ts:53

getCongresses

getCongresses(
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    BasePaginatedResponse & {
        congresses: {
            endYear: string;
            name: string;
            sessions: {
                chamber: CongressChamber;
                endDate?: string;
                number?: number;
                startDate: string;
                type: Session;
            }[];
            startYear: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of congresses and congressional sessions.
Parameters
- params: { format?: Format; limit?: number; offset?: number } = {}
  PaginationParams - Pagination and format parameters
Returns Promise<
    BasePaginatedResponse & {
        congresses: {
            endYear: string;
            name: string;
            sessions: {
                chamber: CongressChamber;
                endDate?: string;
                number?: number;
                startDate: string;
                type: Session;
            }[];
            startYear: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of congresses and their sessions
- Defined in src/clients/congress.ts:43

getCurrentCongress

getCurrentCongress(
    params?: { format?: Format },
): Promise<
    {
        congress: {
            endYear: string;
            name: string;
            number: number;
            sessions: {
                chamber: CongressChamber;
                endDate?: string;
                number: number;
                startDate: string;
                type: Session;
            }[];
            startYear: string;
            updateDate: string;
            url: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for the current congress.
Parameters
- params: { format?: Format } = {}
  BaseParams - Accepts format parameter (json or xml)
Returns Promise<
    {
        congress: {
            endYear: string;
            name: string;
            number: number;
            sessions: {
                chamber: CongressChamber;
                endDate?: string;
                number: number;
                startDate: string;
                type: Session;
            }[];
            startYear: string;
            updateDate: string;
            url: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Congress Detail information for the current congress
- Defined in src/clients/congress.ts:62

Class CongressClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CongressClient

Properties

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

Methods

`Protected`get

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getCongress

Parameters

getCongresses

Parameters

getCurrentCongress

Parameters

Settings

On This Page

Class CongressClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CongressClient

Properties

Protected ReadonlyapiKey

Protected ReadonlybaseUrl

Protected Readonlyendpoint

Methods

Protectedget

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getCongress

Parameters

Returns Promise< { congress: { endYear: string; name: string; number: number; sessions: { chamber: CongressChamber; endDate?: string; number: number; startDate: string; type: Session; }[]; startYear: string; updateDate: string; url: string; }; } & { rateLimit: RateLimitInfo },>

getCongresses

Parameters

Returns Promise< BasePaginatedResponse & { congresses: { endYear: string; name: string; sessions: { chamber: CongressChamber; endDate?: string; number?: number; startDate: string; type: Session; }[]; startYear: string; updateDate: string; url: string; }[]; } & { rateLimit: RateLimitInfo },>

getCurrentCongress

Parameters

Returns Promise< { congress: { endYear: string; name: string; number: number; sessions: { chamber: CongressChamber; endDate?: string; number: number; startDate: string; type: Session; }[]; startYear: string; updateDate: string; url: string; }; } & { rateLimit: RateLimitInfo },>

Settings

On This Page

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

`Protected`get

Returns Promise<
{
congress: {
endYear: string;
name: string;
number: number;
sessions: {
chamber: CongressChamber;
endDate?: string;
number: number;
startDate: string;
type: Session;
}[];
startYear: string;
updateDate: string;
url: string;
};
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
BasePaginatedResponse & {
congresses: {
endYear: string;
name: string;
sessions: {
chamber: CongressChamber;
endDate?: string;
number?: number;
startDate: string;
type: Session;
}[];
startYear: string;
updateDate: string;
url: string;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
congress: {
endYear: string;
name: string;
number: number;
sessions: {
chamber: CongressChamber;
endDate?: string;
number: number;
startDate: string;
type: Session;
}[];
startYear: string;
updateDate: string;
url: string;
};
} & { rateLimit: RateLimitInfo },
>