pyclerk.endpoints package¶
Submodules¶
pyclerk.endpoints.bulk module¶
-
class
pyclerk.endpoints.bulk.BulkEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.cases module¶
-
class
pyclerk.endpoints.cases.CasesEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint-
browse_or_search_cases(parameters: dict) → tuple¶ API call to browse or search all available cases :param parameters: dict of parameters to include in the API call :return: tuple of (dict, APIResponse), or (dict, None) if no casebody data
-
single_case(case_id: int, full_case: bool = True) → tuple¶ API Call to return a single case. :param case_id: Caselaw Access Project ID of the desired case :param full_case: True to return the case body, False to return only metadata :return: tuple of (dict, APIResponse), or (dict, None) if no casebody data
-
pyclerk.endpoints.citations module¶
-
class
pyclerk.endpoints.citations.CitationsEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.courts module¶
-
class
pyclerk.endpoints.courts.CourtsEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.jurisdictions module¶
-
class
pyclerk.endpoints.jurisdictions.JurisdictionsEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.ngrams module¶
-
class
pyclerk.endpoints.ngrams.NgramsEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.reporters module¶
-
class
pyclerk.endpoints.reporters.ReportersEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.user_history module¶
-
class
pyclerk.endpoints.user_history.UserHistoryEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint
pyclerk.endpoints.volumes module¶
-
class
pyclerk.endpoints.volumes.VolumesEndpoint(access_token: str = 'abcd12345', api_version: int = 1, body_format: str = 'text')¶ Bases:
pyclerk.endpoints._endpoint.Endpoint