Custom Connector
WTO Connector
Global
The WTO Connector provides seamless access to the World Trade Organization (WTO), enabling retrieval of international trade and tariff data, metadata, and reference information. It standardizes requests to the WTO Timeseries through a unified proxy, letting developers query topics, indicators, territories, and trade data.
Overview
Integration Overview
This document provides a detailed description of each integration endpoint, configuration, and workflow supported by the WTO Connector. All endpoints require a subscription key and are configured with the WTO base URL.
- getTopics. Retrieves available topics.
- getFrequencies. Lists supported data frequencies.
- getPeriods. Lists available time periods.
- getUnits. Retrieves available measurement units.
- getIndicatorCategories. Lists categories of trade indicators.
- getIndicators. Returns available indicators.
- getTerritoryRegions. Lists WTO territory regions.
- getTerritoryGroups. Lists WTO territory groups.
- getReporters. Lists reporting members or regions.
- getPartners. Lists partner members or regions.
- getProductClassifications. Lists available product classifications.
- getProducts. Returns available products.
- getYears. Lists available reporting years.
- getValueFlags. Lists value flags for trade data.
- getData. Retrieves trade data for given parameters.
- postData. Posts a data request (JSON body).
- getMetadata. Retrieves metadata about datasets.
- getDataCount. Returns counts for requested data queries.
Documentation
Detailed Integration Documentation
Topics
| Action | getTopics |
|---|---|
| Endpoint | /topics |
| Method | GET |
| Purpose | Retrieves a list of available topics such as tariffs, trade in goods, or trade in services. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
| Configuration | Configure the WTO base URL via CONNECTOR_ENV_WTO_BASE_URL. |
Frequencies
| Action | getFrequencies |
|---|---|
| Endpoint | /frequencies |
| Method | GET |
| Purpose | Retrieves available data frequencies such as Annual, Quarterly, or Monthly. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Periods
| Action | getPeriods |
|---|---|
| Endpoint | /periods |
| Method | GET |
| Purpose | Retrieves all available reporting periods for trade data. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Units
| Action | getUnits |
|---|---|
| Endpoint | /units |
| Method | GET |
| Purpose | Retrieves available units of measurement used in WTO data (e.g. USD, Index). |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Indicator Categories
| Action | getIndicatorCategories |
|---|---|
| Endpoint | /indicator_categories |
| Method | GET |
| Purpose | Retrieves the main categories under which indicators are organized. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Indicators
| Action | getIndicators |
|---|---|
| Endpoint | /indicators |
| Method | GET |
| Purpose | Retrieves indicators filtered by topic, frequency, or product classification. |
| Parameters | Required: subscription-key. Optional: i (indicator code, e.g. HS_A_001); name; t (topic ID); pc (product classification, e.g. HS); tp (time-period type); frq (frequency, e.g. A); lang. |
Territory Regions
| Action | getTerritoryRegions |
|---|---|
| Endpoint | /territory/regions |
| Method | GET |
| Purpose | Retrieves WTO-recognized regional groupings. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Territory Groups
| Action | getTerritoryGroups |
|---|---|
| Endpoint | /territory/groups |
| Method | GET |
| Purpose | Retrieves groups such as “Developed economies” or “LDCs”. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Reporters
| Action | getReporters |
|---|---|
| Endpoint | /reporters |
| Method | GET |
| Purpose | Retrieves countries or regions reporting trade data. |
| Parameters | Required: subscription-key. Optional: name (e.g. Pakistan); ig (indicator group); reg (region code); gp (group code); lang. |
Partners
| Action | getPartners |
|---|---|
| Endpoint | /partners |
| Method | GET |
| Purpose | Retrieves partner countries or entities in trade datasets. |
| Parameters | Required: subscription-key. Optional: name; ig; reg; gp; lang. |
Product Classifications
| Action | getProductClassifications |
|---|---|
| Endpoint | /product_classifications |
| Method | GET |
| Purpose | Retrieves classification systems used for WTO data (e.g. HS, BEC, ISIC). |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Products
| Action | getProducts |
|---|---|
| Endpoint | /products |
| Method | GET |
| Purpose | Retrieves available products filtered by classification or name. |
| Parameters | Required: subscription-key. Optional: name (e.g. Oil); pc (product classification, e.g. HS); lang. |
Years
| Action | getYears |
|---|---|
| Endpoint | /years |
| Method | GET |
| Purpose | Lists all available years for which data is provided. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Value Flags
| Action | getValueFlags |
|---|---|
| Endpoint | /value_flags |
| Method | GET |
| Purpose | Returns value flags describing data reliability or status (e.g. estimated, provisional). |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Data (GET)
| Action | getData |
|---|---|
| Endpoint | /data |
| Method | GET |
| Purpose | Retrieves WTO data for specific indicators, reporters, and partners. |
| Parameters | Required: subscription-key. Optional: i (indicator, e.g. HS_A_001); r (reporter, e.g. 840); p (partner, e.g. 586); ps (period, e.g. 2023); pc (product classification); fmt (e.g. json); max (e.g. 100); lang. |
Data (POST)
| Action | postData |
|---|---|
| Endpoint | /data |
| Method | GET |
| Purpose | Allows data queries via a JSON payload. |
| Parameters | Method: POST. Required: subscription-key. Optional (JSON body): i (indicator list); r (reporter codes); p (partner codes); ps (years list). |
Metadata
| Action | getMetadata |
|---|---|
| Endpoint | /metadata |
| Method | GET |
| Purpose | Retrieves metadata describing indicators, datasets, or reporting structures. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Data Count
| Action | getDataCount |
|---|---|
| Endpoint | /data_count |
| Method | GET |
| Purpose | Returns the total count of data records available for a given query. |
| Parameters | Required: subscription-key — your API key. Optional: lang — response language (e.g. en). |
Example Workflow: Trade Data Analysis
| Topic & indicator retrieval | Use /topics and /indicators to list available trade indicators; filter by topic and frequency. |
|---|---|
| Fetch trade data | Call /data for statistics on selected indicators, using r (reporter), p (partner), and ps (period). |
| Metadata & reference lookup | Retrieve /metadata, /years, and /units for context, and /value_flags to interpret reliability. |
| GCP integration | Deploy in Cloud Run or App Engine and connect via Apigee or Workflows using CONNECTOR_ENV_WTO_BASE_URL, CONNECTOR_ENV_WTO_API_KEY, and CONNECTOR_ENV_PORT. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.