# PACER Case Locator

> Search the PACER Case Locator, the national index of U.S. federal court cases: find cases and parties across every district, bankruptcy and appeals court, run large batch searches, and start a workflow when a new case is filed for a party or matching a search. Needs a PACER account; PACER bills searches by the page.

App · 10 actions. Web page: https://docs.lodol.com/docs/integrations/pacer-case-locator

## Actions

### Delete batch search

Delete a batch search and its results from PACER, making room for new ones: PACER keeps only about ten. Results not yet downloaded are lost. Free.

**Inputs**

- Batch search (`report_id`, text, required): The batch search. Pick one, or give the report_id from 'Start batch case search' or 'Start batch party search'.

**Outputs**

- `deleted` (true/false): True once deleted
- `report_id` (number): The batch search deleted

**Example output**

```json
{
  "deleted": true,
  "report_id": 1080
}
```

### Download batch case results

Get every case a batch case search found. If PACER is still running the search, the step waits for it to finish. PACER bills $0.10 for each page of 54 results downloaded, with no cap, so check the cost with 'Get batch search status' first. Free in the QA test environment.

**Inputs**

- Batch search (`report_id`, text, required): The batch search. Pick one, or give the report_id from 'Start batch case search' or 'Start batch party search'.

**Outputs**

- `cases` (list): Every case the search found
- `count` (number): How many results came back
- `fee` (number): What PACER billed for the download, in dollars
- `pages` (number): The pages of results PACER billed
- `receipt` (object): PACER's receipt, when it sends one
- `report_id` (number): The batch search downloaded

**Example output**

```json
{
  "cases": [
    {
      "bankruptcyChapter": null,
      "caseId": 998881,
      "caseLink": "https://ecf.ilsb.uscourts.gov/cgi-bin/iqquerymenu.pl?998881",
      "caseNumber": 90150,
      "caseNumberFull": "1:2000ap90150",
      "caseOffice": "1",
      "caseTitle": "Bayne and Internal Revenue Service",
      "caseType": "ap",
      "caseYear": 2000,
      "courtId": "ilsbk",
      "dateDischarged": null,
      "dateDismissed": null,
      "dateFiled": "2000-11-23",
      "dateReopened": null,
      "dateTermed": null,
      "dispositionMethod": null,
      "effectiveDateClosed": "2001-02-28",
      "jointBankruptcyFlag": null,
      "jurisdictionType": "Bankruptcy",
      "natureOfSuit": null
    }
  ],
  "count": 1,
  "fee": 0.1,
  "pages": 1,
  "receipt": {
    "billablePages": 1,
    "clientCode": "",
    "csoId": 3655344,
    "description": "All Court Types Case Search (batch)",
    "firmId": "",
    "loginId": "yourpacerusername",
    "reportId": "6c08ede4-ee24-4350-b607-a4ebd8d694ac",
    "search": "All Courts; Case Number 90150; Case Year 2000; Page: 1",
    "searchFee": ".10",
    "transactionDate": "2020-12-18T11:01:48.267-0600"
  },
  "report_id": 1080
}
```

### Download batch party results

Get every party a batch party search found, with each party's case. If PACER is still running the search, the step waits for it to finish. PACER bills $0.10 for each page of 54 results downloaded, with no cap, so check the cost with 'Get batch search status' first. Free in the QA test environment.

**Inputs**

- Batch search (`report_id`, text, required): The batch search. Pick one, or give the report_id from 'Start batch case search' or 'Start batch party search'.

**Outputs**

- `count` (number): How many results came back
- `fee` (number): What PACER billed for the download, in dollars
- `pages` (number): The pages of results PACER billed
- `parties` (list): Every party the search found
- `receipt` (object): PACER's receipt, when it sends one
- `report_id` (number): The batch search downloaded

**Example output**

```json
{
  "count": 1,
  "fee": 0.1,
  "pages": 1,
  "parties": [
    {
      "bankruptcyChapter": "7",
      "caseId": 144631,
      "caseLink": "https://ecf.laeb.uscourts.gov/cgi-bin/iqquerymenu.pl?144631",
      "caseNumber": 10011,
      "caseNumberFull": "2:2006bk10011",
      "caseOffice": "2",
      "caseTitle": "Sample Client",
      "caseType": "bk",
      "caseYear": 2006,
      "courtCase": {
        "bankruptcyChapter": "7",
        "caseId": 144631,
        "caseLink": "https://ecf.laeb.uscourts.gov/cgi-bin/iqquerymenu.pl?144631",
        "caseNumber": 10011,
        "caseNumberFull": "2:2006bk10011",
        "caseOffice": "2",
        "caseTitle": "Sample Client",
        "caseType": "bk",
        "caseYear": 2006,
        "courtId": "laebk",
        "dateDischarged": null,
        "dateDismissed": "2006-01-20",
        "dateFiled": "2006-01-06",
        "dateReopened": null,
        "dateTermed": "2006-02-03",
        "effectiveDateClosed": "2006-02-03",
        "jointBankruptcyFlag": "n",
        "jurisdictionType": "Bankruptcy",
        "natureOfSuit": null
      },
      "courtId": "laebk",
      "dateDischarged": null,
      "dateDismissed": "2006-01-20",
      "dateFiled": "2006-01-06",
      "dateReopened": null,
      "dateTermed": "2006-02-03",
      "disposition": "Dismissed for Other Reason",
      "effectiveDateClosed": "2006-02-03",
      "firstName": "Matt",
      "generation": " ",
      "jointBankruptcyFlag": "n",
      "jurisdictionType": "Bankruptcy",
      "lastName": "Smith",
      "middleName": " ",
      "natureOfSuit": null,
      "partyRole": "db",
      "partyType": "pty"
    }
  ],
  "receipt": {
    "billablePages": 1,
    "clientCode": "",
    "csoId": 3655344,
    "description": "All Court Types Case Search (batch)",
    "firmId": "",
    "loginId": "yourpacerusername",
    "reportId": "6c08ede4-ee24-4350-b607-a4ebd8d694ac",
    "search": "All Courts; Case Number 90150; Case Year 2000; Page: 1",
    "searchFee": ".10",
    "transactionDate": "2020-12-18T11:01:48.267-0600"
  },
  "report_id": 1080
}
```

### Get batch search status

Check whether a batch search has finished, with how many results it found, how many pages they fill and what downloading them will cost. Free.

**Inputs**

- Batch search (`report_id`, text, required): The batch search. Pick one, or give the report_id from 'Start batch case search' or 'Start batch party search'.

**Outputs**

- `batch_search` (object): The batch search as PACER reports it
- `report_id` (number): The batch search's id
- `status` (text): Its status, such as RUNNING or COMPLETED

**Example output**

```json
{
  "batch_search": {
    "criteria": {
      "caseTitle": "Falls",
      "caseType": [],
      "courtId": [],
      "federalBankruptcyChapter": [],
      "natureOfSuit": [],
      "requestSource": "Other",
      "requestType": "Batch",
      "searchType": "COURT_CASE"
    },
    "downloadFee": 0.0,
    "endTime": "2020-12-18T14:46:44.000-0600",
    "pages": 1,
    "recordCount": 42,
    "reportId": 1080,
    "searchType": "COURT_CASE",
    "sort": {
      "orders": []
    },
    "startTime": "2020-12-18T14:46:44.000-0600",
    "status": "COMPLETED",
    "unbilledPageCount": 0
  },
  "report_id": 1080,
  "status": "COMPLETED"
}
```

### List batch searches

List the batch searches PACER is keeping for the account, case and party searches alike, with each one's status, results found and download cost. PACER keeps about ten, so delete those you have downloaded. Free.

**Inputs**: None.

**Outputs**

- `batch_searches` (list): The account's batch searches
- `count` (number): How many there are

**Example output**

```json
{
  "batch_searches": [
    {
      "criteria": {
        "caseTitle": "Falls",
        "caseType": [],
        "courtId": [],
        "federalBankruptcyChapter": [],
        "natureOfSuit": [],
        "requestSource": "Other",
        "requestType": "Batch",
        "searchType": "COURT_CASE"
      },
      "downloadFee": 0.0,
      "endTime": "2020-12-18T14:46:44.000-0600",
      "pages": 1,
      "recordCount": 42,
      "reportId": 1080,
      "searchType": "COURT_CASE",
      "sort": {
        "orders": []
      },
      "startTime": "2020-12-18T14:46:44.000-0600",
      "status": "COMPLETED",
      "unbilledPageCount": 0
    }
  ],
  "count": 1
}
```

### Search cases

Search every federal court's cases by case number, title, party name, court, kind of case and dates, and get one page of up to 54 cases with each case's link into the court's PACER. A search needs a case number, a case title, a bankruptcy chapter or a date range. PACER bills $0.10 for each page of up to 54 results, even when nothing matches, with no cap on search fees; it waives a quarter's fees when they come to $30 or less. Searches in PACER's QA test environment are free.

**Inputs**

- Case number (`case_number`, text): The case number, whole or in part, such as 1:15-cv-01445 or 15-1445. PACER accepts yy-nnnnn, yy-tp-nnnnn and o:yy-tp-nnnnn forms. Pick a court too, since the same number exists in many courts.
- Case title starts with (`case_title`, text): Cases whose title starts with this, such as Jacob (which also finds Jacobs and Jacobson). Not case-sensitive. At least two characters, unless a date range of 30 days or fewer is given.
- Party last name or business (`party_last_name`, text): Cases with a party whose last name (or business name) starts with this.
- Party first name (`party_first_name`, text): With a party last name: the party's first name, or its start.
- Courts or regions (`courts`, list): Only these courts, or every court in a region (a state, district or circuit). Leave empty for every federal court. One or more of: `01bap` (U.S. Court of Appeals, First Circuit BAP (01bap)), `01ca` (U.S. Court of Appeals, First Circuit (01ca)), `02ca` (U.S. Court of Appeals, Second Circuit (02ca)), `03ca` (U.S. Court of Appeals, Third Circuit (03ca)), `04ca` (U.S. Court of Appeals, Fourth Circuit (04ca)), `05ca` (U.S. Court of Appeals, Fifth Circuit (05ca)), `06ca` (U.S. Court of Appeals, Sixth Circuit (06ca)), `07ca` (U.S. Court of Appeals, Seventh Circuit (07ca)), `08ca` (U.S. Court of Appeals, Eighth Circuit (08ca)), `09bap` (U.S. Court of Appeals, Ninth Circuit BAP (09bap)), and 324 more.
- Kind of case (`jurisdiction_type`, text): Only civil, criminal, bankruptcy, appellate or multidistrict cases. One of: `cv` (Civil), `cr` (Criminal), `bk` (Bankruptcy), `ap` (Appellate), `mdl` (Multidistrict litigation (JPML)).
- Filed on or after (`filed_from`, date): Only cases filed on or after this date.
- Filed on or before (`filed_to`, date): Only cases filed on or before this date.
- Case types (`case_types`, list): Only these case type codes. Courts assign their own, so a code can mean different things in different courts. One or more of: `ap` (Adversary proceeding or appeal (ap)), `bk` (Bankruptcy (bk)), `cr` (Criminal (cr)), `cv` (Civil (cv)), `mc` (Miscellaneous (mc)), `mj` (Magistrate judge (mj)), `po` (Petty offense (po)), `1453c`, `158d`, `2255`, and 60 more.
- Natures of suit (`nature_of_suit`, list): Only civil or appellate cases with these natures of suit, such as 830 Patent. One or more of: `100` (100 Contract - Construction (CDA)), `102` (102 Contract - Fail to Award (CDA)), `104` (104 Contract - Lease (CDA)), `106` (106 Contract - Maintenance (CDA)), `108` (108 Contract - Renovation (CDA)), `110` (110 Insurance), `112` (112 Contract - Sale (CDA)), `114` (114 Contract - Service (CDA)), `116` (116 Contract - Supply (CDA)), `118` (118 Contract - Other (CDA)), and 580 more.
- Bankruptcy chapters (`bankruptcy_chapters`, list): Only bankruptcy cases under these chapters. One or more of: `7` (Chapter 7 (liquidation)), `9` (Chapter 9 (municipalities)), `11` (Chapter 11 (reorganization)), `13` (Chapter 13 (individual debt adjustment)), `15` (Chapter 15 (cross-border)), `304` (Chapter 304 (replaced by chapter 15)).
- Closed on or after (`closed_from`, date): Only cases closed on or after this date.
- Closed on or before (`closed_to`, date): Only cases closed on or before this date.
- Dismissed on or after (`dismissed_from`, date): Only cases dismissed on or after this date.
- Dismissed on or before (`dismissed_to`, date): Only cases dismissed on or before this date.
- Discharged on or after (`discharged_from`, date): Only cases discharged on or after this date.
- Discharged on or before (`discharged_to`, date): Only cases discharged on or before this date.
- Sort by (`sort`, text): The order of the results. Leave empty for PACER's own order. One of: `dateFiled,DESC` (Newest filed first), `dateFiled,ASC` (Oldest filed first), `effectiveDateClosed,DESC` (Most recently closed first), `caseTitle,ASC` (Case title, A to Z), `courtId,ASC` (Court).
- Page (`page`, number): Which page of 54 results, from 1. Each page is a separate search that PACER bills. Leave empty for the first. From 1 to 100.

**Outputs**

- `billable_pages` (number): The pages PACER billed for this search
- `cases` (list): The cases on this page
- `fee` (number): What PACER billed for this search, in dollars
- `next_page` (number): The next page's number, or null on the last page
- `page` (number): This page's number, from 1
- `receipt` (object): PACER's receipt for the search
- `total_pages` (number): How many pages there are
- `total_results` (number): How many results there are in all

**Example output**

```json
{
  "billable_pages": 1,
  "cases": [
    {
      "bankruptcyChapter": null,
      "caseId": 998881,
      "caseLink": "https://ecf.ilsb.uscourts.gov/cgi-bin/iqquerymenu.pl?998881",
      "caseNumber": 90150,
      "caseNumberFull": "1:2000ap90150",
      "caseOffice": "1",
      "caseTitle": "Bayne and Internal Revenue Service",
      "caseType": "ap",
      "caseYear": 2000,
      "courtId": "ilsbk",
      "dateDischarged": null,
      "dateDismissed": null,
      "dateFiled": "2000-11-23",
      "dateReopened": null,
      "dateTermed": null,
      "dispositionMethod": null,
      "effectiveDateClosed": "2001-02-28",
      "jointBankruptcyFlag": null,
      "jurisdictionType": "Bankruptcy",
      "natureOfSuit": null
    }
  ],
  "fee": 0.1,
  "next_page": null,
  "page": 1,
  "receipt": {
    "billablePages": 1,
    "clientCode": "",
    "csoId": 3655344,
    "description": "All Court Types Case Search",
    "firmId": "",
    "loginId": "yourpacerusername",
    "reportId": "6c08ede4-ee24-4350-b607-a4ebd8d694ac",
    "search": "All Courts; Case Number 90150; Case Year 2000; Page: 1",
    "searchFee": ".10",
    "transactionDate": "2020-12-18T11:01:48.267-0600"
  },
  "total_pages": 1,
  "total_results": 1
}
```

### Search parties

Find people and businesses named in federal cases by name, with each party's role and case. Narrow by court, kind of case and dates. Gets one page of up to 54 parties. A search needs a last name or a date range. PACER bills $0.10 for each page of up to 54 results, even when nothing matches, with no cap on search fees; it waives a quarter's fees when they come to $30 or less. Searches in PACER's QA test environment are free.

**Inputs**

- Last name or business (`last_name`, text): The party's last name, or a business's name. Matches names that start with it unless Exact name match is on.
- First name (`first_name`, text): The party's first name, or its start.
- Middle name (`middle_name`, text): The party's middle name, or its start.
- Exact name match (`exact_name_match`, true/false): Only names exactly as typed, rather than names that start with it.
- Courts or regions (`courts`, list): Only these courts, or every court in a region (a state, district or circuit). Leave empty for every federal court. One or more of: `01bap` (U.S. Court of Appeals, First Circuit BAP (01bap)), `01ca` (U.S. Court of Appeals, First Circuit (01ca)), `02ca` (U.S. Court of Appeals, Second Circuit (02ca)), `03ca` (U.S. Court of Appeals, Third Circuit (03ca)), `04ca` (U.S. Court of Appeals, Fourth Circuit (04ca)), `05ca` (U.S. Court of Appeals, Fifth Circuit (05ca)), `06ca` (U.S. Court of Appeals, Sixth Circuit (06ca)), `07ca` (U.S. Court of Appeals, Seventh Circuit (07ca)), `08ca` (U.S. Court of Appeals, Eighth Circuit (08ca)), `09bap` (U.S. Court of Appeals, Ninth Circuit BAP (09bap)), and 324 more.
- Kind of case (`jurisdiction_type`, text): Only civil, criminal, bankruptcy, appellate or multidistrict cases. One of: `cv` (Civil), `cr` (Criminal), `bk` (Bankruptcy), `ap` (Appellate), `mdl` (Multidistrict litigation (JPML)).
- Filed on or after (`filed_from`, date): Only cases filed on or after this date.
- Filed on or before (`filed_to`, date): Only cases filed on or before this date.
- Case number (`case_number`, text): The case number, whole or in part, such as 1:15-cv-01445 or 15-1445. PACER accepts yy-nnnnn, yy-tp-nnnnn and o:yy-tp-nnnnn forms. Pick a court too, since the same number exists in many courts.
- Party roles (`party_roles`, text): Only parties with these court role codes, comma separated, such as db for debtor or dft for defendant. Courts set their own codes, and appellate cases have none, so a role leaves them out.
- Case types (`case_types`, list): Only these case type codes. Courts assign their own, so a code can mean different things in different courts. One or more of: `ap` (Adversary proceeding or appeal (ap)), `bk` (Bankruptcy (bk)), `cr` (Criminal (cr)), `cv` (Civil (cv)), `mc` (Miscellaneous (mc)), `mj` (Magistrate judge (mj)), `po` (Petty offense (po)), `1453c`, `158d`, `2255`, and 60 more.
- Natures of suit (`nature_of_suit`, list): Only civil or appellate cases with these natures of suit, such as 830 Patent. One or more of: `100` (100 Contract - Construction (CDA)), `102` (102 Contract - Fail to Award (CDA)), `104` (104 Contract - Lease (CDA)), `106` (106 Contract - Maintenance (CDA)), `108` (108 Contract - Renovation (CDA)), `110` (110 Insurance), `112` (112 Contract - Sale (CDA)), `114` (114 Contract - Service (CDA)), `116` (116 Contract - Supply (CDA)), `118` (118 Contract - Other (CDA)), and 580 more.
- Bankruptcy chapters (`bankruptcy_chapters`, list): Only bankruptcy cases under these chapters. One or more of: `7` (Chapter 7 (liquidation)), `9` (Chapter 9 (municipalities)), `11` (Chapter 11 (reorganization)), `13` (Chapter 13 (individual debt adjustment)), `15` (Chapter 15 (cross-border)), `304` (Chapter 304 (replaced by chapter 15)).
- Closed on or after (`closed_from`, date): Only cases closed on or after this date.
- Closed on or before (`closed_to`, date): Only cases closed on or before this date.
- Sort by (`sort`, text): The order of the results. Leave empty for PACER's own order. One of: `lastName,ASC` (Last name, A to Z), `caseYear,DESC` (Newest case year first), `courtId,ASC` (Court).
- Page (`page`, number): Which page of 54 results, from 1. Each page is a separate search that PACER bills. Leave empty for the first. From 1 to 100.

**Outputs**

- `billable_pages` (number): The pages PACER billed for this search
- `fee` (number): What PACER billed for this search, in dollars
- `next_page` (number): The next page's number, or null on the last page
- `page` (number): This page's number, from 1
- `parties` (list): The parties on this page
- `receipt` (object): PACER's receipt for the search
- `total_pages` (number): How many pages there are
- `total_results` (number): How many results there are in all

**Example output**

```json
{
  "billable_pages": 1,
  "fee": 0.1,
  "next_page": null,
  "page": 1,
  "parties": [
    {
      "bankruptcyChapter": "7",
      "caseId": 144631,
      "caseLink": "https://ecf.laeb.uscourts.gov/cgi-bin/iqquerymenu.pl?144631",
      "caseNumber": 10011,
      "caseNumberFull": "2:2006bk10011",
      "caseOffice": "2",
      "caseTitle": "Sample Client",
      "caseType": "bk",
      "caseYear": 2006,
      "courtCase": {
        "bankruptcyChapter": "7",
        "caseId": 144631,
        "caseLink": "https://ecf.laeb.uscourts.gov/cgi-bin/iqquerymenu.pl?144631",
        "caseNumber": 10011,
        "caseNumberFull": "2:2006bk10011",
        "caseOffice": "2",
        "caseTitle": "Sample Client",
        "caseType": "bk",
        "caseYear": 2006,
        "courtId": "laebk",
        "dateDischarged": null,
        "dateDismissed": "2006-01-20",
        "dateFiled": "2006-01-06",
        "dateReopened": null,
        "dateTermed": "2006-02-03",
        "effectiveDateClosed": "2006-02-03",
        "jointBankruptcyFlag": "n",
        "jurisdictionType": "Bankruptcy",
        "natureOfSuit": null
      },
      "courtId": "laebk",
      "dateDischarged": null,
      "dateDismissed": "2006-01-20",
      "dateFiled": "2006-01-06",
      "dateReopened": null,
      "dateTermed": "2006-02-03",
      "disposition": "Dismissed for Other Reason",
      "effectiveDateClosed": "2006-02-03",
      "firstName": "Matt",
      "generation": " ",
      "jointBankruptcyFlag": "n",
      "jurisdictionType": "Bankruptcy",
      "lastName": "Smith",
      "middleName": " ",
      "natureOfSuit": null,
      "partyRole": "db",
      "partyType": "pty"
    }
  ],
  "receipt": {
    "billablePages": 1,
    "clientCode": "",
    "csoId": 3655344,
    "description": "All Court Types Case Search",
    "firmId": "",
    "loginId": "yourpacerusername",
    "reportId": "6c08ede4-ee24-4350-b607-a4ebd8d694ac",
    "search": "All Courts; Case Number 90150; Case Year 2000; Page: 1",
    "searchFee": ".10",
    "transactionDate": "2020-12-18T11:01:48.267-0600"
  },
  "total_pages": 1,
  "total_results": 1
}
```

### Sign out of PACER

End the PACER session Lodol keeps for this connection, such as at the end of a workflow. The next PACER step signs in again by itself.

**Inputs**: None.

**Outputs**

- `signed_out` (true/false): True if a session was ended; false if Lodol held none for this connection

**Example output**

```json
{
  "signed_out": true
}
```

### Start batch case search

Start a large case search, up to 108,000 cases, that PACER runs in the background. Download the results with 'Download batch case results'. Starting is free; PACER bills $0.10 a page of 54 results when they are downloaded, with no cap. Searches in the QA test environment are free.

**Inputs**

- Case number (`case_number`, text): The case number, whole or in part, such as 1:15-cv-01445 or 15-1445. PACER accepts yy-nnnnn, yy-tp-nnnnn and o:yy-tp-nnnnn forms. Pick a court too, since the same number exists in many courts.
- Case title starts with (`case_title`, text): Cases whose title starts with this, such as Jacob (which also finds Jacobs and Jacobson). Not case-sensitive. At least two characters, unless a date range of 30 days or fewer is given.
- Party last name or business (`party_last_name`, text): Cases with a party whose last name (or business name) starts with this.
- Party first name (`party_first_name`, text): With a party last name: the party's first name, or its start.
- Courts or regions (`courts`, list): Only these courts, or every court in a region (a state, district or circuit). Leave empty for every federal court. One or more of: `01bap` (U.S. Court of Appeals, First Circuit BAP (01bap)), `01ca` (U.S. Court of Appeals, First Circuit (01ca)), `02ca` (U.S. Court of Appeals, Second Circuit (02ca)), `03ca` (U.S. Court of Appeals, Third Circuit (03ca)), `04ca` (U.S. Court of Appeals, Fourth Circuit (04ca)), `05ca` (U.S. Court of Appeals, Fifth Circuit (05ca)), `06ca` (U.S. Court of Appeals, Sixth Circuit (06ca)), `07ca` (U.S. Court of Appeals, Seventh Circuit (07ca)), `08ca` (U.S. Court of Appeals, Eighth Circuit (08ca)), `09bap` (U.S. Court of Appeals, Ninth Circuit BAP (09bap)), and 324 more.
- Kind of case (`jurisdiction_type`, text): Only civil, criminal, bankruptcy, appellate or multidistrict cases. One of: `cv` (Civil), `cr` (Criminal), `bk` (Bankruptcy), `ap` (Appellate), `mdl` (Multidistrict litigation (JPML)).
- Filed on or after (`filed_from`, date): Only cases filed on or after this date.
- Filed on or before (`filed_to`, date): Only cases filed on or before this date.
- Case types (`case_types`, list): Only these case type codes. Courts assign their own, so a code can mean different things in different courts. One or more of: `ap` (Adversary proceeding or appeal (ap)), `bk` (Bankruptcy (bk)), `cr` (Criminal (cr)), `cv` (Civil (cv)), `mc` (Miscellaneous (mc)), `mj` (Magistrate judge (mj)), `po` (Petty offense (po)), `1453c`, `158d`, `2255`, and 60 more.
- Natures of suit (`nature_of_suit`, list): Only civil or appellate cases with these natures of suit, such as 830 Patent. One or more of: `100` (100 Contract - Construction (CDA)), `102` (102 Contract - Fail to Award (CDA)), `104` (104 Contract - Lease (CDA)), `106` (106 Contract - Maintenance (CDA)), `108` (108 Contract - Renovation (CDA)), `110` (110 Insurance), `112` (112 Contract - Sale (CDA)), `114` (114 Contract - Service (CDA)), `116` (116 Contract - Supply (CDA)), `118` (118 Contract - Other (CDA)), and 580 more.
- Bankruptcy chapters (`bankruptcy_chapters`, list): Only bankruptcy cases under these chapters. One or more of: `7` (Chapter 7 (liquidation)), `9` (Chapter 9 (municipalities)), `11` (Chapter 11 (reorganization)), `13` (Chapter 13 (individual debt adjustment)), `15` (Chapter 15 (cross-border)), `304` (Chapter 304 (replaced by chapter 15)).
- Closed on or after (`closed_from`, date): Only cases closed on or after this date.
- Closed on or before (`closed_to`, date): Only cases closed on or before this date.
- Dismissed on or after (`dismissed_from`, date): Only cases dismissed on or after this date.
- Dismissed on or before (`dismissed_to`, date): Only cases dismissed on or before this date.
- Discharged on or after (`discharged_from`, date): Only cases discharged on or after this date.
- Discharged on or before (`discharged_to`, date): Only cases discharged on or before this date.

**Outputs**

- `batch_search` (object): The batch search as PACER reports it
- `report_id` (number): The batch search's id
- `status` (text): Its status, such as RUNNING or COMPLETED

**Example output**

```json
{
  "batch_search": {
    "criteria": {
      "caseTitle": "Falls",
      "caseType": [],
      "courtId": [],
      "federalBankruptcyChapter": [],
      "natureOfSuit": [],
      "requestSource": "Other",
      "requestType": "Batch",
      "searchType": "COURT_CASE"
    },
    "downloadFee": null,
    "endTime": null,
    "pages": null,
    "recordCount": null,
    "reportId": 1078,
    "searchType": "COURT_CASE",
    "sort": {
      "orders": []
    },
    "startTime": null,
    "status": "RUNNING",
    "unbilledPageCount": null
  },
  "report_id": 1078,
  "status": "RUNNING"
}
```

### Start batch party search

Start a large party search, up to 108,000 parties, that PACER runs in the background. Download the results with 'Download batch party results'. Starting is free; PACER bills $0.10 a page of 54 results when they are downloaded, with no cap. Searches in the QA test environment are free.

**Inputs**

- Last name or business (`last_name`, text): The party's last name, or a business's name. Matches names that start with it unless Exact name match is on.
- First name (`first_name`, text): The party's first name, or its start.
- Middle name (`middle_name`, text): The party's middle name, or its start.
- Exact name match (`exact_name_match`, true/false): Only names exactly as typed, rather than names that start with it.
- Courts or regions (`courts`, list): Only these courts, or every court in a region (a state, district or circuit). Leave empty for every federal court. One or more of: `01bap` (U.S. Court of Appeals, First Circuit BAP (01bap)), `01ca` (U.S. Court of Appeals, First Circuit (01ca)), `02ca` (U.S. Court of Appeals, Second Circuit (02ca)), `03ca` (U.S. Court of Appeals, Third Circuit (03ca)), `04ca` (U.S. Court of Appeals, Fourth Circuit (04ca)), `05ca` (U.S. Court of Appeals, Fifth Circuit (05ca)), `06ca` (U.S. Court of Appeals, Sixth Circuit (06ca)), `07ca` (U.S. Court of Appeals, Seventh Circuit (07ca)), `08ca` (U.S. Court of Appeals, Eighth Circuit (08ca)), `09bap` (U.S. Court of Appeals, Ninth Circuit BAP (09bap)), and 324 more.
- Kind of case (`jurisdiction_type`, text): Only civil, criminal, bankruptcy, appellate or multidistrict cases. One of: `cv` (Civil), `cr` (Criminal), `bk` (Bankruptcy), `ap` (Appellate), `mdl` (Multidistrict litigation (JPML)).
- Filed on or after (`filed_from`, date): Only cases filed on or after this date.
- Filed on or before (`filed_to`, date): Only cases filed on or before this date.
- Case number (`case_number`, text): The case number, whole or in part, such as 1:15-cv-01445 or 15-1445. PACER accepts yy-nnnnn, yy-tp-nnnnn and o:yy-tp-nnnnn forms. Pick a court too, since the same number exists in many courts.
- Party roles (`party_roles`, text): Only parties with these court role codes, comma separated, such as db for debtor or dft for defendant. Courts set their own codes, and appellate cases have none, so a role leaves them out.
- Case types (`case_types`, list): Only these case type codes. Courts assign their own, so a code can mean different things in different courts. One or more of: `ap` (Adversary proceeding or appeal (ap)), `bk` (Bankruptcy (bk)), `cr` (Criminal (cr)), `cv` (Civil (cv)), `mc` (Miscellaneous (mc)), `mj` (Magistrate judge (mj)), `po` (Petty offense (po)), `1453c`, `158d`, `2255`, and 60 more.
- Natures of suit (`nature_of_suit`, list): Only civil or appellate cases with these natures of suit, such as 830 Patent. One or more of: `100` (100 Contract - Construction (CDA)), `102` (102 Contract - Fail to Award (CDA)), `104` (104 Contract - Lease (CDA)), `106` (106 Contract - Maintenance (CDA)), `108` (108 Contract - Renovation (CDA)), `110` (110 Insurance), `112` (112 Contract - Sale (CDA)), `114` (114 Contract - Service (CDA)), `116` (116 Contract - Supply (CDA)), `118` (118 Contract - Other (CDA)), and 580 more.
- Bankruptcy chapters (`bankruptcy_chapters`, list): Only bankruptcy cases under these chapters. One or more of: `7` (Chapter 7 (liquidation)), `9` (Chapter 9 (municipalities)), `11` (Chapter 11 (reorganization)), `13` (Chapter 13 (individual debt adjustment)), `15` (Chapter 15 (cross-border)), `304` (Chapter 304 (replaced by chapter 15)).
- Closed on or after (`closed_from`, date): Only cases closed on or after this date.
- Closed on or before (`closed_to`, date): Only cases closed on or before this date.

**Outputs**

- `batch_search` (object): The batch search as PACER reports it
- `report_id` (number): The batch search's id
- `status` (text): Its status, such as RUNNING or COMPLETED

**Example output**

```json
{
  "batch_search": {
    "criteria": {
      "lastName": "Smith",
      "searchType": "PARTY"
    },
    "downloadFee": null,
    "endTime": null,
    "pages": null,
    "recordCount": null,
    "reportId": 1078,
    "searchType": "PARTY",
    "sort": {
      "orders": []
    },
    "startTime": null,
    "status": "RUNNING",
    "unbilledPageCount": null
  },
  "report_id": 1078,
  "status": "RUNNING"
}
```
