This repository has been archived by the owner on Feb 1, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 48
Differences between the API and MongoDB
jpmckinney edited this page Apr 20, 2013
·
13 revisions
The JSON downloads are in the same format as the API and are usually created on the first day of each month with the billy-util dumpjson
command without the --novalidate
switch. You can get the date and URL of the latest JSON dump of each state via the API, for example:
http://openstates.org/api/v1/metadata/?fields=latest_json_url,latest_json_date&apikey=API_KEY
- API renames
_id
toid
- Removes all underscore fields like
_all_ids
. You can't add these back with thefields
query string parameter. - Votes are only available through bills.
- Subjects are not available through the API.
- By default, removes
id
,legislature_name
,capitol_timezone
,latest_update
,terms
,session_details
,latest_json_url
,latest_json_date
,latest_csv_url
,latest_csv_date
,legislature_url
andcapitol_maps
- By default, adds
lower_chamber_name
,lower_chamber_title
,upper_chamber_name
andupper_chamber_title
, andlower_chamber_term
andupper_chamber_term
if available
- By default, removes
roles
,old_roles
andsources
-
By default, returns only
id
,state
,chamber
,committee
,subcommittee
,parent_id
,created_at
andupdated_at
. You can add fields using thefields
query string parameter. To get all the fields except for +plus fields andcountry
andlevel
(which are alwaysus
andstate
if set), use:fields=members,parent_id,state,chamber,committee,subcommittee,sources,created_at,updated_at
- No discernible difference
- Adds a
legislators
field with an array of objects withleg_id
andfull_name
fields
- Adds
bbox
,region
andshape
fields
The Events API lacks the following documentation:
-
dtstart
: search for events with awhen
afterdtstart
, in the formatYYYY-MM-DD
, defaults to a week ago -
dtend
: search for events with awhen
beforedtstart
, in the formatYYYY-MM-DD
- A maximum of 1000 events are returned. In order to retrieve all events, you must change the size of the time window set by
dtstart
anddtend
until under 1000 events are returned, then proceed to the next time window and repeat. The first window isdtstart=1900-01-01&dtend=2010-12-01
. Good luck!