New to Corsair? See API access, authentication, and error handling.
Account
creditsBalance
account.creditsBalance
Get your credit balance
Risk: read
await corsair.vaquill.api.account.creditsBalance({});
| Name | Type | Required | Description |
|---|---|---|---|
creditsRemaining | number | No | — |
usdRemaining | number | null | No | — |
bySource | any | No | — |
nextExpiry | object | null | No | — |
plan | string | null | No | — |
totalPurchased | number | No | — |
totalConsumed | number | No | — |
rateLimit | any | No | — |
asOf | string | No | — |
nextExpiry full type
nextExpiry full type
{
at?: string,
credits?: number
} | null
creditsPricing
account.creditsPricing
Get API credit pricing
Risk: read
await corsair.vaquill.api.account.creditsPricing({});
| Name | Type | Required | Description |
|---|---|---|---|
region | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
dollarPerCredit | number | No | — |
minCredits | number | No | — |
maxCredits | number | No | — |
costs | any | No | — |
Alerts
boards
alerts.boards
List watchable law-change boards
Risk: read
await corsair.vaquill.api.alerts.boards({});
| Name | Type | Required | Description |
|---|---|---|---|
corpusType | string | No | — |
state | federal | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
meta | object | No | — |
data full type
data full type
{
boards: {
corpusType: string,
state?: string | null,
label?: string,
cadence?: string,
scopable?: boolean,
scopeBrowseCorpus?: string | null
}[],
total?: number,
hasMore?: boolean
}
meta full type
meta full type
{
processingTimeMs?: number,
creditsConsumed?: number
}
watchChangeDiff
alerts.watchChangeDiff
Old-vs-new text for one change
Risk: read
await corsair.vaquill.api.alerts.watchChangeDiff({});
| Name | Type | Required | Description |
|---|---|---|---|
watch_id | string | Yes | — |
change_id | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
meta | any | No | — |
data full type
data full type
{
changeId?: string | number,
changeKind?: string | null,
beforeText?: string | null,
afterText?: string | null,
hasBefore?: boolean,
hasAfter?: boolean
}
watchChanges
alerts.watchChanges
List what changed on a watch’s source
Risk: read
await corsair.vaquill.api.alerts.watchChanges({});
| Name | Type | Required | Description |
|---|---|---|---|
watch_id | string | Yes | — |
limit | number | No | — |
sinceId | number | No | — |
beforeId | number | No | — |
since | string | No | — |
changeKind | (added | amended | removed)[] | No | — |
order | asc | desc | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
meta | object | No | — |
data full type
data full type
{
changes: {
id: number,
refreshLogId?: number | null,
corpusType?: string | null,
state?: string | null,
changeKind?: string | null,
actId?: string | null,
citation?: string | null,
title?: string | null,
detectedAt?: string | null,
hasDiff?: boolean
}[]
}
meta full type
meta full type
{
processingTimeMs?: number,
creditsConsumed?: number,
cursor?: number | null,
hasMore?: boolean
}
watchDeliveries
alerts.watchDeliveries
List delivery history for a watch
Risk: read
await corsair.vaquill.api.alerts.watchDeliveries({});
| Name | Type | Required | Description |
|---|---|---|---|
watch_id | string | Yes | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
meta | any | No | — |
data full type
data full type
{
deliveries: {
deliveryId?: string | null,
status?: string | null,
firedAt?: string | null
}[]
}
watchesCreate
alerts.watchesCreate
Create a board watch for law-change alerts
Risk: write
await corsair.vaquill.api.alerts.watchesCreate({});
| Name | Type | Required | Description |
|---|---|---|---|
corpusType | string | Yes | — |
state | federal | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
channel | webhook | email | both | No | — |
webhookUrl | string | No | — |
webhookSecret | string | No | — |
emailAddress | string | No | — |
scope | Record<string, string> | No | — |
webhookAuth | Record<string, any> | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | No | — |
data full type
data full type
{
watch?: {
id: string | number,
corpusType?: string,
state?: string | null,
channel?: string,
isActive?: boolean,
scope?: Record<string, any> | null,
createdAt?: string | null
} | null
}
watchesDelete
alerts.watchesDelete
Delete a board watch
Risk: destructive
await corsair.vaquill.api.alerts.watchesDelete({});
| Name | Type | Required | Description |
|---|---|---|---|
watch_id | string | Yes | — |
object
Output full type
Output full type
{
}
watchesList
alerts.watchesList
List your board watches
Risk: read
await corsair.vaquill.api.alerts.watchesList({});
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | No | — |
meta | any | No | — |
data full type
data full type
{
watches?: {
id: string | number,
corpusType?: string,
state?: string | null,
channel?: string,
isActive?: boolean,
scope?: Record<string, any> | null,
createdAt?: string | null
}[],
total?: number,
hasMore?: boolean
}
watchesTest
alerts.watchesTest
Send a test delivery for a watch
Risk: write
await corsair.vaquill.api.alerts.watchesTest({});
| Name | Type | Required | Description |
|---|---|---|---|
watch_id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | any | No | — |
watchesUpdate
alerts.watchesUpdate
Update a board watch
Risk: write
await corsair.vaquill.api.alerts.watchesUpdate({});
| Name | Type | Required | Description |
|---|---|---|---|
watch_id | string | Yes | — |
isActive | boolean | No | — |
webhookUrl | string | No | — |
webhookSecret | string | No | — |
scope | Record<string, string> | null | No | — |
emailAddress | string | No | — |
webhookAuth | Record<string, any> | null | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | No | — |
data full type
data full type
{
watch?: {
id: string | number,
corpusType?: string,
state?: string | null,
channel?: string,
isActive?: boolean,
scope?: Record<string, any> | null,
createdAt?: string | null
} | null
}
Session Laws
batch
sessionLaws.batch
Get many state session laws at once, by id or citation
Risk: read
await corsair.vaquill.api.sessionLaws.batch({});
| Name | Type | Required | Description |
|---|---|---|---|
ids | string[] | Yes | — |
jurisdiction | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
includeBody | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
laws | object[] | Yes | — |
resolved | any[] | No | — |
notFound | string[] | No | — |
count | number | No | — |
deduped | number | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
laws full type
laws full type
{
sessionLawId: string,
jurisdiction?: string,
citation?: string | null,
citableAs?: string | null,
citationShort?: string | null,
session?: string | null,
series?: string | null,
instrumentType?: string | null,
number?: string | null,
title?: string | null,
shortTitle?: string | null,
approvedDate?: string | null,
effectiveFirst?: string | null,
effectiveLast?: string | null,
enactmentOutcome?: string | null,
isLaw?: boolean | null,
textStatus?: string | null,
charCount?: number | null,
updatedAt?: string | null
}[]
body
sessionLaws.body
Get a state session law’s text
Risk: read
await corsair.vaquill.api.sessionLaws.body({});
| Name | Type | Required | Description |
|---|---|---|---|
session_law_id | string | Yes | — |
cursor | string | No | — |
startChar | number | No | — |
expectTextSha256 | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
sessionLawId | string | Yes | — |
citation | string | null | No | — |
jurisdiction | string | null | No | — |
session | string | null | No | — |
approvedDate | string | null | No | — |
sourceUrl | string | null | No | — |
available | boolean | No | — |
reason | string | null | No | — |
textStatus | string | null | No | — |
withheldReason | string | null | No | — |
text | string | null | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
changes
sessionLaws.changes
Feed of changes to the session-law registry
Risk: read
await corsair.vaquill.api.sessionLaws.changes({});
| Name | Type | Required | Description |
|---|---|---|---|
sinceId | number | No | — |
jurisdiction | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
changes | object[] | Yes | — |
count | number | No | — |
cursor | number | null | No | — |
hasMore | boolean | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
changes full type
changes full type
{
id: number,
jurisdiction?: string | null,
changeKind?: string | null,
sessionLawId?: string | null,
citation?: string | null,
title?: string | null,
detectedAt?: string | null
}[]
get
sessionLaws.get
Get a state session law, by id or by citation
Risk: read
await corsair.vaquill.api.sessionLaws.get({});
| Name | Type | Required | Description |
|---|---|---|---|
session_law_id | string | Yes | — |
jurisdiction | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
sessionLawId | string | No | — |
lawId | string | null | No | — |
jurisdiction | string | null | No | — |
citation | string | null | No | — |
citableAs | string | null | No | — |
citationShort | string | null | No | — |
session | string | null | No | — |
series | string | null | No | — |
instrumentType | string | null | No | — |
title | string | null | No | — |
shortTitle | string | null | No | — |
approvedDate | string | null | No | — |
effectiveDates | any[] | No | — |
codeSectionsAffected | any[] | No | — |
sourceUrl | string | null | No | — |
textStatus | string | null | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
list
sessionLaws.list
List a state’s session laws
Risk: read
await corsair.vaquill.api.sessionLaws.list({});
| Name | Type | Required | Description |
|---|---|---|---|
jurisdiction | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | Yes | — |
session | string | No | — |
series | string | No | — |
instrumentType | string | No | — |
approvedFrom | string | No | — |
approvedTo | string | No | — |
effectiveFrom | string | No | — |
effectiveTo | string | No | — |
hasText | boolean | No | — |
textStatus | held | withheld | not_held | pending | No | — |
isLaw | boolean | No | — |
enactmentOutcome | string | No | — |
updatedSince | string | No | — |
q | string | No | — |
cursor | string | No | — |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | Yes | — |
count | number | No | — |
nextCursor | string | null | No | — |
hasMore | boolean | No | — |
coverage | any | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
results full type
results full type
{
sessionLawId: string,
jurisdiction?: string,
citation?: string | null,
citableAs?: string | null,
citationShort?: string | null,
session?: string | null,
series?: string | null,
instrumentType?: string | null,
number?: string | null,
title?: string | null,
shortTitle?: string | null,
approvedDate?: string | null,
effectiveFirst?: string | null,
effectiveLast?: string | null,
enactmentOutcome?: string | null,
isLaw?: boolean | null,
textStatus?: string | null,
charCount?: number | null,
updatedAt?: string | null
}[]
search
sessionLaws.search
Search the text of state session laws
Risk: read
await corsair.vaquill.api.sessionLaws.search({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | — |
jurisdiction | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
session | string | No | — |
series | string | No | — |
instrumentType | string | No | — |
approvedFrom | string | No | — |
approvedTo | string | No | — |
limit | number | No | — |
offset | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
query | string | No | — |
parsed | any | No | — |
results | object[] | Yes | — |
count | number | No | — |
offset | number | No | — |
limit | number | No | — |
hasMore | boolean | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
results full type
results full type
{
sessionLawId: string,
jurisdiction?: string,
citation?: string | null,
citableAs?: string | null,
citationShort?: string | null,
session?: string | null,
series?: string | null,
instrumentType?: string | null,
number?: string | null,
title?: string | null,
shortTitle?: string | null,
approvedDate?: string | null,
effectiveFirst?: string | null,
effectiveLast?: string | null,
enactmentOutcome?: string | null,
isLaw?: boolean | null,
textStatus?: string | null,
charCount?: number | null,
updatedAt?: string | null
}[]
Statutes
count
statutes.count
Count statute sections matching a scope
Risk: read
await corsair.vaquill.api.statutes.count({});
| Name | Type | Required | Description |
|---|---|---|---|
corpusType | USC | CFR | STATE | CONSTITUTION | FEDERAL_LOCAL_RULES | FEDERAL_RULES | STATE_CONSTITUTION | STATE_RULES | EXECUTIVE_ACTION | REGULATION | FEDERAL_REGISTER | FEDERAL_REGISTER_NOTICE | AGENCY_GUIDANCE | SENTENCING_GUIDELINES | US_TAX_TREATY | STATE_AGENCY_GUIDANCE | STATE_AG_OPINION | SESSION_LAW | STATE_REGISTER | STATUTE_COMPILATION | AGENCY_ADJUDICATION | CFR_ANNUAL | USC_ANNUAL | (USC | CFR | STATE | CONSTITUTION | FEDERAL_LOCAL_RULES | FEDERAL_RULES | STATE_CONSTITUTION | STATE_RULES | EXECUTIVE_ACTION | REGULATION | FEDERAL_REGISTER | FEDERAL_REGISTER_NOTICE | AGENCY_GUIDANCE | SENTENCING_GUIDELINES | US_TAX_TREATY | STATE_AGENCY_GUIDANCE | STATE_AG_OPINION | SESSION_LAW | STATE_REGISTER | STATUTE_COMPILATION | AGENCY_ADJUDICATION | CFR_ANNUAL | USC_ANNUAL)[] | No | — |
state | federal | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | (federal | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy)[] | No | — |
code | string | string[] | No | — |
article | string | string[] | No | — |
titleNumber | number | No | — |
chapter | string | string[] | No | — |
part | string | string[] | No | — |
actStatus | abolished | deleted | expired | in_force | inactive | non_precedential | not_funded | not_yet_effective | omitted | proposed | recodified | recompiled | rejected | relocated | removed | renumbered | repealed | rescinded | reserved | revoked | superseded | terminated | transferred | unconstitutional | vacant | vacated | vetoed | withdrawn | (abolished | deleted | expired | in_force | inactive | non_precedential | not_funded | not_yet_effective | omitted | proposed | recodified | recompiled | rejected | relocated | removed | renumbered | repealed | rescinded | reserved | revoked | superseded | terminated | transferred | unconstitutional | vacant | vacated | vetoed | withdrawn)[] | No | — |
excludeRepealed | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
count | number | Yes | — |
isExact | boolean | No | — |
scope | Record<string, any> | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
coverage
statutes.coverage
List the covered corpora and jurisdictions
Risk: read
await corsair.vaquill.api.statutes.coverage({});
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
data full type
data full type
{
corpusTypes: {
token: string,
description?: string,
scope?: string
}[],
jurisdictions: {
code: string,
name?: string,
kind?: string,
sectionCount?: number,
hasData?: boolean,
statusBreakdown?: Record<string, any>
}[]
}
divisions
statutes.divisions
Browse the statutory hierarchy of a corpus
Risk: read
await corsair.vaquill.api.statutes.divisions({});
| Name | Type | Required | Description |
|---|---|---|---|
corpusType | USC | CFR | STATE | REGULATION | CONSTITUTION | STATE_CONSTITUTION | FEDERAL_RULES | Yes | — |
state | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
titleNumber | number | No | — |
code | string | No | — |
chapter | string | No | — |
part | string | No | — |
article | string | No | — |
excludeRepealed | boolean | No | — |
actStatus | abolished | deleted | expired | in_force | inactive | non_precedential | not_funded | not_yet_effective | omitted | proposed | recodified | recompiled | rejected | relocated | removed | renumbered | repealed | rescinded | reserved | revoked | superseded | terminated | transferred | unconstitutional | vacant | vacated | vetoed | withdrawn | No | — |
cursor | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
corpusType | string | Yes | — |
level | string | No | — |
parentLabel | string | null | No | — |
divisions | object[] | Yes | — |
count | number | No | — |
truncated | boolean | No | — |
nextCursor | string | null | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
divisions full type
divisions full type
{
identifier: string,
name?: string,
kind?: string,
isLeaf?: boolean,
actId?: string
}[]
enactments
statutes.enactments
List the session-law enactments behind a section
Risk: read
await corsair.vaquill.api.statutes.enactments({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
| Name | Type | Required | Description |
|---|---|---|---|
actId | string | Yes | — |
jurisdiction | string | null | No | — |
supported | boolean | No | — |
reason | string | null | No | — |
enactments | object[] | Yes | — |
count | number | No | — |
truncated | boolean | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
enactments full type
enactments full type
{
sessionLawId?: string | null,
href?: string | null,
citation?: string | null,
title?: string | null,
approvedDate?: string | null,
action?: string | null,
matchQuality?: string | null,
textStatus?: string | null
}[]
extractCitations
statutes.extractCitations
Find the citations in a text and optionally resolve each
Risk: read
await corsair.vaquill.api.statutes.extractCitations({});
| Name | Type | Required | Description |
|---|---|---|---|
text | string | Yes | — |
state | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
resolve | boolean | No | — |
includeUnresolved | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
citations | object[] | Yes | — |
counts | Record<string, any> | No | — |
truncated | boolean | No | — |
textChars | number | No | — |
extractorVersion | string | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
citations full type
citations full type
{
citation: string,
resolved?: boolean,
section?: {
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
} | null
}[]
resolve
statutes.resolve
Resolve Bluebook citations to statute sections
Risk: read
await corsair.vaquill.api.statutes.resolve({});
| Name | Type | Required | Description |
|---|---|---|---|
citations | string[] | Yes | — |
state | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
corpusType | CONSTITUTION | REGULATION | STATE | STATE_CONSTITUTION | STATE_RULES | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | Yes | — |
resolvedCount | number | No | — |
count | number | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
results full type
results full type
{
resolved: boolean,
inputCitation: string,
section?: {
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
} | null,
subsection?: any
}[]
resolveCitation
statutes.resolveCitation
Resolve a single Bluebook citation to its section
Risk: read
await corsair.vaquill.api.statutes.resolveCitation({});
| Name | Type | Required | Description |
|---|---|---|---|
cite | string | Yes | — |
state | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | No | — |
corpusType | CONSTITUTION | REGULATION | STATE | STATE_CONSTITUTION | STATE_RULES | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
resolved | boolean | Yes | — |
inputCitation | string | No | — |
section | object | null | No | — |
subsection | any | No | — |
matchLevel | string | null | No | — |
missReason | string | null | No | — |
candidates | any[] | No | — |
creditsConsumed | number | No | — |
processingTimeMs | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
} | null
search
statutes.search
Search US statutes, regulations, court rules and guidance
Risk: read
await corsair.vaquill.api.statutes.search({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | Yes | — |
corpusType | USC | CFR | STATE | CONSTITUTION | FEDERAL_LOCAL_RULES | FEDERAL_RULES | STATE_CONSTITUTION | STATE_RULES | EXECUTIVE_ACTION | REGULATION | FEDERAL_REGISTER | FEDERAL_REGISTER_NOTICE | AGENCY_GUIDANCE | SENTENCING_GUIDELINES | US_TAX_TREATY | STATE_AGENCY_GUIDANCE | STATE_AG_OPINION | SESSION_LAW | STATE_REGISTER | STATUTE_COMPILATION | AGENCY_ADJUDICATION | CFR_ANNUAL | USC_ANNUAL | (USC | CFR | STATE | CONSTITUTION | FEDERAL_LOCAL_RULES | FEDERAL_RULES | STATE_CONSTITUTION | STATE_RULES | EXECUTIVE_ACTION | REGULATION | FEDERAL_REGISTER | FEDERAL_REGISTER_NOTICE | AGENCY_GUIDANCE | SENTENCING_GUIDELINES | US_TAX_TREATY | STATE_AGENCY_GUIDANCE | STATE_AG_OPINION | SESSION_LAW | STATE_REGISTER | STATUTE_COMPILATION | AGENCY_ADJUDICATION | CFR_ANNUAL | USC_ANNUAL)[] | No | — |
state | federal | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy | (federal | al | ak | az | ar | as | ca | co | ct | de | dc | fl | ga | gu | hi | id | il | in | ia | ks | ky | la | me | md | ma | mi | mn | ms | mo | mp | mt | ne | nv | nh | nj | nm | ny | nc | nd | oh | ok | or | pa | pr | ri | sc | sd | tn | tx | ut | vt | va | vi | wa | wv | wi | wy)[] | No | — |
code | string | string[] | No | — |
article | string | string[] | No | — |
yearFrom | number | No | — |
yearTo | number | No | — |
excludeRepealed | boolean | No | — |
actStatus | abolished | deleted | expired | in_force | inactive | non_precedential | not_funded | not_yet_effective | omitted | proposed | recodified | recompiled | rejected | relocated | removed | renumbered | repealed | rescinded | reserved | revoked | superseded | terminated | transferred | unconstitutional | vacant | vacated | vetoed | withdrawn | (abolished | deleted | expired | in_force | inactive | non_precedential | not_funded | not_yet_effective | omitted | proposed | recodified | recompiled | rejected | relocated | removed | renumbered | repealed | rescinded | reserved | revoked | superseded | terminated | transferred | unconstitutional | vacant | vacated | vetoed | withdrawn)[] | No | — |
changedSince | string | No | — |
agency | string | string[] | No | — |
source | string | No | — |
fields | string | string[] | No | — |
documentType | final | proposed | presidential | No | — |
publishedFrom | string | No | — |
publishedTo | string | No | — |
titleNumber | number | No | — |
chapter | string | string[] | No | — |
part | string | string[] | No | — |
limit | number | No | — |
offset | number | No | — |
includeBody | boolean | No | — |
excerptChars | number | No | — |
matchType | any | all | phrase | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
results | object[] | Yes | — |
count | number | No | — |
total | number | No | — |
offset | number | No | — |
hasMore | boolean | No | — |
noGoodMatch | boolean | No | — |
matchQuality | string | null | No | — |
citationMissReason | string | null | No | — |
rankingDegraded | boolean | No | — |
query | string | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
results full type
results full type
{
actId: string,
citation?: string,
title?: string | null,
corpusType?: string,
state?: string | null,
excerpt?: string | null,
body?: string | null,
goodLawStatus?: string | null
}[]
section
statutes.section
Get a statute section by id
Risk: read
await corsair.vaquill.api.statutes.section({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
| Name | Type | Required | Description |
|---|---|---|---|
section | object | Yes | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}
sectionBody
statutes.sectionBody
Get a section’s full text
Risk: read
await corsair.vaquill.api.statutes.sectionBody({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
format | all | both | html | markdown | plain | content | operative | No | — |
structured | boolean | No | — |
asOf | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
actId | string | Yes | — |
plain | string | null | No | — |
html | string | null | No | — |
content | string | null | No | — |
operative | string | null | No | — |
markdown | string | null | No | — |
subsections | any[] | No | — |
tables | any[] | No | — |
figures | any[] | No | — |
note | string | null | No | — |
source | string | null | No | — |
sourceUrl | string | null | No | — |
available | boolean | No | — |
asOf | any | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
sectionChanges
statutes.sectionChanges
Get a section’s amendment history
Risk: read
await corsair.vaquill.api.statutes.sectionChanges({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
limit | number | No | — |
sinceId | number | No | — |
beforeId | number | No | — |
changeKind | (added | amended | removed)[] | No | — |
order | asc | desc | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
actId | string | Yes | — |
section | object | No | — |
changes | object[] | Yes | — |
total | number | No | — |
hasMore | boolean | No | — |
cursor | number | null | No | — |
observedFrom | string | No | — |
coverage | string | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}
changes full type
changes full type
{
id: number,
changeKind?: string,
detectedAt?: string,
citation?: string,
displayCitation?: string | null,
title?: string | null,
hasDiff?: boolean,
corpusType?: string,
state?: string | null
}[]
sectionCitedBy
statutes.sectionCitedBy
Get sections citing this one
Risk: read
await corsair.vaquill.api.statutes.sectionCitedBy({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
section | object | Yes | — |
citers | object[] | Yes | — |
total | number | No | — |
truncated | boolean | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}
citers full type
citers full type
{
actId: string,
citation?: string,
title?: string | null,
corpusType?: string,
state?: string | null,
excerpt?: string | null,
body?: string | null,
goodLawStatus?: string | null
}[]
sectionCrossState
statutes.sectionCrossState
Compare a provision across states
Risk: read
await corsair.vaquill.api.statutes.sectionCrossState({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
section | object | Yes | — |
neighbors | object[] | Yes | — |
statesCovered | number | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}
neighbors full type
neighbors full type
{
section?: {
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
} | null,
state?: string,
similarity?: number
}[]
sectionDefinitions
statutes.sectionDefinitions
Get the defined terms governing a section
Risk: read
await corsair.vaquill.api.statutes.sectionDefinitions({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
| Name | Type | Required | Description |
|---|---|---|---|
section | object | Yes | — |
definitionsSection | object | null | No | — |
terms | object[] | Yes | — |
total | number | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}
definitionsSection full type
definitionsSection full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
} | null
terms full type
terms full type
{
term: string,
definition?: string | null
}[]
sectionRelated
statutes.sectionRelated
Get the neighbouring sections in statutory order
Risk: read
await corsair.vaquill.api.statutes.sectionRelated({});
| Name | Type | Required | Description |
|---|---|---|---|
act_id | string | Yes | Section identifier, as returned on a search hit or by the citation resolver. |
limit | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
section | object | Yes | — |
previous | object[] | Yes | — |
next | object[] | Yes | — |
container | string | null | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
section full type
section full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}
previous full type
previous full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}[]
next full type
next full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}[]
sections
statutes.sections
Get statute sections in batch by ids
Risk: read
await corsair.vaquill.api.statutes.sections({});
| Name | Type | Required | Description |
|---|---|---|---|
actIds | string[] | Yes | — |
includeBody | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
sections | object[] | Yes | — |
notFound | string[] | No | — |
notFoundDetail | any[] | No | — |
count | number | No | — |
processingTimeMs | number | No | — |
creditsConsumed | number | No | — |
sections full type
sections full type
{
actId: string,
citation?: string,
citationShort?: string | null,
title?: string | null,
corpusType?: string,
state?: string | null,
year?: number | null,
excerpt?: string | null,
body?: string | null,
titleNumber?: string | number | null,
titleName?: string | null,
chapter?: string | null,
chapterName?: string | null,
sectionNumber?: string | null,
sectionTitle?: string | null,
displayPath?: string | null,
actStatus?: string | null,
goodLawStatus?: string | null,
effectiveDate?: string | null,
wordCount?: number | null,
htmlUrl?: string | null,
textUrl?: string | null
}[]