V1

API change history

The database contains detailed information on export and import prohibitions and restrictions other than tariffs and taxes, with details on the products (tariff lines) covered by the measure, the related WTO justification, national legal basis and administrative mechanisms.

Single Notification

Try it

Request

Request URL

Request parameters

  • integer

    Notification ID.

  • (optional)
    Default value : en
    string

    Language.

Request headers

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

Request body

Responses

200 OK

Representations

{
  "data": [
    {
      "id": 352,
      "member_name": "Australia",
      "document_symbol": "G/MA/QR/N/AUS/3/Add.1",
      "qr_serial_number": 46,
      "measures": [
        {
          "symbol": "GQC",
          "label": "Global quota allocated by country"
        },
        {
          "symbol": "NAL",
          "label": "Non-automatic licensing"
        }
      ],
      "administrative_mechanisms": "All imports require a licence and permit issued by the Department of Health. Goods must be accompanied by an export authorisation from the country of export. Narcotic drugs must not be exported to a country where the total amount exported for the year exceeds the countries Estimate of Drug Requirements (Article 31, Single Convention, 1961). Psychotropic drugs should not be exported to a country where the total amount exported for the year exceeds the countries Assessments of Annual Medical and Scientific Requirements.",
      "national_legal_bases": "Regulation 5 corresponding Schedule 4 of the Customs\n(Prohibited Imports) Regulations 1956.",
      "description": "Narcotic drugs; psychotropic substances and related chemicals",
      "period_from_dt": "01/10/2018",
      "period_to_dt": "30/09/2020",
      "in_force_dt": "18/03/2020",
      "details": "/qrs/3259"
    },
    {
      "member_name": "Singapore",
      "document_symbol": "G/MA/QR/N/SGP/2",
      "qr_serial_number": 17,
      "measures": [
        {
          "symbol": "NAL",
          "label": "Non-automatic licensing"
        }
      ],
      "administrative_mechanisms": "",
      "national_legal_bases": "Regulation of Imports and Exports Regulations; 1995",
      "description": "Non-automatic license for the import of Poppy Seeds",
      "period_from_dt": "01/10/2014",
      "period_to_dt": "30/09/2016",
      "in_force_dt": "28/11/2014",
      "details": "/qrs/2993"
    }
  ]
}
{
  "required": [
    "data"
  ],
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "required": [
          "member_name",
          "document_symbol",
          "qr_serial_number",
          "measures",
          "administrative_mechanisms",
          "national_legal_bases",
          "description",
          "period_from_dt",
          "period_to_dt",
          "in_force_dt",
          "details"
        ],
        "type": "object",
        "properties": {
          "member_name": {
            "type": "string"
          },
          "document_symbol": {
            "type": "string"
          },
          "qr_serial_number": {
            "type": "integer"
          },
          "measures": {
            "type": "array",
            "items": {
              "title": "Measure",
              "required": [
                "label",
                "symbol",
                "products"
              ],
              "type": "object",
              "properties": {
                "symbol": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "products": {
                  "type": "array",
                  "items": {
                    "title": "Root Type for Product",
                    "required": [
                      "code",
                      "description",
                      "hs_version",
                      "interpreted",
                      "reported_code"
                    ],
                    "type": "object",
                    "properties": {
                      "hs_version": {
                        "type": "string"
                      },
                      "code": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "reported_code": {
                        "type": "string"
                      },
                      "interpreted": {
                        "type": "boolean"
                      }
                    },
                    "description": "",
                    "example": {
                      "hs_version": "HS5",
                      "code": "01",
                      "description": "Export of radioactive waste to Pacific Island Developing Countries",
                      "reported_code": "Various",
                      "interpreted": false
                    }
                  },
                  "description": ""
                }
              },
              "description": "",
              "example": {
                "symbol": "GQC",
                "label": "Global quota allocated by country",
                "products": [
                  {
                    "hs_version": "HS5",
                    "code": "01",
                    "description": "Export of radioactive waste to Pacific Island Developing Countries",
                    "reported_code": "Various",
                    "interpreted": false
                  }
                ]
              }
            }
          },
          "administrative_mechanisms": {
            "type": "string"
          },
          "national_legal_bases": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "period_from_dt": {
            "type": "string"
          },
          "period_to_dt": {
            "type": "string"
          },
          "in_force_dt": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        },
        "example": {
          "id": 1,
          "notification_id": 1,
          "member_name": "Afghanistan",
          "document_symbol": "G/MA/QR/N/AFG/1",
          "qr_serial_number": 1,
          "measures": [
            {
              "symbol": "P",
              "label": "Prohibition"
            }
          ],
          "national_legal_bases": "As prescribed in the Customs Tariff of Afghanistan of 12 October 2015",
          "description": "Import prohibition",
          "period_from_dt": "01/10/2014",
          "period_to_dt": "30/09/2016",
          "in_force_dt": "29/07/2016",
          "details": "https://qr-public.test/api/v2/qrs/1"
        }
      },
      "description": ""
    }
  },
  "description": "",
  "example": {
    "data": [
      {
        "id": 352,
        "member_name": "Australia",
        "document_symbol": "G/MA/QR/N/AUS/3/Add.1",
        "qr_serial_number": 46,
        "measures": [
          {
            "symbol": "GQC",
            "label": "Global quota allocated by country"
          },
          {
            "symbol": "NAL",
            "label": "Non-automatic licensing"
          }
        ],
        "administrative_mechanisms": "All imports require a licence and permit issued by the Department of Health. Goods must be accompanied by an export authorisation from the country of export. Narcotic drugs must not be exported to a country where the total amount exported for the year exceeds the countries Estimate of Drug Requirements (Article 31, Single Convention, 1961). Psychotropic drugs should not be exported to a country where the total amount exported for the year exceeds the countries Assessments of Annual Medical and Scientific Requirements.",
        "national_legal_bases": "Regulation 5 corresponding Schedule 4 of the Customs\n(Prohibited Imports) Regulations 1956.",
        "description": "Narcotic drugs; psychotropic substances and related chemicals",
        "period_from_dt": "01/10/2018",
        "period_to_dt": "30/09/2020",
        "in_force_dt": "18/03/2020",
        "details": "/qrs/3259"
      },
      {
        "member_name": "Singapore",
        "document_symbol": "G/MA/QR/N/SGP/2",
        "qr_serial_number": 17,
        "measures": [
          {
            "symbol": "NAL",
            "label": "Non-automatic licensing"
          }
        ],
        "administrative_mechanisms": "",
        "national_legal_bases": "Regulation of Imports and Exports Regulations; 1995",
        "description": "Non-automatic license for the import of Poppy Seeds",
        "period_from_dt": "01/10/2014",
        "period_to_dt": "30/09/2016",
        "in_force_dt": "28/11/2014",
        "details": "/qrs/2993"
      }
    ]
  }
}

404 Not Found

Resource not found.

Representations

{
  "code": "404",
  "message": "Resource not found."
}
{
  "title": "Error",
  "required": [
    "code",
    "message"
  ],
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "description": "General error data type",
  "example": {
    "code": "404",
    "message": "Resource not found."
  }
}

422 Unprocessable Entity

Response if one or more of the the query parameters are malformed or doesn't comply with the given constraints. Ex. validation of paramters failed.

Representations

{
  "code": "404",
  "message": "Resource not found."
}
{
  "title": "Error",
  "required": [
    "code",
    "message"
  ],
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "description": "General error data type",
  "example": {
    "code": "404",
    "message": "Resource not found."
  }
}

Code samples

library(httr)
library(jsonlite)

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

params = list()
# Request parameters
params['locale'] = 'en'


resp <- GET(paste0("https://api.wto.org/qr/v1/notifications/{notification}?"
                   , 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["locale"] = "en";
            var uri = "https://api.wto.org/qr/v1/notifications/{notification}?" + 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/qr/v1/notifications/{notification}");

            builder.setParameter("locale", "en");

            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
            "locale": "en",
        };
      
        $.ajax({
            url: "https://api.wto.org/qr/v1/notifications/{notification}?" + $.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/qr/v1/notifications/{notification}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"locale=en",
                      ];
    
    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/qr/v1/notifications/{notification}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'locale' => 'en',
);

$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
    'locale': 'en',
})

try:
    conn = httplib.HTTPSConnection('api.wto.org')
    conn.request("GET", "/qr/v1/notifications/{notification}?%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
    'locale': 'en',
})

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

query = URI.encode_www_form({
    # Request parameters
    'locale' => 'en'
})
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