ct_set_key: Set the Comtrade API Key
In comtrade: Access and Analyse UN Comtrade International Trade Data
ct_set_key R Documentation
Set the Comtrade API Key
Description
Store your UN Comtrade API key for the current session. The key is saved
as an R option and optionally as an environment variable for persistence.
Usage
ct_set_key(key, install = FALSE)
Arguments
key
Character. Your Comtrade API subscription key.
install
Logical. If TRUE, also sets the COMTRADE_API_KEY
environment variable via Sys.setenv(), which persists for the
current R session. For permanent storage, add
COMTRADE_API_KEY=your-key to your .Renviron file. Default FALSE.
Details
Get a free API key at https://comtradedeveloper.un.org/. The free
tier allows 500 calls per day and up to 100,000 records per call.
Value
Invisibly returns the key.
Examples
ct_set_key("your-subscription-key-here")
comtrade documentation built on April 13, 2026, 5:07 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| ct_set_key | R Documentation |
Set the Comtrade API Key
Description
Store your UN Comtrade API key for the current session. The key is saved as an R option and optionally as an environment variable for persistence.
Usage
ct_set_key(key, install = FALSE)
Arguments
key |
Character. Your Comtrade API subscription key. |
install |
Logical. If |
Details
Get a free API key at https://comtradedeveloper.un.org/. The free tier allows 500 calls per day and up to 100,000 records per call.
Value
Invisibly returns the key.
Examples
ct_set_key("your-subscription-key-here")
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.