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).

04. Timeseries metadata

Timeseries metadata.

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 : all
    string

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

  • (optional)
    Default value : all
    string

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

    • default : includes all the product/sectors codes of the indicator's classification (except for HS : Include all the top level 2 digit products + the whole chapter 01)
    • all : includes all the product/sectors 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 : 1
    integer

    Language id :

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

Request headers

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

Request body

Responses

200 OK

The list of metadata

Representations

[
  {
    "metadataCategoryCode": "string",
    "indicatorCategoryCode": "string",
    "indicatorCode": "string",
    "reportingEconomyCode": "string",
    "partnerEconomyCode": "string",
    "productOrSectorClassificationCode": "string",
    "productOrSectorCode": "string",
    "periodCode": "string",
    "frequencyCode": "string",
    "unitCode": "string",
    "value": 0.0
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "metadataCategoryCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Metadata category code.",
        "nullable": true
      },
      "indicatorCategoryCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Indicator category code.",
        "nullable": true
      },
      "indicatorCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Indicator code.",
        "nullable": true
      },
      "reportingEconomyCode": {
        "type": "string",
        "description": "The reporting ApiTimeSeries.Models.Territory code.",
        "nullable": true
      },
      "partnerEconomyCode": {
        "type": "string",
        "description": "The partner ApiTimeSeries.Models.Territory code.",
        "nullable": true
      },
      "productOrSectorClassificationCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.ProductClassification code.",
        "nullable": true
      },
      "productOrSectorCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Product code.",
        "nullable": true
      },
      "periodCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Period code.",
        "nullable": true
      },
      "frequencyCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Frequency code.",
        "nullable": true
      },
      "unitCode": {
        "type": "string",
        "description": "The ApiTimeSeries.Models.Unit code.",
        "nullable": true
      },
      "value": {
        "type": "number",
        "description": "The value.",
        "format": "double",
        "nullable": true
      }
    },
    "additionalProperties": false,
    "description": "Metadata model."
  }
}

400 Bad Request

The 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
}

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'] = 'all'
params['pc'] = 'all'
params['spc'] = 'false'
params['lang'] = '1'


resp <- GET(paste0("https://api.wto.org/timeseries/v1/metadata?"
                   , 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"] = "all";
            queryString["pc"] = "all";
            queryString["spc"] = "false";
            queryString["lang"] = "1";
            var uri = "https://api.wto.org/timeseries/v1/metadata?" + 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/metadata");

            builder.setParameter("i", "TP_A_0010");
            builder.setParameter("r", "all");
            builder.setParameter("p", "all");
            builder.setParameter("pc", "all");
            builder.setParameter("spc", "false");
            builder.setParameter("lang", "1");

            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": "all",
            "pc": "all",
            "spc": "false",
            "lang": "1",
        };
      
        $.ajax({
            url: "https://api.wto.org/timeseries/v1/metadata?" + $.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/metadata";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"i=TP_A_0010",
                         @"r=all",
                         @"p=all",
                         @"pc=all",
                         @"spc=false",
                         @"lang=1",
                      ];
    
    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/metadata');
$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' => 'all',
    'pc' => 'all',
    'spc' => 'false',
    'lang' => '1',
);

$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': 'all',
    'pc': 'all',
    'spc': 'false',
    'lang': '1',
})

try:
    conn = httplib.HTTPSConnection('api.wto.org')
    conn.request("GET", "/timeseries/v1/metadata?%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': 'all',
    'pc': 'all',
    'spc': 'false',
    'lang': '1',
})

try:
    conn = http.client.HTTPSConnection('api.wto.org')
    conn.request("GET", "/timeseries/v1/metadata?%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/metadata')

query = URI.encode_www_form({
    # Request parameters
    'i' => 'TP_A_0010',
    'r' => 'all',
    'p' => 'all',
    'pc' => 'all',
    'spc' => 'false',
    'lang' => '1'
})
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