The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

Exploring endpoints, parameters, and fields

Note — Code chunks are shown but not executed at build time (eval = FALSE). The discovery snippets (tce_catalog(), tce_params(), tce_fields()) work offline anywhere and can be run as-is from any network. The query snippets require a Brazilian IP (the TCE-PE API is geo-restricted).

This vignette shows how to discover endpoints and their input/output metadata using the built-in catalog shipped with tceper.

Discover endpoints with `tce_catalog()`

library(tceper)

tce_catalog()

Filter by keyword:

tce_catalog(search = "licit")

Inspect one endpoint

Pick an endpoint name from tce_catalog(). For instance, LicitacaoUG:

Input parameters

tce_params("LicitacaoUG")

api_name is the exact query name expected by the API.

r_name is the snake_case name you can pass to the R wrapper.

Output fields

tce_fields("LicitacaoUG")

Query using `snake_case` arguments

Once you know which parameters exist, you can query with snake_case arguments (the package maps them to api_name internally).

tce_bids(anomodalidade = "2025")

Parameter validation

tceper validates query parameters against the endpoint catalog. If you pass a parameter that does not exist for that endpoint, it aborts and shows the allowed parameter list.

# Example (invalid parameter name for this endpoint):
tce_contracts(fog = "510101", verbose = TRUE)

To avoid this, inspect allowed parameters first:

tce_params("Contratos")

Working with cache

Many wrapper functions can cache results in-memory for faster repeated calls.

You can inspect cache state with:

tce_cache_info()

And clear it with:

tce_cache_clear()

When verbose = TRUE, cache hits may print a short message indicating the returned object comes from cache.

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.