Google Civic Information API (civicinfo:v2)

Deletions

Methods


• ▼ ▲ civicinfo.representatives.representativeInfoByDivision

  Path : civicinfo/v2/representatives/{ocdId}

  Flat Path : civicinfo/v2/representatives/{ocdId}

  HTTP Method : GET

  Parameters :

  ocdId

  Description : The Open Civic Data division identifier of the division to look up.

  Location : path

  Required : Yes

  Type : string

  recursive

  Description : 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.

  Location : query

  Type : boolean

  roles

  Description : 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.

  Location : query

  Repeated : Yes

  Type : string

  Enum Descriptions :

  Enum :

  • headOfState
  • headOfGovernment
  • deputyHeadOfGovernment
  • governmentOfficer
  • executiveCouncil
  • legislatorUpperBody
  • legislatorLowerBody
  • highestCourtJudge
  • judge
  • schoolBoard
  • specialPurposeOfficer
  • otherRole

  levels

  Description : 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.

  Location : query

  Repeated : Yes

  Type : string

  Enum Descriptions :

  Enum :

  • international
  • country
  • administrativeArea1
  • regional
  • administrativeArea2
  • locality
  • subLocality1
  • subLocality2
  • special

  Parameter Order : ocdId

  Description : Looks up representative information for a single geographic division.

• ▼ ▲ civicinfo.representatives.representativeInfoByAddress

  Path : civicinfo/v2/representatives

  Flat Path : civicinfo/v2/representatives

  HTTP Method : GET

  Parameters :

  address

  Description : The address to look up. May only be specified if the field ocdId is not given in the URL

  Location : query

  Type : string

  roles

  Description : 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.

  Location : query

  Repeated : Yes

  Type : string

  Enum Descriptions :

  Enum :

  • headOfState
  • headOfGovernment
  • deputyHeadOfGovernment
  • governmentOfficer
  • executiveCouncil
  • legislatorUpperBody
  • legislatorLowerBody
  • highestCourtJudge
  • judge
  • schoolBoard
  • specialPurposeOfficer
  • otherRole

  levels

  Description : 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.

  Location : query

  Repeated : Yes

  Type : string

  Enum Descriptions :

  Enum :

  • international
  • country
  • administrativeArea1
  • regional
  • administrativeArea2
  • locality
  • subLocality1
  • subLocality2
  • special

  includeOffices

  Description : Whether to return information about offices and officials. If false, only the top-level district information will be returned.

  Default : true

  Location : query

  Type : boolean

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