Timeseries API
API change historyWTO 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).
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"i": "string",
"r": "string",
"p": "string",
"ps": "string",
"pc": "string",
"spc": true,
"fmt": "string",
"mode": "string",
"dec": "string",
"off": 0,
"max": 0,
"head": "string",
"lang": 0,
"meta": true
}
{
"required": [
"i"
],
"type": "object",
"properties": {
"i": {
"type": "string",
"description": "Indicator code. ```See Indicators.```",
"nullable": true
},
"r": {
"pattern": "^(all|[A-Za-z0-9]{3}(,[A-Za-z0-9]{3})*)$",
"type": "string",
"description": "Reporting economies (comma separated codes). ```See Reporting economies.```",
"nullable": true
},
"p": {
"pattern": "^(all|default|[A-Za-z0-9]{3}(,[A-Za-z0-9]{3})*)$",
"type": "string",
"description": "Partner economies where applicable (comma separated codes). ```See Partner economies.```",
"nullable": true
},
"ps": {
"pattern": "^(default|all|(19|20)\\d{2}(,(19|20)\\d{2})*|(19|20)[0-4]\\d(S[1-2])(,(19|20)[0-4]\\d(S[1-2]))*|(19|20)[0-4]\\d(Q[1-4])(,(19|20)[0-4]\\d(Q[1-4]))*|(19|20)[0-4]\\d(0[1-9]|1[0-2])(,(19|20)[0-4]\\d(0[1-9]|1[0-2]))*|(19|20)\\d{2}-(19|20)\\d{2}|(19|20)[0-4]\\d(S[1-2])-(19|20)[0-4]\\d(S[1-2])|(19|20)[0-4]\\d(Q[1-4])-(19|20)[0-4]\\d(Q[1-4])|(19|20)[0-4]\\d(0[1-9]|1[0-2])-(19|20)[0-4]\\d(0[1-9]|1[0-2]))$",
"type": "string",
"description": "Time period :<ul><li><i>default</i> : The last eight years are applied.\r\n</li><li><i>all</i> : All years are applied.\r\n</li><li>YYYY : comma separated list of years.\r\n```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.```\r\n</li><li>YYYYQn : comma separated list of year + quarter.\r\n```If the indicator frequency is monthly, the output will be given in months, e.g. 2010Q2 will produce an output of April, May, June.```\r\n</li><li>YYYYMM : comma separated list of year + month.\r\n```e.g. 201007, 201507.```\r\n</li><li>YYYY-YYYY : range of years.\r\n```e.g. 1995-2015.```\r\n</li><li>YYYYQn-YYYYQn : range of quarters.\r\n```e.g. 2010Q1-2013Q3.```\r\n</li><li>YYYYMM-YYYYMM : range of months.\r\n```e.g. 201501-201606.```\r\n</li></ul>",
"nullable": true
},
"pc": {
"pattern": "^(HS2|HS4|HS6|default|all|[A-Za-z0-9]*(,[A-Za-z0-9]*)*)$",
"type": "string",
"description": "Products/sectors (comma separated codes) where applicable. ```See Products/sectors.```<ul><li><i>default</i> : includes all the product/sector codes <u>of the indicator's classification</u> (except for <i>HS</i> : includes all the top level 2-digit products + the whole chapter 01)</li><li><i>all</i> : includes all the product/sector codes <u>of the indicator's classification</u></li><li>HS2, HS4, HS6 : All HS codes at 2,4,6-digit level</li><li>AG,AGFOFI,MAIS,... : comma separated list of product codes</li></ul>",
"nullable": true
},
"spc": {
"type": "boolean",
"description": "Include sub products/sectors. If true, all child items in the product/sector hierarchy are recursively included."
},
"fmt": {
"type": "string",
"description": "Output format : <ul><li><i>json</i> : json content is streamed</li><li><i>csv</i> : csv file is compressed and zipped</li></ul>",
"nullable": true
},
"mode": {
"minLength": 1,
"type": "string",
"description": "Output mode : <ul><li><i>full</i> : all columns, information repeated on each row</li><li><i>codes</i> : technical codes only</li></ul>",
"nullable": true
},
"dec": {
"pattern": "^(default|[0-9]*)$",
"type": "string",
"description": "Number of decimals : <ul><li><i>default</i> : apply the default number of decimals for the Indicator</li><li>N : sets the number of decimals to N</li></ul>",
"nullable": true
},
"off": {
"maximum": 1000000,
"minimum": 0,
"type": "integer",
"description": "Number of records to skip (offset).\r\nYou can use it for implementing pagination.",
"format": "int32",
"nullable": true
},
"max": {
"maximum": 1000000,
"minimum": 1,
"type": "integer",
"description": "Maximum number of records to return.",
"format": "int32",
"nullable": true
},
"head": {
"type": "string",
"description": "Heading style :<ul><li><i>H</i> : human readable headings, including special characters and spaces</li><li><i>M</i> : machine readable headings, easy to parse</li></ul>",
"nullable": true
},
"lang": {
"type": "integer",
"description": "Language id :<ul><li><i>1</i> : English</li><li><i>2</i> : French</li><li><i>3</i> : Spanish</li></ul>",
"format": "int32",
"nullable": true
},
"meta": {
"type": "boolean",
"description": "Include Metadata information. If enabled, it will generate additional files/arrays (depending on the format, see parameter fmt) :<ul><li>Metadata records</li><li>Request summary : number of data records retrieved, total number of data records, number of metadata records retrieved, start time, end time, duration in seconds</li></ul>"
}
},
"additionalProperties": false,
"description": "The Data Query model, used for POST requests"
}
{
"i": "string",
"r": "string",
"p": "string",
"ps": "string",
"pc": "string",
"spc": true,
"fmt": "string",
"mode": "string",
"dec": "string",
"off": 0,
"max": 0,
"head": "string",
"lang": 0,
"meta": true
}
{
"required": [
"i"
],
"type": "object",
"properties": {
"i": {
"type": "string",
"description": "Indicator code. ```See Indicators.```",
"nullable": true
},
"r": {
"pattern": "^(all|[A-Za-z0-9]{3}(,[A-Za-z0-9]{3})*)$",
"type": "string",
"description": "Reporting economies (comma separated codes). ```See Reporting economies.```",
"nullable": true
},
"p": {
"pattern": "^(all|default|[A-Za-z0-9]{3}(,[A-Za-z0-9]{3})*)$",
"type": "string",
"description": "Partner economies where applicable (comma separated codes). ```See Partner economies.```",
"nullable": true
},
"ps": {
"pattern": "^(default|all|(19|20)\\d{2}(,(19|20)\\d{2})*|(19|20)[0-4]\\d(S[1-2])(,(19|20)[0-4]\\d(S[1-2]))*|(19|20)[0-4]\\d(Q[1-4])(,(19|20)[0-4]\\d(Q[1-4]))*|(19|20)[0-4]\\d(0[1-9]|1[0-2])(,(19|20)[0-4]\\d(0[1-9]|1[0-2]))*|(19|20)\\d{2}-(19|20)\\d{2}|(19|20)[0-4]\\d(S[1-2])-(19|20)[0-4]\\d(S[1-2])|(19|20)[0-4]\\d(Q[1-4])-(19|20)[0-4]\\d(Q[1-4])|(19|20)[0-4]\\d(0[1-9]|1[0-2])-(19|20)[0-4]\\d(0[1-9]|1[0-2]))$",
"type": "string",
"description": "Time period :<ul><li><i>default</i> : The last eight years are applied.\r\n</li><li><i>all</i> : All years are applied.\r\n</li><li>YYYY : comma separated list of years.\r\n```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.```\r\n</li><li>YYYYQn : comma separated list of year + quarter.\r\n```If the indicator frequency is monthly, the output will be given in months, e.g. 2010Q2 will produce an output of April, May, June.```\r\n</li><li>YYYYMM : comma separated list of year + month.\r\n```e.g. 201007, 201507.```\r\n</li><li>YYYY-YYYY : range of years.\r\n```e.g. 1995-2015.```\r\n</li><li>YYYYQn-YYYYQn : range of quarters.\r\n```e.g. 2010Q1-2013Q3.```\r\n</li><li>YYYYMM-YYYYMM : range of months.\r\n```e.g. 201501-201606.```\r\n</li></ul>",
"nullable": true
},
"pc": {
"pattern": "^(HS2|HS4|HS6|default|all|[A-Za-z0-9]*(,[A-Za-z0-9]*)*)$",
"type": "string",
"description": "Products/sectors (comma separated codes) where applicable. ```See Products/sectors.```<ul><li><i>default</i> : includes all the product/sector codes <u>of the indicator's classification</u> (except for <i>HS</i> : includes all the top level 2-digit products + the whole chapter 01)</li><li><i>all</i> : includes all the product/sector codes <u>of the indicator's classification</u></li><li>HS2, HS4, HS6 : All HS codes at 2,4,6-digit level</li><li>AG,AGFOFI,MAIS,... : comma separated list of product codes</li></ul>",
"nullable": true
},
"spc": {
"type": "boolean",
"description": "Include sub products/sectors. If true, all child items in the product/sector hierarchy are recursively included."
},
"fmt": {
"type": "string",
"description": "Output format : <ul><li><i>json</i> : json content is streamed</li><li><i>csv</i> : csv file is compressed and zipped</li></ul>",
"nullable": true
},
"mode": {
"minLength": 1,
"type": "string",
"description": "Output mode : <ul><li><i>full</i> : all columns, information repeated on each row</li><li><i>codes</i> : technical codes only</li></ul>",
"nullable": true
},
"dec": {
"pattern": "^(default|[0-9]*)$",
"type": "string",
"description": "Number of decimals : <ul><li><i>default</i> : apply the default number of decimals for the Indicator</li><li>N : sets the number of decimals to N</li></ul>",
"nullable": true
},
"off": {
"maximum": 1000000,
"minimum": 0,
"type": "integer",
"description": "Number of records to skip (offset).\r\nYou can use it for implementing pagination.",
"format": "int32",
"nullable": true
},
"max": {
"maximum": 1000000,
"minimum": 1,
"type": "integer",
"description": "Maximum number of records to return.",
"format": "int32",
"nullable": true
},
"head": {
"type": "string",
"description": "Heading style :<ul><li><i>H</i> : human readable headings, including special characters and spaces</li><li><i>M</i> : machine readable headings, easy to parse</li></ul>",
"nullable": true
},
"lang": {
"type": "integer",
"description": "Language id :<ul><li><i>1</i> : English</li><li><i>2</i> : French</li><li><i>3</i> : Spanish</li></ul>",
"format": "int32",
"nullable": true
},
"meta": {
"type": "boolean",
"description": "Include Metadata information. If enabled, it will generate additional files/arrays (depending on the format, see parameter fmt) :<ul><li>Metadata records</li><li>Request summary : number of data records retrieved, total number of data records, number of metadata records retrieved, start time, end time, duration in seconds</li></ul>"
}
},
"additionalProperties": false,
"description": "The Data Query model, used for POST requests"
}
{
"i": "string",
"r": "string",
"p": "string",
"ps": "string",
"pc": "string",
"spc": true,
"fmt": "string",
"mode": "string",
"dec": "string",
"off": 0,
"max": 0,
"head": "string",
"lang": 0,
"meta": true
}
{
"required": [
"i"
],
"type": "object",
"properties": {
"i": {
"type": "string",
"description": "Indicator code. ```See Indicators.```",
"nullable": true
},
"r": {
"pattern": "^(all|[A-Za-z0-9]{3}(,[A-Za-z0-9]{3})*)$",
"type": "string",
"description": "Reporting economies (comma separated codes). ```See Reporting economies.```",
"nullable": true
},
"p": {
"pattern": "^(all|default|[A-Za-z0-9]{3}(,[A-Za-z0-9]{3})*)$",
"type": "string",
"description": "Partner economies where applicable (comma separated codes). ```See Partner economies.```",
"nullable": true
},
"ps": {
"pattern": "^(default|all|(19|20)\\d{2}(,(19|20)\\d{2})*|(19|20)[0-4]\\d(S[1-2])(,(19|20)[0-4]\\d(S[1-2]))*|(19|20)[0-4]\\d(Q[1-4])(,(19|20)[0-4]\\d(Q[1-4]))*|(19|20)[0-4]\\d(0[1-9]|1[0-2])(,(19|20)[0-4]\\d(0[1-9]|1[0-2]))*|(19|20)\\d{2}-(19|20)\\d{2}|(19|20)[0-4]\\d(S[1-2])-(19|20)[0-4]\\d(S[1-2])|(19|20)[0-4]\\d(Q[1-4])-(19|20)[0-4]\\d(Q[1-4])|(19|20)[0-4]\\d(0[1-9]|1[0-2])-(19|20)[0-4]\\d(0[1-9]|1[0-2]))$",
"type": "string",
"description": "Time period :<ul><li><i>default</i> : The last eight years are applied.\r\n</li><li><i>all</i> : All years are applied.\r\n</li><li>YYYY : comma separated list of years.\r\n```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.```\r\n</li><li>YYYYQn : comma separated list of year + quarter.\r\n```If the indicator frequency is monthly, the output will be given in months, e.g. 2010Q2 will produce an output of April, May, June.```\r\n</li><li>YYYYMM : comma separated list of year + month.\r\n```e.g. 201007, 201507.```\r\n</li><li>YYYY-YYYY : range of years.\r\n```e.g. 1995-2015.```\r\n</li><li>YYYYQn-YYYYQn : range of quarters.\r\n```e.g. 2010Q1-2013Q3.```\r\n</li><li>YYYYMM-YYYYMM : range of months.\r\n```e.g. 201501-201606.```\r\n</li></ul>",
"nullable": true
},
"pc": {
"pattern": "^(HS2|HS4|HS6|default|all|[A-Za-z0-9]*(,[A-Za-z0-9]*)*)$",
"type": "string",
"description": "Products/sectors (comma separated codes) where applicable. ```See Products/sectors.```<ul><li><i>default</i> : includes all the product/sector codes <u>of the indicator's classification</u> (except for <i>HS</i> : includes all the top level 2-digit products + the whole chapter 01)</li><li><i>all</i> : includes all the product/sector codes <u>of the indicator's classification</u></li><li>HS2, HS4, HS6 : All HS codes at 2,4,6-digit level</li><li>AG,AGFOFI,MAIS,... : comma separated list of product codes</li></ul>",
"nullable": true
},
"spc": {
"type": "boolean",
"description": "Include sub products/sectors. If true, all child items in the product/sector hierarchy are recursively included."
},
"fmt": {
"type": "string",
"description": "Output format : <ul><li><i>json</i> : json content is streamed</li><li><i>csv</i> : csv file is compressed and zipped</li></ul>",
"nullable": true
},
"mode": {
"minLength": 1,
"type": "string",
"description": "Output mode : <ul><li><i>full</i> : all columns, information repeated on each row</li><li><i>codes</i> : technical codes only</li></ul>",
"nullable": true
},
"dec": {
"pattern": "^(default|[0-9]*)$",
"type": "string",
"description": "Number of decimals : <ul><li><i>default</i> : apply the default number of decimals for the Indicator</li><li>N : sets the number of decimals to N</li></ul>",
"nullable": true
},
"off": {
"maximum": 1000000,
"minimum": 0,
"type": "integer",
"description": "Number of records to skip (offset).\r\nYou can use it for implementing pagination.",
"format": "int32",
"nullable": true
},
"max": {
"maximum": 1000000,
"minimum": 1,
"type": "integer",
"description": "Maximum number of records to return.",
"format": "int32",
"nullable": true
},
"head": {
"type": "string",
"description": "Heading style :<ul><li><i>H</i> : human readable headings, including special characters and spaces</li><li><i>M</i> : machine readable headings, easy to parse</li></ul>",
"nullable": true
},
"lang": {
"type": "integer",
"description": "Language id :<ul><li><i>1</i> : English</li><li><i>2</i> : French</li><li><i>3</i> : Spanish</li></ul>",
"format": "int32",
"nullable": true
},
"meta": {
"type": "boolean",
"description": "Include Metadata information. If enabled, it will generate additional files/arrays (depending on the format, see parameter fmt) :<ul><li>Metadata records</li><li>Request summary : number of data records retrieved, total number of data records, number of metadata records retrieved, start time, end time, duration in seconds</li></ul>"
}
},
"additionalProperties": false,
"description": "The Data Query model, used for POST requests"
}
Responses
200 OK
The Json array or Zip file including data/metadata/summary
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
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
}
{
"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
'Content-Type' = 'application/json'
'Ocp-Apim-Subscription-Key' = '{subscription key}'
)
params = list()
resp <- POST(paste0("https://api.wto.org/timeseries/v1/data?"
), body = {body},
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}");
var uri = "https://api.wto.org/timeseries/v1/data?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // 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");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
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
};
$.ajax({
url: "https://api.wto.org/timeseries/v1/data?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.wto.org')
conn.request("POST", "/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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.wto.org')
conn.request("POST", "/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')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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