1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="civicinfo_v2.html">Google Civic Information API</a> . <a href="civicinfo_v2.elections.html">elections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#electionQuery">electionQuery()</a></code></p>
<p class="firstline">List of available elections to query.</p>
<p class="toc_element">
<code><a href="#voterInfoQuery">voterInfoQuery(address, electionId=None, returnAllAvailableData=None, officialOnly=None)</a></code></p>
<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="electionQuery">electionQuery()</code>
<pre>List of available elections to query.
Args:
Returns:
An object of the form:
{ # The list of elections available for this version of the API.
"kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
"elections": [ # A list of available elections
{ # Information about the election that was queried.
"ocdDivisionId": "A 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).
"electionDay": "A String", # Day of the election in YYYY-MM-DD format.
"id": "A String", # The unique ID of this election.
"name": "A String", # A displayable name for the election.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="voterInfoQuery">voterInfoQuery(address, electionId=None, returnAllAvailableData=None, officialOnly=None)</code>
<pre>Looks up information relevant to a voter based on the voter's registered address.
Args:
address: string, The registered address of the voter to look up. (required)
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}/electionsIf 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.
returnAllAvailableData: boolean, If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
officialOnly: boolean, If set to true, only data from official state sources will be returned.
Returns:
An object of the form:
{ # The result of a voter info lookup query.
"earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day.
{ # 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.
"startDate": "A String", # The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
"pollingHours": "A String", # A description of when this location is open.
"endDate": "A String", # The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
"notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
"voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
"longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
"official": True or False, # Whether this data comes from an official government source.
"name": "A String", # The name of the data source.
},
],
"address": { # A simple representation of an address. # The address of the location.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"latitude": 3.14, # Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"dropOffLocations": [ # 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.
{ # 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.
"startDate": "A String", # The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
"pollingHours": "A String", # A description of when this location is open.
"endDate": "A String", # The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
"notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
"voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
"longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
"official": True or False, # Whether this data comes from an official government source.
"name": "A String", # The name of the data source.
},
],
"address": { # A simple representation of an address. # The address of the location.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"latitude": 3.14, # Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"otherElections": [ # 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.
{ # Information about the election that was queried.
"ocdDivisionId": "A 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).
"electionDay": "A String", # Day of the election in YYYY-MM-DD format.
"id": "A String", # The unique ID of this election.
"name": "A String", # A displayable name for the election.
},
],
"segments": [
{
"targetsmartUniquePrecinctCode": "A String",
"stateSenateDistrict": "A String",
"precinctName": "A String",
"startLatE7": "A String",
"judicialDistrict": "A String",
"municipalDistrict": "A String",
"stateHouseDistrict": "A String",
"voterGeographicDivisionOcdIds": [
"A String",
],
"cityCouncilDistrict": "A String",
"id": "A String",
"precinctOcdId": "A String",
"catalistUniquePrecinctCode": "A String",
"city": "A String",
"startHouseNumber": "A String",
"contestIds": [
"A String",
],
"surrogateId": "A String",
"startLngE7": "A String",
"subAdministrativeAreaName": "A String",
"state": "A String",
"streetName": "A String",
"geocodedPoint": {
"lngE7": 42,
"temporaryData": {
"recordMessageSetExt": {
"numberOfTriples": "A String",
"isRecon": True or False,
"expId": "A String",
"subscriberReceiveMsec": "A String",
"shouldMonitorLatency": True or False,
"process": "A String",
"topicBuildFinishMsec": "A String",
"expInfo": {
"deletedIns": [
"A String",
],
},
"priority": "A String",
"recordId": "A String",
"version": "A String",
"isWlmThrottled": True or False,
"topicBuildStartMsec": "A String",
"proxyReceiveMsec": "A String",
"dataSourcePublishMsec": "A String",
"proxySentMsec": "A String",
},
},
"latE7": 42,
"metadata": {
"internal": {
"isAuto": True or False,
"sourceSummary": {
"provider": "A String",
"dataset": "A String",
},
},
},
},
"congressionalDistrict": "A String",
"geographicDivisionOcdIds": [
"A String",
],
"administrationRegionIds": [
"A String",
],
"oddOrEvens": [
"A String",
],
"mailOnly": True or False,
"earlyVoteSiteByIds": [
"A String",
],
"pollinglocationByIds": [
"A String",
],
"townshipDistrict": "A String",
"schoolDistrict": "A String",
"provenances": [
{
"collidedSegmentSource": {
"segments": [
# Object with schema name: StreetSegment
],
},
"tsStreetSegmentId": "A String",
"vip5StreetSegmentId": "A String",
"precinctId": "A String",
"datasetId": "A String",
"ctclContestUuid": "A String",
"vip5PrecinctId": "A String",
"vipStreetSegmentId": "A String",
"precinctSplitId": "A String",
"ctclOfficeUuid": "A String",
},
],
"countyCouncilDistrict": "A String",
"datasetId": "A String",
"endHouseNumber": "A String",
"beforeGeocodeId": "A String",
"countyFips": "A String",
"zip": "A String",
"originalId": "A String",
"unitType": "A String",
"vanPrecinctCode": "A String",
"unitNumber": "A String",
"wildcard": True or False,
"published": True or False,
"wardDistrict": "A String",
"ncoaAddress": "A String",
},
],
"mailOnly": True or False, # Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).
"kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
{ # Describes information about a regional election administrative area.
"local_jurisdiction": # Object with schema name: AdministrationRegion # The city or county that provides election information for this voter. This object can have the same elements as state.
"sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
"official": True or False, # Whether this data comes from an official government source.
"name": "A String", # The name of the data source.
},
],
"electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.
"absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
"votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
"name": "A String", # The name of this election administrative body.
"electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
"correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
"electionOfficials": [ # The election officials for this election administrative body.
{ # Information about individual election officials.
"title": "A String", # The title of the election official.
"emailAddress": "A String", # The email address of the election official.
"name": "A String", # The full name of the election official.
"officePhoneNumber": "A String", # The office phone number of the election official.
"faxNumber": "A String", # The fax number of the election official.
},
],
"electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
"addressLines": [
"A String",
],
"voter_services": [ # A description of the services this administrative body may provide.
"A String",
],
"ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
"hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
"physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
},
"name": "A String", # The name of the jurisdiction.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"precinctId": "A String",
"election": { # Information about the election that was queried. # The election that was queried.
"ocdDivisionId": "A 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).
"electionDay": "A String", # Day of the election in YYYY-MM-DD format.
"id": "A String", # The unique ID of this election.
"name": "A String", # A displayable name for the election.
},
"pollingLocations": [ # Locations where the voter is eligible to vote on election day.
{ # 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.
"startDate": "A String", # The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
"pollingHours": "A String", # A description of when this location is open.
"endDate": "A String", # The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
"notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
"voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
"longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
"official": True or False, # Whether this data comes from an official government source.
"name": "A String", # The name of the data source.
},
],
"address": { # A simple representation of an address. # The address of the location.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
"latitude": 3.14, # Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
},
],
"contests": [ # Contests that will appear on the voter's ballot.
{ # Information about a contest that appears on a voter's ballot.
"office": "A String", # The name of the office for this contest.
"referendumBrief": "A 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'.
"sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
"official": True or False, # Whether this data comes from an official government source.
"name": "A String", # The name of the data source.
},
],
"primaryParty": "A String", # If this is a partisan election, the name of the party it is for.
"electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
"numberElected": "A String", # The number of candidates that will be elected to office in this contest.
"referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.
"referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
"id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
"special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
"referendumEffectOfAbstain": "A 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'.
"district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.
"scope": "A String", # 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
"id": "A 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": "A String", # The name of the district.
"kgForeignKey": "A String",
},
"ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
"referendumProStatement": "A 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'.
"candidates": [ # The candidate choices for this contest.
{ # Information about a candidate running for elected office.
"name": "A 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"
"photoUrl": "A String", # A URL for a photo of the candidate.
"candidateUrl": "A String", # The URL for the candidate's campaign web site.
"channels": [ # A list of known (social) media channels for this candidate.
{ # A social media or web channel for a candidate.
"type": "A 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
"id": "A String", # The unique public identifier for the candidate's channel.
},
],
"phone": "A String", # The voice phone number for the candidate's campaign office.
"orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
"party": "A String", # The full name of the party the candidate is a member of.
"email": "A String", # The email address for the candidate's campaign.
},
],
"type": "A 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'.
"referendumText": "A String", # The full text of the referendum. This field is only populated for contests of type 'Referendum'.
"referendumConStatement": "A 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'.
"referendumPassageThreshold": "A 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'.
"ballotTitle": "A String", # The official title on the ballot for this contest, only where available.
"numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
"roles": [ # The roles which this office fulfills.
"A String",
],
"referendumBallotResponses": [ # 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'.
"A String",
],
"level": [ # 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".
"A String",
],
"referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
},
],
}</pre>
</div>
</body></html>
|
