Client API¶

Client interface to the PACER Case Locator API.

class pacersdk.client.PCLClient(username: str, password: str, secret: str = None, environment: str = 'prod', client_code: str = None, redaction: bool = False, config_path: str = None)¶

Bases: object

Entry point for interacting with the PACER Case Locator API.

delete_batch_case(report_id: str) → dict¶

Delete a batch case search request by report ID.

Parameters:: report_id – The report identifier.
Returns:: Dictionary with deletion status.

delete_batch_party(report_id: str) → dict¶

Delete a batch party search request by report ID.

Parameters:: report_id – The report identifier.
Returns:: Dictionary with deletion status.

get_batch_case_results(report_id: str) → dict¶

Download results for a completed batch case search.

Parameters:: report_id – The report identifier.
Returns:: Dictionary containing search results.

get_batch_case_status(report_id: str) → dict¶

Retrieve the status of a batch case search.

Parameters:: report_id – The report identifier.
Returns:: Dictionary with batch job status.

get_batch_party_results(report_id: str) → dict¶

Download results for a completed batch party search.

Parameters:: report_id – The report identifier.
Returns:: Dictionary containing search results.

get_batch_party_status(report_id: str) → dict¶

Retrieve the status of a batch party search.

Parameters:: report_id – The report identifier.
Returns:: Dictionary with batch job status.

list_batch_case_jobs() → dict¶

List all current batch case jobs.

Returns:: Dictionary containing all current batch results.

list_batch_party_jobs() → dict¶

List all current batch party jobs.

Returns:: Dictionary containing all current batch results.

logout()¶: Log out of the session and revoke the token.

search_cases(criteria: CaseSearchRequest, page: int = 0, sort: dict = None) → CaseSearchResponse¶

Perform a case search.

Parameters:

criteria – Dictionary of case search filters.
page – Optional zero-based page number.
sort – Optional list of sort field/direction pairs.

Returns:

CaseSearchResponse containing matching results.

search_parties(criteria: PartySearchRequest, page: int = 0, sort: dict = None) → PartySearchResponse¶

Perform a party search.

Parameters:

criteria – Dictionary of party search filters.
page – Optional zero-based page number.
sort – Optional list of sort field/direction pairs.

Returns:

PartySearchResponse containing matching results.

submit_batch_case(request: BatchCaseRequest) → BatchCaseResponse¶

Submit a batch case search.

Parameters:: request – BatchCaseRequest with case search filters.
Returns:: BatchCaseResponse containing the report ID.

submit_batch_party(request: BatchPartyRequest) → BatchPartyResponse¶

Submit a batch party search.

Parameters:: request – BatchPartyRequest with party search filters.
Returns:: BatchPartyResponse containing the report ID.