This package simplifies interactions with the LegiScan API using JavaScript. The legiscan package is built with TypeScript and provides a wrapper to support full API functionality documented in this manual.
npm install legiscan
With your own API Key:
import { Legiscan } from 'legiscan'
const apiKey = 'your-api-key'
const legiscan = new Legiscan(apiKey)
const billId = 1447996
legiscan
.getBill(billId)
.then(res => console.log(res))
.catch(error => console.error(error))
Full text search, returning 50 results per page.
search({
query: string,
page?: number,
year?: number,
state?: string,
sessionId?: number
})queryrequired search querypagedefault: 1yeardefault: 2 -- 1=all, 2=current, 3=recent, 4=prior, >1900=exactstatedefault: 'ALL'sessionIdsession number
Full text search returning all pages. Caution: this can use a significant amount of queries if your search criteria is broad. It will perform a fetch for every page, consisting of 50 results each.
searchAllResults({
query: string,
year?: number,
state?: string,
sessionId?: number
})queryrequired search queryyearnumber (optional)1=all, 2=current, 3=recent, 4=prior, >1900=exact[Default: 2]statestring (optional) [Default: 'ALL']sessionIdnumber (optional)
Full text search returning 2000 bills per page. The objects returned do not include descriptions and titles like the full text search. Instead, they provide bill_id and change_hash along with a relevance score.
searchRaw({
query: string,
page?: number,
year?: number,
state?: string,
id?: number
})queryrequired search querypagenumber (optional) [Default: 1]yearnumber (optional)1=all, 2=current, 3=recent, 4=prior, >1900=exact[Default: 2]statedefault: 'ALL'idnumber (optional)
Fetch bills by their unique IDs. The LegiscanBill object:
{
bill_id: number;
change_hash: string;
session_id: number;
session: Session;
url: string;
state_link: string;
completed: number;
status: StatusKey;
status_date: string;
progress: ProgressEvent[];
state: string;
state_id: number;
bill_number: string;
bill_type: string;
bill_type_id: string;
body: string;
body_id: number;
current_body: string;
current_body_id: number;
title: string;
description: string;
pending_committee_id: number;
committee: Committee;
referrals: Referral[];
history: HistoryAction[];
sponsors: Sponsor[];
sasts: [];
subjects: Subject[];
texts: Text[];
votes: [];
amendments: Amendment[];
supplements: Supplement[];
calendar: CalendarEvent[];
}
Get a single LegiScan bill.
getBill(billId)
- billId: number
Get bills, providing an array of bill IDs.
getBills(billIds)
- billIds: number[]
Fetches the latest version of a bill's text, if available. This performs two API requests: one to fetch the bill and another to fetch the latest text. If you already know the doc_id, use getBillTextByDocId.
getBillTextByBillId(billId)
Get a bill text by its doc_id. The response includes the doc's date, draft revision information and MIME type. The bill text itself is base64 encoded to allow for binary PDF/Word transfers.
- billId: number
getBillTextByDocId(docId)
- docId: number
Get get a list of bill summaries by state or session ID. The response is a MasterList object:
{
"0": {
bill_id: number;
number: string;
change_hash: string;
url: string;
status_date: string;
status: string;
last_action_date: string;
last_action: string;
}
},
"1": {
...
},
...
}Returns a list of summary bill data in the current state session.
getMasterListByState(state)
statestring (ex: AL, OK, US, etc.) Default: 'ALL'
Returns a list of summary bill data in a specific session.
getMasterListBySessionId(sessionId)
sessionIdnumber
Get a list of bill change hash data by state or session ID. The response is a MasterListRaw object:
{
"0": {
bill_id: number;
number: string;
change_hash: string;
},
"1": {
...
},
...
}Returns a list of bill change_hash data in the current state session.
getMasterListByStateRaw(state)
-
state: string (ex: AL, OK, US, etc.) Default: 'ALL' -
sessionId: number
Returns a list of bill change_hash data in the specific session.
getMasterListBySessionIdRaw(sessionId)
sessionId: number
Get an amendment by its ID. The amendment text itself is base64 encoded to allow for binary PDF/Word transfers. Returns an amendment object:
{
amendment_id: number;
chamber: string;
chamber_id: number;
bill_id: number;
adopted: number;
date: string;
title: string;
description: string;
mime: string;
mime_id: number;
amendment_size: number;
amendment_hash: string;
}
getAmendmentById(amendmentId)
amendmentId: number
Get a list of sessions in a given state abbreviation. Returns an array of session objects:
[
{
session_id: number;
state_id: number;
year_start: number;
year_end: number;
prefile: number;
sine_die: number;
prior: number;
special: number;
session_tag: string;
session_title: string;
session_name: string;
},
...
]getSessionListByState(state)
state: string (ex: AL, OK, US, etc.) Default: 'ALL'
Get a supplement text by ID. The supplement text itself is base64 encoded to allow for binary PDF/Word transfers. Returns a supplement object:
{
supplement_id: number;
bill_id: number;
date: string;
type_id: number;
type: string;
title: string;
description: string;
mime: string;
mime_id: number;
supplement_size: number;
supplement_hash: string;
doc: string;
}getSupplementById(supplementId)
supplementIdnumber
Get roll call details, including a summary and individual votes with people_id. Returns a RollCall object:
{
roll_call_id: number;
bill_id: number;
date: string;
desc: string;
yea: number;
nay: number;
nv: number;
absent: number;
total: number;
passed: number;
chamber: string;
chamber_id: number;
votes: [{
people_id: number;
vote_id: number;
vote_text: string;
},
...
];
}getRollCallById(rollCallId)
rollCallIdnumber
Get information about people related to bills. Returns a Person object:
{
people_id: number;
person_hash: string;
state_id: number;
party_id: string;
party: string;
role_id: number;
role: string;
name: string;
first_name: string;
middle_name: string;
last_name: string;
suffix: string;
nickname: string;
district: string;
ftm_eid: number;
votesmart_id: number;
opensecrets_id: string;
knowwho_pid: number;
ballotpedia: string;
committee_sponsor: number;
committee_id: number;
}getPersonById(peopleId)
peopleIdnumber
Get a list of individuals active in a given session.
getPeopleBySessionId(sessionId)
sessionIdnumber
getPeopleBySessionId response includes session and people data:
session: {
session_id: number;
state_id: number;
year_start: number;
year_end: number;
special: number;
prefile: number;
prior: number;
sine_die: number;
session_name: string;
name: string;
dataset_hash: string;
},
people: Person[];
Get a list of bills sponsored by an individual legislator.
getPersonWithSponsoredBills(peopleId)
peopleIdnumber
Returns details about a person, including their bills they've sponsored:
{
sponsor: {
people_id: number;
person_hash: string;
state_id: number;
party_id: string;
party: string;
role_id: number;
role: string;
name: string;
first_name: string;
middle_name: string;
last_name: string;
suffix: string;
nickname: string;
district: string;
ftm_eid: string;
votesmart_id: number;
opensecrets_id: string;
knowwho_pid: number;
ballotpedia: string;
committee_sponsor: number;
committee_id: number;
};
sessions: [{
session_id: number;
session_name: string;
}],
bills: [{
session_id: number;
bill_id: number;
number: string;
}]
}Get a .zip archive for the requested dataset containing all bills, votes and people. Find the accessKey via getDatasetList.
getDataset(sessionId, accessKey)
sessionIdnumberaccessKeystring
Get a list of available session datasets, with optional state and year filtering.
Response is an array of Dataset objects that include the session_id and access_key required to call getDataset.
[
{
state_id: number;
session_id: number;
session_name: string;
dataset_hash: string;
dataset_date: string;
dataset_size: number;
mime: string;
zip: string;
}
]
getDatasetList({
state?: string;
year?: number
})
If you're tracking bills with your LegiScan account, you can get and set your list with the following.
Returns the GAITS monitor list of summary bill data being tracked by the account associated with the API key.
getMonitorList(record)
recordstring (optional) current or archived, 2010 >= exact year [Default: current]
Returns the GAITS monitor list of bill change_hash data being tracked by the account associated with the API key.
getMonitorListRaw(record)
recordstring (optional) current or archived, 2010 >= exact year [Default: current]
Returns a master list of bill change_hash data in the provided session or current state session.
setMonitor(list, action, stance)
listcomma separated string list ofbill_idto operate onactionstringmonitor,remove, orsetactionstancestring (Optional) position on the billwatch,support, oroppose[Default: watch]