ElectionsVoterInfoQueryOptions

import type { ElectionsVoterInfoQueryOptions } from "https://googleapis.deno.dev/v1/civicinfo:v2.ts";

Additional options for Civicinfo#electionsVoterInfoQuery.

interface ElectionsVoterInfoQueryOptions {

address: string;

electionId?: bigint;

officialOnly?: boolean;

productionDataOnly?: boolean;

returnAllAvailableData?: boolean;

}

§Properties

address: string

[src]

The registered address of the voter to look up.

electionId?: bigint

[src]

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

[src]

If set to true, only data from official state sources will be returned.

productionDataOnly?: boolean

[src]

Whether to include data that has not been vetted yet. Should only be made available to internal IPs or trusted partners. This is a non-discoverable parameter in the One Platform API config.

returnAllAvailableData?: boolean

[src]

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.