Core¶

Low-level function for querying any API endpoint.

request ¶

request(
    endpoint: str,
    *,
    clean_names: bool = True,
    max_tries: int = 3,
    timeout: float = 60.0,
    progress: Optional[bool] = None,
    verbose: Optional[bool] = None,
    **params: Any
) -> pd.DataFrame

Send a GET request to any TCE-PE endpoint and return a DataFrame.

Parameters:

Name	Type	Description	Default
`endpoint`	`str`	API method name, e.g. `"Contratos"` or `"DespesasEstaduais"`.	required
`clean_names`	`bool`	Convert column names to snake_case (default True).	`True`
`max_tries`	`int`	Max attempts on transient failures (default 3).	`3`
`timeout`	`float`	Per-request timeout in seconds (default 60).	`60.0`
`progress`	`Optional[bool]`	Override :data:`tcepepy.config` for this call.	`None`
`verbose`	`Optional[bool]`	Override :data:`tcepepy.config` for this call.	`None`
`**params`	`Any`	Query parameters, using either the API name (`CodigoEfiscoUG`) or its snake_case alias (`codigo_efisco_ug`). `None` values are dropped.	`{}`

Returns:

Type	Description
`DataFrame`	Empty if the query matched no records.