Vote

The endpoint for Votes (on Bills).

Retrieve multiple Vote results based on search critera passed as GET Arguments

get/api/vote/

The endpoint for Votes (on Bills).

Securityapi_key and user_name
Request
query Parameters
all_votes
Array of integers <int64>

The newpersons that are associated with this vote.

NOTE: Parameter accepts additional qualifiers appended to the end:
all_votes__overlaps - The value for the record has one or more values in common with the provided array parameter (comma-separated values).

category
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
category__in - The value for the record is in the provided array parameter (comma-separated values).
category__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name VoteCategory, for an explanation of values.

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
chamber
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
chamber__in - The value for the record is in the provided array parameter (comma-separated values).

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name CongressChamber, for an explanation of values.

Enum: 1 2 3 4
created
string <date-time>

NOTE: Parameter accepts additional qualifiers appended to the end:
created__year, created__month, created__day - The value for the record matches the provided year/month/day (note that week_day, hour, minute, and second are also available following similar patterns).

democrat_result
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
democrat_result__in - The value for the record is in the provided array parameter (comma-separated values).
democrat_result__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name VoteResultType, for an explanation of values.

Enum: 1 2 3 4 5
id
integer <int64>

Quorum ID (Primary Key)

majority_result
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
majority_result__in - The value for the record is in the provided array parameter (comma-separated values).
majority_result__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name VoteResultType, for an explanation of values.

Enum: 1 2 3 4 5
number
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
number__in - The value for the record is in the provided array parameter (comma-separated values).
number__gt, number__gte, number__lt, number__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

question
string

NOTE: Parameter accepts additional qualifiers appended to the end:
question__in - The value for the record is in the provided array parameter (comma-separated values).
question__contains, question__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
question__startswith, question__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
question__endswith, question__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
question__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

question_details
string

NOTE: Parameter accepts additional qualifiers appended to the end:
question_details__in - The value for the record is in the provided array parameter (comma-separated values).
question_details__contains, question_details__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
question_details__startswith, question_details__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
question_details__endswith, question_details__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
question_details__iexact - The value for the record is a case-insensitive exact match to the provided parameter.
question_details__isnull - The value for the record is null (if true) or is not null.

region
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
region__in - The value for the record is in the provided array parameter (comma-separated values).

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name Region, for an explanation of values.

Enum: 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 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 1000
region_session_id
integer <int64>

The legsession with which this vote is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
region_session__in - The value for the record is in the provided array parameter (comma-separated values).
region_session__isnull - The value for the record is null (if true) or is not null.

related_amendment_id
integer <int64>

The newamendment with which this vote is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
related_amendment__in - The value for the record is in the provided array parameter (comma-separated values).
related_amendment__isnull - The value for the record is null (if true) or is not null.

related_bill_id
integer <int64>

The newbill with which this vote is associated.

NOTE: Parameter accepts additional qualifiers appended to the end:
related_bill__in - The value for the record is in the provided array parameter (comma-separated values).
related_bill__isnull - The value for the record is null (if true) or is not null.

republican_result
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
republican_result__in - The value for the record is in the provided array parameter (comma-separated values).
republican_result__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name VoteResultType, for an explanation of values.

Enum: 1 2 3 4 5
required
string

NOTE: Parameter accepts additional qualifiers appended to the end:
required__in - The value for the record is in the provided array parameter (comma-separated values).
required__contains, required__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
required__startswith, required__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
required__endswith, required__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
required__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

result
string

NOTE: Parameter accepts additional qualifiers appended to the end:
result__in - The value for the record is in the provided array parameter (comma-separated values).
result__contains, result__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
result__startswith, result__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
result__endswith, result__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
result__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

result_type
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
result_type__in - The value for the record is in the provided array parameter (comma-separated values).
result_type__isnull - The value for the record is null (if true) or is not null.

See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name VoteResultType, for an explanation of values.

Enum: 1 2 3 4 5
session
string

NOTE: Parameter accepts additional qualifiers appended to the end:
session__in - The value for the record is in the provided array parameter (comma-separated values).
session__contains, session__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
session__startswith, session__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
session__endswith, session__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
session__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

total_all
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_all__in - The value for the record is in the provided array parameter (comma-separated values).
total_all__gt, total_all__gte, total_all__lt, total_all__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_dem_all
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_dem_all__in - The value for the record is in the provided array parameter (comma-separated values).
total_dem_all__gt, total_dem_all__gte, total_dem_all__lt, total_dem_all__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_dem_minus
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_dem_minus__in - The value for the record is in the provided array parameter (comma-separated values).
total_dem_minus__gt, total_dem_minus__gte, total_dem_minus__lt, total_dem_minus__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_dem_other
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_dem_other__in - The value for the record is in the provided array parameter (comma-separated values).
total_dem_other__gt, total_dem_other__gte, total_dem_other__lt, total_dem_other__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_dem_plus
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_dem_plus__in - The value for the record is in the provided array parameter (comma-separated values).
total_dem_plus__gt, total_dem_plus__gte, total_dem_plus__lt, total_dem_plus__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_minus
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_minus__in - The value for the record is in the provided array parameter (comma-separated values).
total_minus__gt, total_minus__gte, total_minus__lt, total_minus__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_other
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_other__in - The value for the record is in the provided array parameter (comma-separated values).
total_other__gt, total_other__gte, total_other__lt, total_other__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_plus
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_plus__in - The value for the record is in the provided array parameter (comma-separated values).
total_plus__gt, total_plus__gte, total_plus__lt, total_plus__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_rep_all
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_rep_all__in - The value for the record is in the provided array parameter (comma-separated values).
total_rep_all__gt, total_rep_all__gte, total_rep_all__lt, total_rep_all__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_rep_minus
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_rep_minus__in - The value for the record is in the provided array parameter (comma-separated values).
total_rep_minus__gt, total_rep_minus__gte, total_rep_minus__lt, total_rep_minus__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_rep_other
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_rep_other__in - The value for the record is in the provided array parameter (comma-separated values).
total_rep_other__gt, total_rep_other__gte, total_rep_other__lt, total_rep_other__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

total_rep_plus
integer <int64>

NOTE: Parameter accepts additional qualifiers appended to the end:
total_rep_plus__in - The value for the record is in the provided array parameter (comma-separated values).
total_rep_plus__gt, total_rep_plus__gte, total_rep_plus__lt, total_rep_plus__lte - The value for the record is greater than/less than (or equal to) the provided parameter.

vote_type
string

NOTE: Parameter accepts additional qualifiers appended to the end:
vote_type__in - The value for the record is in the provided array parameter (comma-separated values).
vote_type__contains, vote_type__icontains - The value for the record contains the string provided as a parameter within it (partial match). (Use 'icontains' for matching to be done case-insensitive)
vote_type__startswith, vote_type__istartswith - The value for the record starts with the string provided as a parameter. (Use 'istartswith' for matching to be done case-insensitive)
vote_type__endswith, vote_type__iendswith - The value for the record ends with the string provided as a parameter within it (partial match). (Use 'iendswith' for matching to be done case-insensitive)
vote_type__iexact - The value for the record is a case-insensitive exact match to the provided parameter.

advanced_search
string

Perform an advanced text search on the datset with the provided text. This search will use the most comprehensive search method available on the requested endpoint, but can take slightly longer to return results.

limit
integer <int64>
Default: 20

The number of records to return (for pagination).

offset
integer <int64>
Default: 0

The number of records to offset the start of the data being returned (for pagination).

Responses
200

Vote retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "alert_cache": { },
  • "all_votes": [
    ],
  • "category": 1,
  • "chamber": 1,
  • "congress_number": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "democrat_result": 1,
  • "display_name": "string",
  • "fts_index": "string",
  • "icon": "string",
  • "id": 0,
  • "majority_result": 1,
  • "missed_votes": [
    ],
  • "missing_data": true,
  • "nay_votes": [
    ],
  • "newly_index": true,
  • "number": 0,
  • "openstates_id": "string",
  • "original_question": "string",
  • "other_votes": [
    ],
  • "present_votes": [
    ],
  • "question": "string",
  • "question_details": "string",
  • "region": 1,
  • "region_session": "/api/legsession/1/",
  • "related_amendment": "/api/newamendment/1/",
  • "related_bill": "/api/newbill/1/",
  • "republican_result": 1,
  • "required": "string",
  • "resource_uri": "string",
  • "result": "string",
  • "result_type": 1,
  • "session": "string",
  • "source": 1,
  • "source_link": "string",
  • "total_abstain": 0,
  • "total_all": 0,
  • "total_dem_abstain": 0,
  • "total_dem_all": 0,
  • "total_dem_minus": 0,
  • "total_dem_other": 0,
  • "total_dem_plus": 0,
  • "total_minus": 0,
  • "total_other": 0,
  • "total_plus": 0,
  • "total_rep_abstain": 0,
  • "total_rep_all": 0,
  • "total_rep_minus": 0,
  • "total_rep_other": 0,
  • "total_rep_plus": 0,
  • "vote_type": "string",
  • "voted_against_majority": null,
  • "yea_votes": [
    ]
}

Retrieve information on a single Vote

get/api/vote/{id}/

The endpoint for Votes (on Bills).

Securityapi_key and user_name
Request
path Parameters
id
required
integer <int64>

Quorum ID (Primary Key)

Responses
200

Vote retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples
application/json
{
  • "_extra": { },
  • "alert_cache": { },
  • "all_votes": [
    ],
  • "category": 1,
  • "chamber": 1,
  • "congress_number": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "democrat_result": 1,
  • "display_name": "string",
  • "fts_index": "string",
  • "icon": "string",
  • "id": 0,
  • "majority_result": 1,
  • "missed_votes": [
    ],
  • "missing_data": true,
  • "nay_votes": [
    ],
  • "newly_index": true,
  • "number": 0,
  • "openstates_id": "string",
  • "original_question": "string",
  • "other_votes": [
    ],
  • "present_votes": [
    ],
  • "question": "string",
  • "question_details": "string",
  • "region": 1,
  • "region_session": "/api/legsession/1/",
  • "related_amendment": "/api/newamendment/1/",
  • "related_bill": "/api/newbill/1/",
  • "republican_result": 1,
  • "required": "string",
  • "resource_uri": "string",
  • "result": "string",
  • "result_type": 1,
  • "session": "string",
  • "source": 1,
  • "source_link": "string",
  • "total_abstain": 0,
  • "total_all": 0,
  • "total_dem_abstain": 0,
  • "total_dem_all": 0,
  • "total_dem_minus": 0,
  • "total_dem_other": 0,
  • "total_dem_plus": 0,
  • "total_minus": 0,
  • "total_other": 0,
  • "total_plus": 0,
  • "total_rep_abstain": 0,
  • "total_rep_all": 0,
  • "total_rep_minus": 0,
  • "total_rep_other": 0,
  • "total_rep_plus": 0,
  • "vote_type": "string",
  • "voted_against_majority": null,
  • "yea_votes": [
    ]
}