Endpoint catalog¶

Discover endpoints and inspect input/output fields from the built-in catalog (offline).

catalog(search: Optional[str] = None) -> pd.DataFrame

List the available API endpoints.

Parameters:

Name	Type	Description	Default
`search`	`Optional[str]`	Optional case-insensitive substring to filter by endpoint name or description (e.g. `"licit"` for procurement endpoints).	`None`

Returns:

Type	Description
`DataFrame`	Columns `endpoint`, `group`, `title` and `url`.

endpoint(name: str) -> Dict[str, Any]

Return the full catalog metadata dict for a single endpoint.

params(name: str) -> pd.DataFrame

List the input parameters accepted by an endpoint.

Returns a DataFrame with api_name (exact API spelling), r_name (snake_case alias you may also pass), required, type and description.

fields(name: str) -> pd.DataFrame

List the output columns returned by an endpoint.

Returns a DataFrame with name (raw API name), r_name (the snake_case column name you get back when clean_names=True), type and description.