@datafire/google_civicinfo NPM

@datafire/google_civicinfo

Client library for Google Civic Information API

Installation and Usage

npm install --save @datafire/google_civicinfo

let google_civicinfo = require('@datafire/google_civicinfo').create();

.then(data => {
  console.log(data);
});

Description

Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.

Actions

civicinfo.divisions.search

Searches for political divisions by their natural name or OCD ID.

google_civicinfo.civicinfo.divisions.search({}, context)

Input

input object
- query string: The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output DivisionSearchResponse

civicinfo.elections.electionQuery

List of available elections to query.

google_civicinfo.civicinfo.elections.electionQuery({}, context)

Input

input object
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ElectionsQueryResponse

civicinfo.representatives.representativeInfoByAddress

Looks up political geography and representative information for a single address.

google_civicinfo.civicinfo.representatives.representativeInfoByAddress({}, context)

Input

input object
- address string: The address to look up. May only be specified if the field ocdId is not given in the URL
- includeOffices boolean: Whether to return information about offices and officials. If false, only the top-level district information will be returned.
- levels array: A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
- roles array: A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output RepresentativeInfoResponse

civicinfo.representatives.representativeInfoByDivision

Looks up representative information for a single geographic division.

google_civicinfo.civicinfo.representatives.representativeInfoByDivision({
  "ocdId": ""
}, context)

Input

input object
- ocdId required string: The Open Civic Data division identifier of the division to look up.
- levels array: A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don't contain a matching office will not be returned.
- recursive boolean: If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC's wards and ANCs.
- roles array: A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output RepresentativeInfoData

civicinfo.elections.voterInfoQuery

Looks up information relevant to a voter based on the voter's registered address.

google_civicinfo.civicinfo.elections.voterInfoQuery({
  "address": ""
}, context)

Input

input object
- address required string: The registered address of the voter to look up.
- electionId string: The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/elections. If no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.
- officialOnly boolean: If set to true, only data from official state sources will be returned.
- returnAllAvailableData boolean: If set to true, the query will return the success code and include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output VoterInfoResponse

Definitions

AdministrationRegion

AdministrationRegion object: Describes information about a regional election administrative area.
- electionAdministrationBody AdministrativeBody
- local_jurisdiction AdministrationRegion
- name string: The name of the jurisdiction.
- sources array: A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
  - items Source

AdministrativeBody

AdministrativeBody object: Information about an election administrative body (e.g. County Board of Elections).
- absenteeVotingInfoUrl string: A URL provided by this administrative body for information on absentee voting.
- ballotInfoUrl string: A URL provided by this administrative body to give contest information to the voter.
- correspondenceAddress SimpleAddressType
- electionInfoUrl string: A URL provided by this administrative body for looking up general election information.
- electionNoticeText string: A last minute or emergency notification text provided by this administrative body.
- electionNoticeUrl string: A URL provided by this administrative body for additional information related to the last minute or emergency notification.
- electionOfficials array: The election officials for this election administrative body.
  - items ElectionOfficial
- electionRegistrationConfirmationUrl string: A URL provided by this administrative body for confirming that the voter is registered to vote.
- electionRegistrationUrl string: A URL provided by this administrative body for looking up how to register to vote.
- electionRulesUrl string: A URL provided by this administrative body describing election rules to the voter.
- hoursOfOperation string: A description of the hours of operation for this administrative body.
- name string: The name of this election administrative body.
- physicalAddress SimpleAddressType
- voter_services array: A description of the services this administrative body may provide.
  - items string
- votingLocationFinderUrl string: A URL provided by this administrative body for looking up where to vote.

Candidate

Candidate object: Information about a candidate running for elected office.
- candidateUrl string: The URL for the candidate's campaign web site.
- channels array: A list of known (social) media channels for this candidate.
  - items Channel
- email string: The email address for the candidate's campaign.
- name string: The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan"
- orderOnBallot string: The order the candidate appears on the ballot for this contest.
- party string: The full name of the party the candidate is a member of.
- phone string: The voice phone number for the candidate's campaign office.
- photoUrl string: A URL for a photo of the candidate.

Channel

Channel object: A social media or web channel for a candidate.
- id string: The unique public identifier for the candidate's channel.
- type string: The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter

Contest

Contest object: Information about a contest that appears on a voter's ballot.
- ballotPlacement string: A number specifying the position of this contest on the voter's ballot.
- ballotTitle string: The official title on the ballot for this contest, only where available.
- candidates array: The candidate choices for this contest.
  - items Candidate
- district ElectoralDistrict
- electorateSpecifications string: A description of any additional eligibility requirements for voting in this contest.
- level array: The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
  - items string (values: international, country, administrativeArea1, regional, administrativeArea2, locality, subLocality1, subLocality2, special)
- numberElected string: The number of candidates that will be elected to office in this contest.
- numberVotingFor string: The number of candidates that a voter may vote for in this contest.
- office string: The name of the office for this contest.
- primaryParties array: If this is a partisan election, the name of the party/parties it is for.
  - items string
- primaryParty string: DEPRECATED If this is a partisan election, the name of the party it is for. This field as deprecated in favor of the array "primaryParties", as contests may contain more than one party.
- referendumBallotResponses array: The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'.
  - items string
- referendumBrief string: Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'.
- referendumConStatement string: A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
- referendumEffectOfAbstain string: Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'.
- referendumPassageThreshold string: The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'.
- referendumProStatement string: A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
- referendumSubtitle string: A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
- referendumText string: The full text of the referendum. This field is only populated for contests of type 'Referendum'.
- referendumTitle string: The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
- referendumUrl string: A link to the referendum. This field is only populated for contests of type 'Referendum'.
- roles array: The roles which this office fulfills.
  - items string (values: headOfState, headOfGovernment, deputyHeadOfGovernment, governmentOfficer, executiveCouncil, legislatorUpperBody, legislatorLowerBody, highestCourtJudge, judge, schoolBoard, specialPurposeOfficer)
- sources array: A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
  - items Source
- special string: "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
- type string: The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'.

DivisionSearchResponse

DivisionSearchResponse object: The result of a division search query.
- kind string: Identifies what kind of resource this is. Value: the fixed string "civicinfo#divisionSearchResponse".
- results array
  - items DivisionSearchResult

DivisionSearchResult

DivisionSearchResult object: Represents a political geographic division that matches the requested query.
- aliases array: Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-division/country:us/state:wy will include an alias of ocd-division/country:us/state:wy/cd:1, since Wyoming has only one Congressional district.
  - items string
- name string: The name of the division.
- ocdId string: The unique Open Civic Data identifier for this division

Election

Election object: Information about the election that was queried.
- electionDay string: Day of the election in YYYY-MM-DD format.
- id string: The unique ID of this election.
- name string: A displayable name for the election.
- ocdDivisionId string: The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).

ElectionOfficial

ElectionOfficial object: Information about individual election officials.
- emailAddress string: The email address of the election official.
- faxNumber string: The fax number of the election official.
- name string: The full name of the election official.
- officePhoneNumber string: The office phone number of the election official.
- title string: The title of the election official.

ElectionsQueryResponse

ElectionsQueryResponse object: The list of elections available for this version of the API.
- elections array: A list of available elections
  - items Election
- kind string: Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".

ElectoralDistrict

ElectoralDistrict object: Describes the geographic scope of a contest.
- id string: An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper.
- name string: The name of the district.
- scope string (values: statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, citywide, special, countyCouncil, township, ward, cityCouncil, national): The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special

GeographicDivision

GeographicDivision object: Describes a political geography.
- alsoKnownAs array: Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
  - items string
- name string: The name of the division.
- officeIndices array: List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
  - items integer

Office

Office object: Information about an Office held by one or more Officials.
- divisionId string: The OCD ID of the division with which this office is associated.
- levels array: The levels of government of which this office is part. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
  - items string (values: international, country, administrativeArea1, regional, administrativeArea2, locality, subLocality1, subLocality2, special)
- name string: The human-readable name of the office.
- officialIndices array: List of indices in the officials array of people who presently hold this office.
  - items integer
- roles array: The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
  - items string (values: headOfState, headOfGovernment, deputyHeadOfGovernment, governmentOfficer, executiveCouncil, legislatorUpperBody, legislatorLowerBody, highestCourtJudge, judge, schoolBoard, specialPurposeOfficer)
- sources array: A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
  - items Source

Official

Official object: Information about a person holding an elected office.
- address array: Addresses at which to contact the official.
  - items SimpleAddressType
- channels array: A list of known (social) media channels for this official.
  - items Channel
- emails array: The direct email addresses for the official.
  - items string
- name string: The official's name.
- party string: The full name of the party the official belongs to.
- phones array: The official's public contact phone numbers.
  - items string
- photoUrl string: A URL for a photo of the official.
- urls array: The official's public website URLs.
  - items string

PollingLocation

PollingLocation object: A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
- address SimpleAddressType
- endDate string: The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
- latitude number: Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
- longitude number: Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
- name string: The name of the early vote site or drop off location. This field is not populated for polling locations.
- notes string: Notes about this location (e.g. accessibility ramp or entrance to use).
- pollingHours string: A description of when this location is open.
- sources array: A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
  - items Source
- startDate string: The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
- voterServices string: The services provided by this early vote site or drop off location. This field is not populated for polling locations.

RepresentativeInfoData

RepresentativeInfoData object
- divisions object: A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
- offices array: Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
  - items Office
- officials array: Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
  - items Official

RepresentativeInfoResponse

RepresentativeInfoResponse object: The result of a representative info lookup query.
- divisions object: A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
- kind string: Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
- normalizedInput SimpleAddressType
- offices array: Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
  - items Office
- officials array: Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
  - items Official

SimpleAddressType

SimpleAddressType object: A simple representation of an address.
- city string: The city or town for the address.
- line1 string: The street name and number of this address.
- line2 string: The second line the address, if needed.
- line3 string: The third line of the address, if needed.
- locationName string: The name of the location.
- state string: The US two letter state abbreviation of the address.
- zip string: The US Postal Zip Code of the address.

Source

Source object: Contains information about the data source for the element containing it.
- name string: The name of the data source.
- official boolean: Whether this data comes from an official government source.

VoterInfoResponse

VoterInfoResponse object: The result of a voter info lookup query.
- contests array: Contests that will appear on the voter's ballot.
  - items Contest
- dropOffLocations array: Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.
  - items PollingLocation
- earlyVoteSites array: Locations where the voter is eligible to vote early, prior to election day.
  - items PollingLocation
- election Election
- kind string: Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
- mailOnly boolean: Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).
- normalizedInput SimpleAddressType
- otherElections array: When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user.
  - items Election
- pollingLocations array: Locations where the voter is eligible to vote on election day.
  - items PollingLocation
- precinctId string
- state array: Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
  - items AdministrationRegion

datafire

@infinitebrahmanuniverse/nolb-_datafire_g @everything-registry/sub-chunk-222 @zalastax/nolb-_datafire_g

5 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago