blob: 20469123c3b5d4aa345c4d50dd6234f3e746747c [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="civicinfo_v2.html">Google Civic Information API</a> . <a href="civicinfo_v2.representatives.html">representatives</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080081 <code><a href="#representativeInfoByAddress">representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070082<p class="firstline">Looks up political geography and representative information for a single address.</p>
83<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080084 <code><a href="#representativeInfoByDivision">representativeInfoByDivision(ocdId, levels=None, recursive=None, roles=None, x__xgafv=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070085<p class="firstline">Looks up representative information for a single geographic division.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080093 <code class="details" id="representativeInfoByAddress">representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070094 <pre>Looks up political geography and representative information for a single address.
95
96Args:
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080097 address: string, The address to look up. May only be specified if the field ocdId is not given in the URL
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080098 includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080099 levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
100 Allowed values
101 international -
102 country -
103 administrativeArea1 -
104 regional -
105 administrativeArea2 -
106 locality -
107 subLocality1 -
108 subLocality2 -
109 special -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700110 roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
111 Allowed values
112 headOfState -
113 headOfGovernment -
114 deputyHeadOfGovernment -
115 governmentOfficer -
116 executiveCouncil -
117 legislatorUpperBody -
118 legislatorLowerBody -
119 highestCourtJudge -
120 judge -
121 schoolBoard -
122 specialPurposeOfficer -
yoshi-code-bota933dad2021-07-06 00:26:24 -0700123 otherRole -
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124 x__xgafv: string, V1 error format.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700125 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700126 1 - v1 error format
127 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700128
129Returns:
130 An object of the form:
131
132 { # The result of a representative info lookup query.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &quot;divisions&quot;: { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
134 &quot;a_key&quot;: { # Describes a political geography.
135 &quot;alsoKnownAs&quot;: [ # 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&#x27;s OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
136 &quot;A String&quot;,
137 ],
138 &quot;name&quot;: &quot;A String&quot;, # The name of the division.
139 &quot;officeIndices&quot;: [ # 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.
140 42,
141 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700142 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800143 },
144 &quot;kind&quot;: &quot;civicinfo#representativeInfoResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;civicinfo#representativeInfoResponse&quot;.
145 &quot;normalizedInput&quot;: { # A simple representation of an address. # The normalized version of the requested address
146 &quot;city&quot;: &quot;A String&quot;, # The city or town for the address.
147 &quot;line1&quot;: &quot;A String&quot;, # The street name and number of this address.
148 &quot;line2&quot;: &quot;A String&quot;, # The second line the address, if needed.
149 &quot;line3&quot;: &quot;A String&quot;, # The third line of the address, if needed.
150 &quot;locationName&quot;: &quot;A String&quot;, # The name of the location.
151 &quot;state&quot;: &quot;A String&quot;, # The US two letter state abbreviation of the address.
152 &quot;zip&quot;: &quot;A String&quot;, # The US Postal Zip Code of the address.
153 },
154 &quot;offices&quot;: [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
155 { # Information about an Office held by one or more Officials.
156 &quot;divisionId&quot;: &quot;A String&quot;, # The OCD ID of the division with which this office is associated.
157 &quot;levels&quot;: [ # 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 &quot;locality&quot; level, but also effectively at both &quot;administrative-area-2&quot; and &quot;administrative-area-1&quot;.
158 &quot;A String&quot;,
159 ],
160 &quot;name&quot;: &quot;A String&quot;, # The human-readable name of the office.
161 &quot;officialIndices&quot;: [ # List of indices in the officials array of people who presently hold this office.
162 42,
163 ],
164 &quot;roles&quot;: [ # 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.
165 &quot;A String&quot;,
166 ],
167 &quot;sources&quot;: [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
168 { # Contains information about the data source for the element containing it.
169 &quot;name&quot;: &quot;A String&quot;, # The name of the data source.
170 &quot;official&quot;: True or False, # Whether this data comes from an official government source.
171 },
172 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800173 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800174 ],
175 &quot;officials&quot;: [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
176 { # Information about a person holding an elected office.
177 &quot;address&quot;: [ # Addresses at which to contact the official.
178 { # A simple representation of an address.
179 &quot;city&quot;: &quot;A String&quot;, # The city or town for the address.
180 &quot;line1&quot;: &quot;A String&quot;, # The street name and number of this address.
181 &quot;line2&quot;: &quot;A String&quot;, # The second line the address, if needed.
182 &quot;line3&quot;: &quot;A String&quot;, # The third line of the address, if needed.
183 &quot;locationName&quot;: &quot;A String&quot;, # The name of the location.
184 &quot;state&quot;: &quot;A String&quot;, # The US two letter state abbreviation of the address.
185 &quot;zip&quot;: &quot;A String&quot;, # The US Postal Zip Code of the address.
186 },
187 ],
188 &quot;channels&quot;: [ # A list of known (social) media channels for this official.
189 { # A social media or web channel for a candidate.
190 &quot;id&quot;: &quot;A String&quot;, # The unique public identifier for the candidate&#x27;s channel.
191 &quot;type&quot;: &quot;A String&quot;, # 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
192 },
193 ],
194 &quot;emails&quot;: [ # The direct email addresses for the official.
195 &quot;A String&quot;,
196 ],
197 &quot;name&quot;: &quot;A String&quot;, # The official&#x27;s name.
198 &quot;party&quot;: &quot;A String&quot;, # The full name of the party the official belongs to.
199 &quot;phones&quot;: [ # The official&#x27;s public contact phone numbers.
200 &quot;A String&quot;,
201 ],
202 &quot;photoUrl&quot;: &quot;A String&quot;, # A URL for a photo of the official.
203 &quot;urls&quot;: [ # The official&#x27;s public website URLs.
204 &quot;A String&quot;,
205 ],
206 },
207 ],
208}</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700209</div>
210
211<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800212 <code class="details" id="representativeInfoByDivision">representativeInfoByDivision(ocdId, levels=None, recursive=None, roles=None, x__xgafv=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700213 <pre>Looks up representative information for a single geographic division.
214
215Args:
216 ocdId: string, The Open Civic Data division identifier of the division to look up. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800217 levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
218 Allowed values
219 international -
220 country -
221 administrativeArea1 -
222 regional -
223 administrativeArea2 -
224 locality -
225 subLocality1 -
226 subLocality2 -
227 special -
228 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&#x27;s wards and ANCs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700229 roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700230 Allowed values
231 headOfState -
232 headOfGovernment -
233 deputyHeadOfGovernment -
234 governmentOfficer -
235 executiveCouncil -
236 legislatorUpperBody -
237 legislatorLowerBody -
238 highestCourtJudge -
239 judge -
240 schoolBoard -
241 specialPurposeOfficer -
yoshi-code-bota933dad2021-07-06 00:26:24 -0700242 otherRole -
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700243 x__xgafv: string, V1 error format.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700244 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700245 1 - v1 error format
246 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700247
248Returns:
249 An object of the form:
250
251 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800252 &quot;divisions&quot;: { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
253 &quot;a_key&quot;: { # Describes a political geography.
254 &quot;alsoKnownAs&quot;: [ # 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&#x27;s OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
255 &quot;A String&quot;,
256 ],
257 &quot;name&quot;: &quot;A String&quot;, # The name of the division.
258 &quot;officeIndices&quot;: [ # 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.
259 42,
260 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700261 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800262 },
263 &quot;offices&quot;: [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
264 { # Information about an Office held by one or more Officials.
265 &quot;divisionId&quot;: &quot;A String&quot;, # The OCD ID of the division with which this office is associated.
266 &quot;levels&quot;: [ # 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 &quot;locality&quot; level, but also effectively at both &quot;administrative-area-2&quot; and &quot;administrative-area-1&quot;.
267 &quot;A String&quot;,
268 ],
269 &quot;name&quot;: &quot;A String&quot;, # The human-readable name of the office.
270 &quot;officialIndices&quot;: [ # List of indices in the officials array of people who presently hold this office.
271 42,
272 ],
273 &quot;roles&quot;: [ # 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.
274 &quot;A String&quot;,
275 ],
276 &quot;sources&quot;: [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
277 { # Contains information about the data source for the element containing it.
278 &quot;name&quot;: &quot;A String&quot;, # The name of the data source.
279 &quot;official&quot;: True or False, # Whether this data comes from an official government source.
280 },
281 ],
282 },
283 ],
284 &quot;officials&quot;: [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
285 { # Information about a person holding an elected office.
286 &quot;address&quot;: [ # Addresses at which to contact the official.
287 { # A simple representation of an address.
288 &quot;city&quot;: &quot;A String&quot;, # The city or town for the address.
289 &quot;line1&quot;: &quot;A String&quot;, # The street name and number of this address.
290 &quot;line2&quot;: &quot;A String&quot;, # The second line the address, if needed.
291 &quot;line3&quot;: &quot;A String&quot;, # The third line of the address, if needed.
292 &quot;locationName&quot;: &quot;A String&quot;, # The name of the location.
293 &quot;state&quot;: &quot;A String&quot;, # The US two letter state abbreviation of the address.
294 &quot;zip&quot;: &quot;A String&quot;, # The US Postal Zip Code of the address.
295 },
296 ],
297 &quot;channels&quot;: [ # A list of known (social) media channels for this official.
298 { # A social media or web channel for a candidate.
299 &quot;id&quot;: &quot;A String&quot;, # The unique public identifier for the candidate&#x27;s channel.
300 &quot;type&quot;: &quot;A String&quot;, # 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
301 },
302 ],
303 &quot;emails&quot;: [ # The direct email addresses for the official.
304 &quot;A String&quot;,
305 ],
306 &quot;name&quot;: &quot;A String&quot;, # The official&#x27;s name.
307 &quot;party&quot;: &quot;A String&quot;, # The full name of the party the official belongs to.
308 &quot;phones&quot;: [ # The official&#x27;s public contact phone numbers.
309 &quot;A String&quot;,
310 ],
311 &quot;photoUrl&quot;: &quot;A String&quot;, # A URL for a photo of the official.
312 &quot;urls&quot;: [ # The official&#x27;s public website URLs.
313 &quot;A String&quot;,
314 ],
315 },
316 ],
317}</pre>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700318</div>
319
320</body></html>