Service Modules¶

Service for performing case searches via the PACER Case Locator API.

class pacersdk.services.case_search.CaseSearchService(token_provider: Callable[[], str], config: dict, token: str | None = None)¶

Provides access to the case search API endpoint.

search(criteria: CaseSearchRequest, page: int = 0, sort: List[SortableCaseField] | None = None) → CaseSearchResponse¶

Perform a case search.

Parameters:

criteria – CaseSearchRequest with optional filters.
page – Zero-based page number of results to fetch.
sort – Optional list of sort field/direction pairs.

Returns:

CaseSearchResponse containing search results.

Service for performing party searches via the PACER Case Locator API.

class pacersdk.services.party_search.PartySearchService(token_provider: Callable[[], str], config: dict, token: str | None = None)¶

Provides access to the party search API endpoint.

search(criteria: PartySearchRequest, page: int = 0, sort: List[SortablePartyField] | None = None) → PartySearchResponse¶

Perform a party search.

Parameters:

criteria – PartySearchRequest with optional filters.
page – Zero-based page number of results to fetch.
sort – Optional list of sort field/direction pairs.

Returns:

PartySearchResponse containing search results.

Service for submitting and managing batch case searches.

class pacersdk.services.batch_case_search.BatchCaseSearchService(token_provider: Callable[[], str], config: dict, token: str | None = None)¶

Provides access to the batch case search API endpoint.

delete(report_id: str) → dict¶

Delete a submitted batch case report by ID.

Parameters:: report_id – Batch report identifier.
Returns:: Response status or message.

download(report_id: str) → dict¶

Download results of a completed batch case search job.

Parameters:: report_id – The report identifier.
Returns:: JSON response containing case data.

listall() → dict¶

Retrieve a list of all current batch case jobs.

Returns:: Response status or message.

status(report_id: str) → dict¶

Query the status of a batch case search job.

Parameters:: report_id – The report identifier.
Returns:: JSON status response.

submit(request: BatchCaseRequest) → BatchCaseResponse¶

Submit a batch case search job.

Parameters:: request – A batch case search request model.
Returns:: A BatchCaseResponse dictionary.

Service for submitting and managing batch party searches.

class pacersdk.services.batch_party_search.BatchPartySearchService(token_provider: Callable[[], str], config: dict, token: str | None = None)¶

Provides access to the batch party search API endpoint.

delete(report_id: str) → dict¶

Delete a submitted batch party report by ID.

Parameters:: report_id – Batch report identifier.
Returns:: Response status or message.

download(report_id: str) → dict¶

Download results of a completed batch party search job.

Parameters:: report_id – The report identifier.
Returns:: JSON response containing party data.

listall() → dict¶

Retrieve a list of all current batch party jobs.

Returns:: Response status or message.

status(report_id: str) → dict¶

Query the status of a batch party search job.

Parameters:: report_id – The report identifier.
Returns:: JSON status response.

submit(request: BatchPartyRequest) → BatchPartyResponse¶

Submit a batch party search job.

Parameters:: request – A batch party search request model.
Returns:: A BatchPartyResponse dictionary.