queryData
Retrieve detailed trade data for imports or exports, filtered by country, state, economic block, or product categories, and analyze metrics like FOB, KG, and CIF within specified periods.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
details | Yes | ||
filters | No | ||
flow | Yes | ||
language | No | pt | |
metrics | Yes | ||
monthDetail | Yes | ||
period | Yes |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"details": {
"items": {
"enum": [
"country",
"state",
"economicBlock",
"section",
"chapter",
"position",
"subposition",
"ncm"
],
"type": "string"
},
"type": "array"
},
"filters": {
"items": {
"additionalProperties": false,
"properties": {
"filter": {
"enum": [
"country",
"state",
"economicBlock",
"section",
"chapter",
"position",
"subposition",
"ncm"
],
"type": "string"
},
"values": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"filter",
"values"
],
"type": "object"
},
"type": "array"
},
"flow": {
"enum": [
"export",
"import"
],
"type": "string"
},
"language": {
"default": "pt",
"type": "string"
},
"metrics": {
"items": {
"enum": [
"metricFOB",
"metricKG",
"metricStatistic",
"metricFreight",
"metricInsurance",
"metricCIF"
],
"type": "string"
},
"type": "array"
},
"monthDetail": {
"type": "boolean"
},
"period": {
"additionalProperties": false,
"properties": {
"from": {
"pattern": "^\\d{4}-\\d{2}$",
"type": "string"
},
"to": {
"pattern": "^\\d{4}-\\d{2}$",
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
}
},
"required": [
"flow",
"monthDetail",
"period",
"details",
"metrics"
],
"type": "object"
}