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

    Class HouseVoteClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseUrl endpoint

    Methods

    get getHouseRollCallVote getHouseRollCallVoteMembers getHouseRollCallVotes getHouseRollCallVotesByCongress getHouseRollCallVotesByCongressAndSession

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns detailed information for a specified House of Representatives roll call vote. This endpoint is currently in beta.

      Parameters

      • congress: number

        The congress of the vote

      • session: number

        The session of the vote

      • voteNumber: number

        The vote number

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              houseRollCallVote: {
                  amendmentAuthor?: string;
                  amendmentNumber?: string;
                  amendmentType?: HAMDT;
                  congress: number;
                  identifier: number;
                  legislationNumber: string;
                  legislationType?: HR
                  | HJRES
                  | HCONRES
                  | HRES;
                  legislationUrl: string;
                  result: VoteResult;
                  rollCallNumber: number;
                  sessionNumber: 1 | 2;
                  sourceDataURL: string;
                  startDate: string;
                  updateDate: string;
                  votePartyTotal: {
                      nayTotal: number;
                      notVotingTotal: number;
                      party: { name: string; type: string };
                      presentTotal: number;
                      voteParty: string;
                      yeaTotal: number;
                  }[];
                  voteQuestion: VoteQuestion;
                  voteType: VoteType;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      Detailed information for the specified House roll call vote

    • Returns detailed information for how members voted on a specified House of Representatives roll call vote. This endpoint is currently in beta.

      Parameters

      • congress: number

        The congress of the vote

      • session: number

        The session of the vote

      • voteNumber: number

        The vote number

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

        Accepts format parameters

      Returns Promise<
          {
              houseRollCallVoteMemberVotes: {
                  congress: number;
                  identifier: number;
                  legislationNumber: string;
                  legislationType: string;
                  legislationUrl: string;
                  result: VoteResult;
                  results: {
                      bioguideID: string;
                      firstName: string;
                      lastName: string;
                      voteCast: string;
                      voteParty: string;
                      voteState: string;
                  }[];
                  rollCallNumber: number;
                  sessionNumber: 1
                  | 2;
                  sourceDataURL: string;
                  startDate: string;
                  updateDate: string;
                  voteQuestion: string;
                  voteType: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of member votes for the specified House roll call vote

    • Returns House of Representatives roll call vote data from the API. This endpoint is currently in beta.

      Parameters

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              houseRollCallVotes: {
                  amendmentAuthor?: string;
                  amendmentNumber?: string;
                  amendmentType?: HAMDT;
                  congress: number;
                  identifier: number;
                  legislationNumber?: string;
                  legislationType?: HR
                  | HJRES
                  | HCONRES
                  | HRES;
                  legislationUrl: string;
                  result: VoteResult;
                  rollCallNumber: number;
                  sessionNumber: 1 | 2;
                  sourceDataURL: string;
                  startDate: string;
                  updateDate: string;
                  url: string;
                  voteType: VoteType;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of House roll call votes

    • Returns House of Representatives roll call vote data filtered by the specified Congress. This endpoint is currently in beta.

      Parameters

      • congress: number

        The congress to filter by

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              houseRollCallVotes: {
                  amendmentAuthor?: string;
                  amendmentNumber?: string;
                  amendmentType?: HAMDT;
                  congress: number;
                  identifier: number;
                  legislationNumber?: string;
                  legislationType?: HR
                  | HJRES
                  | HCONRES
                  | HRES;
                  legislationUrl: string;
                  result: VoteResult;
                  rollCallNumber: number;
                  sessionNumber: 1 | 2;
                  sourceDataURL: string;
                  startDate: string;
                  updateDate: string;
                  url: string;
                  voteType: VoteType;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of House roll call votes for the specified congress

    • Returns House of Representatives roll call vote data filtered by the specified Congress and session. This endpoint is currently in beta.

      Parameters

      • congress: number

        The congress to filter by

      • session: number

        The session to filter by

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              houseRollCallVotes: {
                  amendmentAuthor?: string;
                  amendmentNumber?: string;
                  amendmentType?: HAMDT;
                  congress: number;
                  identifier: number;
                  legislationNumber?: string;
                  legislationType?: HR
                  | HJRES
                  | HCONRES
                  | HRES;
                  legislationUrl: string;
                  result: VoteResult;
                  rollCallNumber: number;
                  sessionNumber: 1 | 2;
                  sourceDataURL: string;
                  startDate: string;
                  updateDate: string;
                  url: string;
                  voteType: VoteType;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of House roll call votes for the specified congress and session

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods