Google Civic Information API . representatives

Instance Methods

close()

Close httplib2 connections.

representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)

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

representativeInfoByDivision(ocdId, levels=None, recursive=None, roles=None, x__xgafv=None)

Looks up representative information for a single geographic division.

Method Details

close()
Close httplib2 connections.
representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)
Looks up political geography and representative information for a single address.

Args:
  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: 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't contain a matching office will not be returned. (repeated)
    Allowed values
      international - 
      country - 
      administrativeArea1 - 
      regional - 
      administrativeArea2 - 
      locality - 
      subLocality1 - 
      subLocality2 - 
      special - 
  roles: string, 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. (repeated)
    Allowed values
      headOfState - 
      headOfGovernment - 
      deputyHeadOfGovernment - 
      governmentOfficer - 
      executiveCouncil - 
      legislatorUpperBody - 
      legislatorLowerBody - 
      highestCourtJudge - 
      judge - 
      schoolBoard - 
      specialPurposeOfficer - 
      otherRole - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The result of a representative info lookup query.
  "divisions": { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
    "a_key": { # Describes a political geography.
      "alsoKnownAs": [ # 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.
        "A String",
      ],
      "name": "A String", # The name of the division.
      "officeIndices": [ # 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.
        42,
      ],
    },
  },
  "kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
  "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
    "city": "A String", # The city or town for the address.
    "line1": "A String", # The street name and number of this address.
    "line2": "A String", # The second line the address, if needed.
    "line3": "A String", # The third line of the address, if needed.
    "locationName": "A String", # The name of the location.
    "state": "A String", # The US two letter state abbreviation of the address.
    "zip": "A String", # The US Postal Zip Code of the address.
  },
  "offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
    { # Information about an Office held by one or more Officials.
      "divisionId": "A String", # The OCD ID of the division with which this office is associated.
      "levels": [ # 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".
        "A String",
      ],
      "name": "A String", # The human-readable name of the office.
      "officialIndices": [ # List of indices in the officials array of people who presently hold this office.
        42,
      ],
      "roles": [ # 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.
        "A String",
      ],
      "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
        { # Contains information about the data source for the element containing it.
          "name": "A String", # The name of the data source.
          "official": True or False, # Whether this data comes from an official government source.
        },
      ],
    },
  ],
  "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
    { # Information about a person holding an elected office.
      "address": [ # Addresses at which to contact the official.
        { # A simple representation of an address.
          "city": "A String", # The city or town for the address.
          "line1": "A String", # The street name and number of this address.
          "line2": "A String", # The second line the address, if needed.
          "line3": "A String", # The third line of the address, if needed.
          "locationName": "A String", # The name of the location.
          "state": "A String", # The US two letter state abbreviation of the address.
          "zip": "A String", # The US Postal Zip Code of the address.
        },
      ],
      "channels": [ # A list of known (social) media channels for this official.
        { # A social media or web channel for a candidate.
          "id": "A String", # The unique public identifier for the candidate's channel.
          "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
        },
      ],
      "emails": [ # The direct email addresses for the official.
        "A String",
      ],
      "name": "A String", # The official's name.
      "party": "A String", # The full name of the party the official belongs to.
      "phones": [ # The official's public contact phone numbers.
        "A String",
      ],
      "photoUrl": "A String", # A URL for a photo of the official.
      "urls": [ # The official's public website URLs.
        "A String",
      ],
    },
  ],
}
representativeInfoByDivision(ocdId, levels=None, recursive=None, roles=None, x__xgafv=None)
Looks up representative information for a single geographic division.

Args:
  ocdId: string, The Open Civic Data division identifier of the division to look up. (required)
  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't contain a matching office will not be returned. (repeated)
    Allowed values
      international - 
      country - 
      administrativeArea1 - 
      regional - 
      administrativeArea2 - 
      locality - 
      subLocality1 - 
      subLocality2 - 
      special - 
  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: string, 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. (repeated)
    Allowed values
      headOfState - 
      headOfGovernment - 
      deputyHeadOfGovernment - 
      governmentOfficer - 
      executiveCouncil - 
      legislatorUpperBody - 
      legislatorLowerBody - 
      highestCourtJudge - 
      judge - 
      schoolBoard - 
      specialPurposeOfficer - 
      otherRole - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "divisions": { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
    "a_key": { # Describes a political geography.
      "alsoKnownAs": [ # 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.
        "A String",
      ],
      "name": "A String", # The name of the division.
      "officeIndices": [ # 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.
        42,
      ],
    },
  },
  "offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
    { # Information about an Office held by one or more Officials.
      "divisionId": "A String", # The OCD ID of the division with which this office is associated.
      "levels": [ # 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".
        "A String",
      ],
      "name": "A String", # The human-readable name of the office.
      "officialIndices": [ # List of indices in the officials array of people who presently hold this office.
        42,
      ],
      "roles": [ # 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.
        "A String",
      ],
      "sources": [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
        { # Contains information about the data source for the element containing it.
          "name": "A String", # The name of the data source.
          "official": True or False, # Whether this data comes from an official government source.
        },
      ],
    },
  ],
  "officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
    { # Information about a person holding an elected office.
      "address": [ # Addresses at which to contact the official.
        { # A simple representation of an address.
          "city": "A String", # The city or town for the address.
          "line1": "A String", # The street name and number of this address.
          "line2": "A String", # The second line the address, if needed.
          "line3": "A String", # The third line of the address, if needed.
          "locationName": "A String", # The name of the location.
          "state": "A String", # The US two letter state abbreviation of the address.
          "zip": "A String", # The US Postal Zip Code of the address.
        },
      ],
      "channels": [ # A list of known (social) media channels for this official.
        { # A social media or web channel for a candidate.
          "id": "A String", # The unique public identifier for the candidate's channel.
          "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
        },
      ],
      "emails": [ # The direct email addresses for the official.
        "A String",
      ],
      "name": "A String", # The official's name.
      "party": "A String", # The full name of the party the official belongs to.
      "phones": [ # The official's public contact phone numbers.
        "A String",
      ],
      "photoUrl": "A String", # A URL for a photo of the official.
      "urls": [ # The official's public website URLs.
        "A String",
      ],
    },
  ],
}