Party Service¶
Service for performing party searches via the PACER Case Locator API.
- class pacersdk.services.party.PartyService(token_provider: Callable[[], str], config: dict, token: str | None = None)¶
Bases:
object
Provides access to the party search API endpoint.
- search(criteria: PartySearchCriteria, page: int = 0, sort: List[PartyField] | None = None) ReportList ¶
Perform a party search.
- Parameters:
criteria – PartySearchCriteria 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: PartySearchCriteria, sort: List[PartyField] | None = None) Generator[ReportList, None, None] ¶
Perform a paginated party search and yield results page-by-page.
This method iterates over all available pages of results based on the initial search criteria.
- Parameters:
criteria (PartySearchCriteria) – The party search criteria including filters such as court ID, date range, etc.
sort (list[PartyField] 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]