Skip to content

CourtAPI/courtapi-javascript-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
docs
docs
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
git_push.sh
git_push.sh
 
 
mocha.opts
mocha.opts
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

Repository files navigation

court_api

CourtApi - JavaScript client for court_api Automate PACER Access This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.9.2
  • Package version: 0.9.2
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install court_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your court_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('court_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CourtApi = require('court_api');

var defaultClient = CourtApi.ApiClient.instance;

// Configure HTTP basic authorization: www-authenticate
var www-authenticate = defaultClient.authentications['www-authenticate'];
www-authenticate.username = 'YOUR USERNAME'
www-authenticate.password = 'YOUR PASSWORD'

var api = new CourtApi.CaseApi()

var courtCode = "courtCode_example"; // {String} Court Code

var caseNumber = "caseNumber_example"; // {String} Case Number


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAssociatedCases(courtCode, caseNumber, callback);

Documentation for API Endpoints

All URIs are relative to https://train.v1.courtapi.com

Class Method HTTP request Description
CourtApi.CaseApi getAssociatedCases GET /cases/pacer/{court_code}/{case_number}/associated_cases Cases related to the case or lead case
CourtApi.CaseApi getAttorneys GET /cases/pacer/{court_code}/{case_number}/attorneys Attorney personal info as well as the party(s) they represent
CourtApi.CaseApi getCaseMenu GET /cases/pacer/{court_code}/{case_number} Case Root Menu
CourtApi.CaseApi getClaim GET /cases/pacer/{court_code}/{case_number}/claims/{claim_no} Case Claim Entry
CourtApi.CaseApi getClaimDocument GET /cases/pacer/{court_code}/{case_number}/claims/{claim_no}/documents/{claim_seq_no}/{part_no} ClaimSelect Order PDF
CourtApi.CaseApi getClaimParts GET /cases/pacer/{court_code}/{case_number}/claims/{claim_no}/documents/{claim_seq_no} Claim Entry Document Parts
CourtApi.CaseApi getClaims GET /cases/pacer/{court_code}/{case_number}/claims Case Claims from Local DB
CourtApi.CaseApi getClaimsHeader GET /cases/pacer/{court_code}/{case_number}/claims/header Case Claims Header
CourtApi.CaseApi getCreditorMailingMatrix GET /cases/pacer/{court_code}/{case_number}/creditor_mailing Creditor mailing matrix for case
CourtApi.CaseApi getCreditors GET /cases/pacer/{court_code}/{case_number}/creditors All creditors for case
CourtApi.CaseApi getDocketDocument GET /cases/pacer/{court_code}/{case_number}/dockets/{docket_no}/documents/{part_no} DocketSelect Order PDF
CourtApi.CaseApi getDocketDocuments GET /cases/pacer/{court_code}/{case_number}/dockets/{docket_no}/documents DocumentSelect Documents
CourtApi.CaseApi getDocketEntry GET /cases/pacer/{court_code}/{case_number}/dockets/{docket_no} Case Dockets Entry
CourtApi.CaseApi getDocketHeader GET /cases/pacer/{court_code}/{case_number}/dockets/header Case Dockets Header
CourtApi.CaseApi getDockets GET /cases/pacer/{court_code}/{case_number}/dockets Case Dockets from Local DB
CourtApi.CaseApi getFilers GET /cases/pacer/{court_code}/{case_number}/filers All filers for case
CourtApi.CaseApi getHeaders GET /cases/pacer/{court_code}/{case_number}/headers Case Headers
CourtApi.CaseApi getMenu GET /cases/pacer/{court_code}/{case_number}/menu Available menus in PACER for case
CourtApi.CaseApi getNotice GET /cases/pacer/{court_code}/{case_number}/notice Case Notice of Bankruptcy Filings
CourtApi.CaseApi getParties GET /cases/pacer/{court_code}/{case_number}/parties All parties for case
CourtApi.CaseApi getPartyAliases GET /cases/pacer/{court_code}/{case_number}/alias Parties with alias for case
CourtApi.CaseApi getPendingStatus GET /cases/pacer/{court_code}/{case_number}/status_pending Pending status for case
CourtApi.CaseApi getSchedule GET /cases/pacer/{court_code}/{case_number}/schedule Schedule for case
CourtApi.CaseApi getSummary GET /cases/pacer/{court_code}/{case_number}/case_summary Case summary for case
CourtApi.CaseApi getTrustees GET /cases/pacer/{court_code}/{case_number}/trustees Trustees for case
CourtApi.CaseLookupApi searchByCaseNumber GET /cases/pacer/search/case_no/{case_number} Case Search by Case Number
CourtApi.CaseLookupApi searchByPartyTitle GET /cases/pacer/search/party_title Case Search by Case Title or Party Name
CourtApi.CourtsApi getCourtDetails GET /courts/pacer/{court_code} PACER Court Details
CourtApi.CourtsApi getCourts GET /courts/pacer All PACER Courts
CourtApi.NclApi getAppellateSearchResults GET /pacer/ncl/appellate/{search_id} PACER NCL Appellate Case Search Result Navigation
CourtApi.NclApi getBankruptcySearchResults GET /pacer/ncl/bankruptcy/{search_id} PACER NCL Bankruptcy Case Search Result Navigation
CourtApi.NclApi getCivilSearchResults GET /pacer/ncl/civil/{search_id} PACER NCL Civil Case Search Result Navigation
CourtApi.NclApi getCriminalSearchResults GET /pacer/ncl/criminal/{search_id} PACER NCL Criminal Case Search Result Navigation
CourtApi.NclApi getMDLSearchResults GET /pacer/ncl/mdl/{search_id} PACER NCL MDL Case Search Result Navigation
CourtApi.NclApi searchAppellateCases POST /pacer/ncl/appellate PACER NCL Appellate Case Search
CourtApi.NclApi searchBankruptcyCases POST /pacer/ncl/bankruptcy PACER NCL Bankruptcy Case Search
CourtApi.NclApi searchCivilCases POST /pacer/ncl/civil PACER NCL Civil Case Search
CourtApi.NclApi searchCriminalCases POST /pacer/ncl/criminal PACER NCL Criminal Case Search
CourtApi.NclApi searchMDLCases POST /pacer/ncl/mdl PACER NCL MDL Case Search
CourtApi.PacerCaseLookupApi searchBankruptcyCases POST /courts/pacer/{court_code}/cases/report/bankruptcy Local Court Bankruptcy Cases Report
CourtApi.PacerCaseLookupApi searchCivilCases POST /courts/pacer/{court_code}/cases/report/civil Local Court Civil Cases Report
CourtApi.PacerCaseLookupApi searchCourtCases POST /courts/pacer/{court_code}/cases/search Local Court Case Search
CourtApi.PacerCaseLookupApi searchCriminalCases POST /courts/pacer/{court_code}/cases/report/criminal Local Court Criminal Cases Report
CourtApi.PacerCredentialsApi checkPacerCredentials POST /pacer/credentials/validate Validate Credentials
CourtApi.PacerCredentialsApi deleteCredentials DELETE /pacer/credentials Delete Credentials
CourtApi.PacerCredentialsApi getCredentials GET /pacer/credentials Get Credentials
CourtApi.PacerCredentialsApi saveCredentials POST /pacer/credentials Create/Update Credentials
CourtApi.QueryApi buyClaimDocument POST /cases/pacer/{court_code}/{case_number}/claims/{claim_no}/documents/{claim_seq_no}/{part_no} Purchase Claim Entry Document from PACER
CourtApi.QueryApi buyDocketDocument POST /cases/pacer/{court_code}/{case_number}/dockets/{docket_no}/documents/{part_no} DocketSelect Order PDF
CourtApi.QueryApi updateAssociatedCases POST /cases/pacer/{court_code}/{case_number}/associated_cases PACER Query Case Associated Cases
CourtApi.QueryApi updateAttorneys POST /cases/pacer/{court_code}/{case_number}/attorneys PACER Query Case Attorneys
CourtApi.QueryApi updateCaseFileLocation POST /cases/pacer/{court_code}/{case_number}/case_file_location PACER Query Case File Location
CourtApi.QueryApi updateCaseSummary POST /cases/pacer/{court_code}/{case_number}/case_summary PACER Query Case Summary
CourtApi.QueryApi updateClaimParts POST /cases/pacer/{court_code}/{case_number}/claims/{claim_no}/documents/{claim_seq_no} Purchase Claim Entry Document Parts from PACER
CourtApi.QueryApi updateClaims POST /cases/pacer/{court_code}/{case_number}/claims/update PACER Query Case Claims
CourtApi.QueryApi updateCreditorMailingMatrix POST /cases/pacer/{court_code}/{case_number}/creditor_mailing PACER Query Case Creditor Mailing
CourtApi.QueryApi updateCreditors POST /cases/pacer/{court_code}/{case_number}/creditors PACER Query Case Creditors
CourtApi.QueryApi updateDocketDocuments POST /cases/pacer/{court_code}/{case_number}/dockets/{docket_no}/documents DocumentSelect Documents
CourtApi.QueryApi updateDockets POST /cases/pacer/{court_code}/{case_number}/dockets/update PACER Query Case Dockets
CourtApi.QueryApi updateFilers POST /cases/pacer/{court_code}/{case_number}/filers PACER Query Case Filers
CourtApi.QueryApi updateHistory POST /cases/pacer/{court_code}/{case_number}/history PACER Query Case History
CourtApi.QueryApi updateMenu POST /cases/pacer/{court_code}/{case_number}/menu PACER Query Case Menu
CourtApi.QueryApi updateNotice POST /cases/pacer/{court_code}/{case_number}/notice PACER Query Case Notice
CourtApi.QueryApi updateParties POST /cases/pacer/{court_code}/{case_number}/parties PACER Query Case Parties
CourtApi.QueryApi updatePartyAliases POST /cases/pacer/{court_code}/{case_number}/alias PACER Query Case Alias
CourtApi.QueryApi updatePendingStatus POST /cases/pacer/{court_code}/{case_number}/status_pending PACER Query Case Status Pending
CourtApi.QueryApi updateRelatedTransactions POST /cases/pacer/{court_code}/{case_number}/related_transactions PACER Query Case Related Transactions
CourtApi.QueryApi updateSchedule POST /cases/pacer/{court_code}/{case_number}/schedule PACER Query Case Schedule
CourtApi.QueryApi updateTrustees POST /cases/pacer/{court_code}/{case_number}/trustees PACER Query Case Trustees

Documentation for Models

Documentation for Authorization

www-authenticate

  • Type: HTTP basic authentication

About

A JavaScript client library for CourtAPI

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages