Timeseries API

API change history

WTO Data extraction API. You can use it to download in JSON or CSV format a larger data series or to integrate WTO Data into your web pages.
Comma separated values are considered inclusive (logical OR).

01. Timeseries datapoints

Timeseries datapoints. If you reach the URL length limit, you can use the POST method.

Try it

Request

Request URL

Request parameters

  • string

    Indicator code. See Indicators.

  • (optional)
    Default value : all
    string

    Reporting economies (comma separated codes). See Reporting economies.

  • (optional)
    Default value : default
    string

    Partner economies where applicable (comma separated codes). See Partner economies.

  • (optional)
    Default value : default
    string

    Time period :

    • default : The last eight years are applied.
    • all : All years are applied.
    • YYYY : comma separated list of years. If the frequency of the requested indicator is monthly or quarterly, the resulting output will reflect this, e.g. 2010 will give an output of January-December or 2010Q1-Q4.
    • YYYYQn : comma separated list of year + quarter. If the indicator frequency is monthly, the output will be given in months, e.g. 2010Q2 will produce an output of April, May, June.
    • YYYYMM : comma separated list of year + month. e.g. 201007, 201507.
    • YYYY-YYYY : range of years. e.g. 1995-2015.
    • YYYYQn-YYYYQn : range of quarters. e.g. 2010Q1-2013Q3.
    • YYYYMM-YYYYMM : range of months. e.g. 201501-201606.

  • (optional)
    Default value : default
    string

    Products/sectors (comma separated codes) where applicable. See Products/sectors.

    • default : includes all the product/sector codes of the indicator's classification (except for HS : includes all the top level 2-digit products + the whole chapter 01)
    • all : includes all the product/sector codes of the indicator's classification
    • HS2, HS4, HS6 : All HS codes at 2,4,6-digit level
    • AG,AGFOFI,MAIS,... : comma separated list of product codes

  • (optional)
    Default value : false
    boolean

    Include sub products/sectors. If true, all child items in the product/sector hierarchy are recursively included.

  • (optional)
    Default value : json
    string

    Output format :

    • json : json content is streamed
    • csv : csv file is compressed and zipped

  • (optional)
    Default value : full
    string

    Output mode :

    • full : all columns, information repeated on each row
    • codes : technical codes only

  • (optional)
    Default value : default
    string

    Number of decimals :

    • default : applies the default number of decimals for the Indicator
    • N : sets the number of decimals to N

  • (optional)
    Default value : 0
    integer

    Number of records to skip (offset).
    You can use it for implementing pagination.

  • (optional)
    Default value : 500
    integer

    Maximum number of records to return (limited to 1 000 000).

  • (optional)
    Default value : H
    string

    Heading style :

    • H : human readable headings, including special characters and spaces
    • M : machine readable headings, easy to parse

  • (optional)
    Default value : 1
    integer

    Language id :

    • 1 : English
    • 2 : French
    • 3 : Spanish

  • (optional)
    Default value : false
    boolean

    Include Metadata information. If enabled, it will generate additional files/arrays (depending on the format, see parameter fmt) :

    • Metadata records
    • Request summary : number of data records retrieved, total number of data records, number of metadata records retrieved, start time, end time, duration in seconds

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

The Json array or Zip file including data points. It also includes metadata and summary if parameter Include Metadata is set to true.

Representations

{
  "indicatorCategoryCode": "string",
  "indicatorCategory": "string",
  "indicatorCode": "string",
  "indicator": "string",
  "reportingEconomyCode": "string",
  "reportingEconomy": "string",
  "partnerEconomyCode": "string",
  "partnerEconomy": "string",
  "productOrSectorClassificationCode": "string",
  "productOrSectorClassification": "string",
  "productOrSectorCode": "string",
  "productOrSector": "string",
  "periodCode": "string",
  "period": "string",
  "frequencyCode": "string",
  "frequency": "string",
  "unitCode": "string",
  "unit": "string",
  "year": 0,
  "valueFlagCode": "string",
  "valueFlag": "string",
  "textValue": "string",
  "value": 0.0
}
{
  "type": "object",
  "properties": {
    "indicatorCategoryCode": {
      "type": "string",
      "description": "The Indicator category code.",
      "nullable": true
    },
    "indicatorCategory": {
      "type": "string",
      "description": "The Indicator category.",
      "nullable": true
    },
    "indicatorCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Indicator code.",
      "nullable": true
    },
    "indicator": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Indicator name.",
      "nullable": true
    },
    "reportingEconomyCode": {
      "type": "string",
      "description": "The reporting ApiTimeSeries.Models.Territory code.",
      "nullable": true
    },
    "reportingEconomy": {
      "type": "string",
      "description": "The reporting ApiTimeSeries.Models.Territory name.",
      "nullable": true
    },
    "partnerEconomyCode": {
      "type": "string",
      "description": "The partner ApiTimeSeries.Models.Territory code.",
      "nullable": true
    },
    "partnerEconomy": {
      "type": "string",
      "description": "The partner ApiTimeSeries.Models.Territory name.",
      "nullable": true
    },
    "productOrSectorClassificationCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.ProductClassification code.",
      "nullable": true
    },
    "productOrSectorClassification": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.ProductClassification name.",
      "nullable": true
    },
    "productOrSectorCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Product code.",
      "nullable": true
    },
    "productOrSector": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Product name.",
      "nullable": true
    },
    "periodCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Period code.",
      "nullable": true
    },
    "period": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Period name.",
      "nullable": true
    },
    "frequencyCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Frequency code.",
      "nullable": true
    },
    "frequency": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Frequency name.",
      "nullable": true
    },
    "unitCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Unit code.",
      "nullable": true
    },
    "unit": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Unit name.",
      "nullable": true
    },
    "year": {
      "type": "integer",
      "description": "The year",
      "format": "int32",
      "nullable": true
    },
    "valueFlagCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.ValueFlag code.",
      "nullable": true
    },
    "valueFlag": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.ValueFlag description.",
      "nullable": true
    },
    "textValue": {
      "type": "string",
      "description": "The text value.",
      "nullable": true
    },
    "value": {
      "type": "number",
      "description": "The value.",
      "format": "double",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Datapoint extended model."
}
{
  "type": "object",
  "properties": {
    "indicatorCategoryCode": {
      "type": "string",
      "description": "The Indicator category code.",
      "nullable": true
    },
    "indicatorCategory": {
      "type": "string",
      "description": "The Indicator category.",
      "nullable": true
    },
    "indicatorCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Indicator code.",
      "nullable": true
    },
    "indicator": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Indicator name.",
      "nullable": true
    },
    "reportingEconomyCode": {
      "type": "string",
      "description": "The reporting ApiTimeSeries.Models.Territory code.",
      "nullable": true
    },
    "reportingEconomy": {
      "type": "string",
      "description": "The reporting ApiTimeSeries.Models.Territory name.",
      "nullable": true
    },
    "partnerEconomyCode": {
      "type": "string",
      "description": "The partner ApiTimeSeries.Models.Territory code.",
      "nullable": true
    },
    "partnerEconomy": {
      "type": "string",
      "description": "The partner ApiTimeSeries.Models.Territory name.",
      "nullable": true
    },
    "productOrSectorClassificationCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.ProductClassification code.",
      "nullable": true
    },
    "productOrSectorClassification": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.ProductClassification name.",
      "nullable": true
    },
    "productOrSectorCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Product code.",
      "nullable": true
    },
    "productOrSector": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Product name.",
      "nullable": true
    },
    "periodCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Period code.",
      "nullable": true
    },
    "period": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Period name.",
      "nullable": true
    },
    "frequencyCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Frequency code.",
      "nullable": true
    },
    "frequency": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Frequency name.",
      "nullable": true
    },
    "unitCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.Unit code.",
      "nullable": true
    },
    "unit": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.Unit name.",
      "nullable": true
    },
    "year": {
      "type": "integer",
      "description": "The year",
      "format": "int32",
      "nullable": true
    },
    "valueFlagCode": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.ValueFlag code.",
      "nullable": true
    },
    "valueFlag": {
      "type": "string",
      "description": "The ApiTimeSeries.Models.DataPointExtended.ValueFlag description.",
      "nullable": true
    },
    "textValue": {
      "type": "string",
      "description": "The text value.",
      "nullable": true
    },
    "value": {
      "type": "number",
      "description": "The value.",
      "format": "double",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Datapoint extended model."
}

400 Bad Request

Validation errors

Representations

{
  "errors": {},
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "extensions": {}
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "nullable": true,
      "readOnly": true
    },
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    },
    "extensions": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "nullable": true,
      "readOnly": true
    },
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    },
    "extensions": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Code samples

library(httr)
library(jsonlite)

headers = c(
    # Request headers
    'Ocp-Apim-Subscription-Key' = '{subscription key}'
    )

params = list()
# Request parameters
params['i'] = 'TP_A_0010'
params['r'] = 'all'
params['p'] = 'default'
params['ps'] = 'default'
params['pc'] = 'default'
params['spc'] = 'false'
params['fmt'] = 'json'
params['mode'] = 'full'
params['dec'] = 'default'
params['off'] = '0'
params['max'] = '500'
params['head'] = 'H'
params['lang'] = '1'
params['meta'] = 'false'


resp <- GET(paste0("https://api.wto.org/timeseries/v1/data?"
                   , paste0(names(params),'=',params,collapse = "&")),
                   add_headers(headers))

if(!http_error(resp)){
  jsonRespText<-fromJSON(rawToChar(content(resp,encoding = 'UTF-8')))$Dataset
  jsonRespText
}else{
  stop('Error in Response')
}

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["i"] = "TP_A_0010";
            queryString["r"] = "all";
            queryString["p"] = "default";
            queryString["ps"] = "default";
            queryString["pc"] = "default";
            queryString["spc"] = "false";
            queryString["fmt"] = "json";
            queryString["mode"] = "full";
            queryString["dec"] = "default";
            queryString["off"] = "0";
            queryString["max"] = "500";
            queryString["head"] = "H";
            queryString["lang"] = "1";
            queryString["meta"] = "false";
            var uri = "https://api.wto.org/timeseries/v1/data?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.wto.org/timeseries/v1/data");

            builder.setParameter("i", "TP_A_0010");
            builder.setParameter("r", "all");
            builder.setParameter("p", "default");
            builder.setParameter("ps", "default");
            builder.setParameter("pc", "default");
            builder.setParameter("spc", "false");
            builder.setParameter("fmt", "json");
            builder.setParameter("mode", "full");
            builder.setParameter("dec", "default");
            builder.setParameter("off", "0");
            builder.setParameter("max", "500");
            builder.setParameter("head", "H");
            builder.setParameter("lang", "1");
            builder.setParameter("meta", "false");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "i": "TP_A_0010",
            "r": "all",
            "p": "default",
            "ps": "default",
            "pc": "default",
            "spc": "false",
            "fmt": "json",
            "mode": "full",
            "dec": "default",
            "off": "0",
            "max": "500",
            "head": "H",
            "lang": "1",
            "meta": "false",
        };
      
        $.ajax({
            url: "https://api.wto.org/timeseries/v1/data?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.wto.org/timeseries/v1/data";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"i=TP_A_0010",
                         @"r=all",
                         @"p=default",
                         @"ps=default",
                         @"pc=default",
                         @"spc=false",
                         @"fmt=json",
                         @"mode=full",
                         @"dec=default",
                         @"off=0",
                         @"max=500",
                         @"head=H",
                         @"lang=1",
                         @"meta=false",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.wto.org/timeseries/v1/data');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'i' => 'TP_A_0010',
    'r' => 'all',
    'p' => 'default',
    'ps' => 'default',
    'pc' => 'default',
    'spc' => 'false',
    'fmt' => 'json',
    'mode' => 'full',
    'dec' => 'default',
    'off' => '0',
    'max' => '500',
    'head' => 'H',
    'lang' => '1',
    'meta' => 'false',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 (for Python 3.2 please scroll) #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'i': 'TP_A_0010',
    'r': 'all',
    'p': 'default',
    'ps': 'default',
    'pc': 'default',
    'spc': 'false',
    'fmt': 'json',
    'mode': 'full',
    'dec': 'default',
    'off': '0',
    'max': '500',
    'head': 'H',
    'lang': '1',
    'meta': 'false',
})

try:
    conn = httplib.HTTPSConnection('api.wto.org')
    conn.request("GET", "/timeseries/v1/data?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'i': 'TP_A_0010',
    'r': 'all',
    'p': 'default',
    'ps': 'default',
    'pc': 'default',
    'spc': 'false',
    'fmt': 'json',
    'mode': 'full',
    'dec': 'default',
    'off': '0',
    'max': '500',
    'head': 'H',
    'lang': '1',
    'meta': 'false',
})

try:
    conn = http.client.HTTPSConnection('api.wto.org')
    conn.request("GET", "/timeseries/v1/data?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.wto.org/timeseries/v1/data')

query = URI.encode_www_form({
    # Request parameters
    'i' => 'TP_A_0010',
    'r' => 'all',
    'p' => 'default',
    'ps' => 'default',
    'pc' => 'default',
    'spc' => 'false',
    'fmt' => 'json',
    'mode' => 'full',
    'dec' => 'default',
    'off' => '0',
    'max' => '500',
    'head' => 'H',
    'lang' => '1',
    'meta' => 'false'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body