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

    Class MemberClient

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns the list of legislation cosponsored by a specified congressional member.

      Parameters

      • bioguideId: string

        The bioguide ID of the member

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              cosponsoredLegislation: {
                  congress: number;
                  introducedDate?: string;
                  latestAction: { actionDate: string; actionTime?: string; text: string };
                  number: string;
                  policyArea: { name: string };
                  title: string;
                  type: BillType;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of cosponsored legislation

    • Returns detailed information for a specified congressional member.

      Parameters

      • bioguideId: string

        The bioguide ID of the member

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

        {BaseParams} - Accepts format parameter (json or xml)

      Returns Promise<
          {
              member: {
                  addressInformation?: {
                      city: "Washington";
                      district: "DC";
                      officeAddress?: string;
                      phoneNumber?: string;
                      zipCode?: string;
                  };
                  bioguideId: string;
                  birthYear?: string;
                  cosponsoredLegislation?: { count: number; url: string };
                  currentMember?: boolean;
                  deathYear?: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  directOrderName?: string;
                  district?: number;
                  firstName: string;
                  honorificName?: string;
                  invertedOrderName?: string;
                  lastName?: string;
                  leadership?: { congress: number; current?: boolean; type: string }[];
                  middleName?: string;
                  nickName?: string;
                  officialUrl?: string;
                  party?:
                      | DEMOCRATIC
                      | INDEPENDENT
                      | INDEPENDENT_DEMOCRAT
                      | LIBERTARIAN
                      | REPUBLICAN;
                  partyHistory?: {
                      partyAbbreviation: PartyCode;
                      partyName: PartyName;
                      startYear: number;
                  }[];
                  previousNames?: {
                      directOrderName?: string;
                      endDate?: string;
                      firstName?: string;
                      honorificName?: string;
                      invertedOrderName?: string;
                      lastName?: string;
                      middleName?: string;
                      startDate?: string;
                      suffixName?: string;
                  }[];
                  sponsoredLegislation?: { count: number; url: string };
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  suffixName?: string;
                  terms: {
                      chamber: CongressChamber;
                      congress: number;
                      district?: number;
                      endYear: number;
                      memberType: MemberType;
                      partyCode?: | DEMOCRATIC
                      | INDEPENDENT
                      | INDEPENDENT_DEMOCRAT
                      | LIBERTARIAN
                      | REPUBLICAN;
                      partyName?: | DEMOCRATIC
                      | INDEPENDENT
                      | INDEPENDENT_DEMOCRAT
                      | LIBERTARIAN
                      | REPUBLICAN;
                      startYear: number;
                      stateCode: StateCode;
                      stateName: StateName;
                  }[];
                  updateDate: string;
              };
          } & { rateLimit: RateLimitInfo },
      >

      Detailed information for the specified member

    • Returns a list of congressional members.

      Parameters

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

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

      Returns Promise<
          BasePaginatedResponse & {
              members: {
                  bioguideId: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  district?: null | number;
                  name: string;
                  partyName: PartyName;
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  terms: {
                      item: { chamber: string; endYear?: null
                      | number; startYear: number }[];
                  };
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of congressional members

    • Returns a list of members filtered by congress, state and district. There are instances where a member has been redistricted but previously represented the district you are generating an API request for and, thus, appears in the returned data. If you are looking for ONLY the current member of a particular district, please use the currentMember=True filter to get the most accurate results

      Parameters

      • congress: number

        The congress to filter by

      • stateCode: string

        The state code to filter by

      • district: string

        The district to filter by

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

        {PaginationParams & MemberParams} - Pagination and format parameters. Default is currentMember=true.

      Returns Promise<
          BasePaginatedResponse & {
              members: {
                  bioguideId: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  district?: null | number;
                  name: string;
                  partyName: PartyName;
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  terms: {
                      item: { chamber: string; endYear?: null
                      | number; startYear: number }[];
                  };
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of members for the specified congress, state and district

    • Returns the list of members specified by current Congress. This queries with currentMember=true filter. Docs

      Parameters

      • congress: number

        The congress to filter by

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

        {PaginationParams & MemberParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              members: {
                  bioguideId: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  district?: null | number;
                  name: string;
                  partyName: PartyName;
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  terms: {
                      item: { chamber: string; endYear?: null
                      | number; startYear: number }[];
                  };
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of members for the specified congress

    • Returns the list of members specified by prior Congress. This queries with currentMember=false filter. Docs

      Parameters

      • congress: number

        The congress to filter by

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

        {PaginationParams & MemberParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              members: {
                  bioguideId: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  district?: null | number;
                  name: string;
                  partyName: PartyName;
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  terms: {
                      item: { chamber: string; endYear?: null
                      | number; startYear: number }[];
                  };
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of members for the specified congress

    • Returns a list of members filtered by state.

      Parameters

      • stateCode: string

        The state code to filter by

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

        {PaginationParams & MemberParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              members: {
                  bioguideId: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  district?: null | number;
                  name: string;
                  partyName: PartyName;
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  terms: {
                      item: { chamber: string; endYear?: null
                      | number; startYear: number }[];
                  };
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of members for the specified state

    • Returns a list of members filtered by state and district.

      Parameters

      • stateCode: string

        The state code to filter by

      • district: string

        The district to filter by

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

        {PaginationParams & MemberParams} - Pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              members: {
                  bioguideId: string;
                  depiction?: { attribution?: string; imageUrl?: string };
                  district?: null | number;
                  name: string;
                  partyName: PartyName;
                  state?:
                      | ALABAMA
                      | ALASKA
                      | ARIZONA
                      | ARKANSAS
                      | CALIFORNIA
                      | COLORADO
                      | CONNECTICUT
                      | DELAWARE
                      | DISTRICT_OF_COLUMBIA
                      | FLORIDA
                      | GEORGIA
                      | HAWAII
                      | IDAHO
                      | ILLINOIS
                      | INDIANA
                      | IOWA
                      | KANSAS
                      | KENTUCKY
                      | LOUISIANA
                      | MAINE
                      | MARYLAND
                      | MASSACHUSETTS
                      | MICHIGAN
                      | MINNESOTA
                      | MISSISSIPPI
                      | MISSOURI
                      | MONTANA
                      | NEBRASKA
                      | NEVADA
                      | NEW_HAMPSHIRE
                      | NEW_JERSEY
                      | NEW_MEXICO
                      | NEW_YORK
                      | NORTH_CAROLINA
                      | NORTH_DAKOTA
                      | OHIO
                      | OKLAHOMA
                      | OREGON
                      | PENNSYLVANIA
                      | RHODE_ISLAND
                      | SOUTH_CAROLINA
                      | SOUTH_DAKOTA
                      | TENNESSEE
                      | TEXAS
                      | UTAH
                      | VERMONT
                      | VIRGINIA
                      | WASHINGTON
                      | WEST_VIRGINIA
                      | WISCONSIN
                      | WYOMING;
                  terms: {
                      item: { chamber: string; endYear?: null
                      | number; startYear: number }[];
                  };
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of members for the specified state and district

    • Returns the list of legislation sponsored by a specified congressional member.

      Parameters

      • bioguideId: string

        The bioguide ID of the member

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

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          BasePaginatedResponse & {
              sponsoredLegislation: {
                  congress: number;
                  introducedDate: string;
                  latestAction: { actionDate: string; actionTime?: string; text: string };
                  number: string;
                  policyArea: { name: string };
                  title: string;
                  type: BillType;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of sponsored legislation