Case Service¶
Service for performing case searches via the PACER Case Locator API.
- class pacersdk.services.case.CaseService(token_provider: Callable[[], str], config: dict, token: str | None = None)¶
Bases:
object
Provides access to the case search API endpoint.
- search(criteria: CourtCaseSearchCriteria, page: int = 0, sort: List[CaseField] | None = None) ReportList ¶
Perform a case search.
- Parameters:
criteria – CourtCaseSearchCriteria with optional filters.
page – Zero-based page number of results to fetch.
sort – Optional list of sort field/direction pairs.
- Returns:
ReportList containing search results.
- search_all(criteria: CourtCaseSearchCriteria, sort: List[CaseField] | None = None) Generator[ReportList, None, None] ¶
Perform a paginated case search and yield results page-by-page.
This method iterates over all available pages of results based on the initial search criteria.
- Parameters:
criteria (CourtCaseSearchCriteria) – The case search criteria including filters such as court ID, date range, etc.
sort (list[CaseField] or None) – Optional list of fields to sort the results by.
- Yield:
A ReportList dictionary containing case results for a single page.
- Return type:
Generator[ReportList, None, None]