API Builder
API Builder lets you create ARAD-REST-API calls directly in the interface. You do not need to construct URLs manually or know all the service parameters.
The builder guides you through selecting a service, configuring its parameters, choosing an API key and generating the final call.
1. Selecting a service
First, choose the service you want to use.
Examples:
| Service | Purpose |
|---|---|
/data | A simple list of data: indicator, period, value. |
/data-trans | Data in pivot table format. |
/indicators | A list of indicators and their basic properties. |
/indicators-dims | Indicators described by their base and dimensions. |
/snapshots | A list of available snapshots. |
/indicators-tree | Indicator locations in the ARAD tree hierarchy. |
/updates | Information about the last update and the first and last periods of a time series. |
2. Configuring parameters
After selecting a service, a parameter form appears. Available parameters depend on the selected service.
For data services, you can configure, for example:
- data identification,
- indicator codes,
- the period range,
- the column delimiter,
- the decimal separator,
- a list of snapshots,
- period sorting.
Selecting a set from a dialog
API Builder lets you choose the set parameter from a dialog listing the available sets. This helps if you do not know the set code by heart.
3. Selecting an API key
You must select an API key to use the API. It identifies the user calling the service. See How do I get an API key?.
API key security
Never include an API key in public documentation, screenshots, repositories or shared examples. Hide the key or replace it with a placeholder in screenshots.
4. The generated API call
After you configure the parameters, API Builder creates a ready-to-use call. You can view it in several formats:
- URL,
- cURL,
- Python,
- R.
Prefilling API Builder
You can prefill API Builder from several places in the application:
- an indicator preview,
- the basket,
- My selections.
This speeds up creating an API request for the indicators you are currently working with in the interface.
