- The Department for Business and Trade digital team is committed to making sure our online services are accessible to all users and comply with level AA of the Web Content Accessibility Guidelines – WCAG 2.1, in line with The Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018.
-
-
- In order to help us achieve and maintain our objective, we have commissioned The Digital Accessibility Centre (DAC) to carry out WCAG 2.1 AA level technical compliance audits that also include extensive manual testing.
-
-
- We anticipate the outcome of all tests to be complete by 16th December 2023.
-
-
What to do if you cannot access parts of this website
-
- If you need information on this website in a different format, email Kathy.Gribbin@trade.gov.uk. If you have a problem with accessing any of the pages on this site you can contact us at data-workspace@uktrade.zendesk.com. We’ll get back to you within 5 working days.
-
-
Reporting accessibility problems with this website
-
- We’re always looking to improve the accessibility of this website.
- If you find any problems or think we’re not meeting the requirements of the accessibility regulations, please tell us by contacting data-workspace@uktrade.zendesk.com.
-
All requests to this API should be prefixed with the following URL.
-
{{ base_url }}
-
-
Versioning
-
-
Datasets are versioned according to a subset of the Semver 2.0 specification. Each version is of the form X.Y.Z, where X is the major version, Y is the minor version, and Z is the patch version. Each release of a dataset increments the version according to the following rules.
-
-
-
Patch: incremented when data is added or changed, but the structure of the data is the same.
-
Minor: incremented when new fields or tables are added to the data, but existing ones are unchanged.
-
Major: incremented when existing fields are removed or change type.
-
-
-
Reports
-
-
Datasets can contain reports. Reports are similar to tables, except that the data in reports is generated from the tables in the dataset. Reports are available to satisfy common use cases for filtered or aggregated views of the data in a dataset.
-
-
If a dataset is available as SQLite, reports are generated using SQL in the _reports table in the SQLite file.
-
-
Common parameters
-
-
Several URL parameters are applicable to multiple API endpoints.
-
-
-
-
-
Name
-
Description
-
-
-
-
-
dataset_id
-
A human-readable identifier of a dataset, e.g. {{ dataset }}
-
-
-
version_id
-
-
A version identifier in the format vX.Y.Z, where X.Y.Z is the Semver 2.0 version of the dataset, e.g. {{ version }}
-
or
-
A version in the format vX.Y. In this case, a HTTP 302 redirect is returned to the URL requested, but with version_id equal to the latest version of the dataset with major and minor components matching vX.Y
-
or
-
A version in the format vX. In this case, a HTTP 302 redirect is returned to the URL requested, but with version_id equal to the latest version of the dataset with major component matching vX
-
or
-
The literal latest. In this case, a HTTP 302 redirect is returned to the URL requested, but with version_id equal to the latest version of the dataset
-
-
-
-
table_id
-
A human-readable identifier of a table, e.g. {{ table_name }}
-
-
-
report_id
-
A human-readable identifier of a report, e.g. {{ sample_dataset_with_report_report_name }}
-
-
-
-
-
API Endpoints
-
-
GET list of datasets
-
The list of all datasets available in the {{ service_name }} can be accessed using this endpoint.
-
GET /v1/datasets
-
Query string parameters
-
-
-
-
Name
-
Required
-
Description
-
-
-
-
-
format
-
Yes
-
The requested output format. In all cases, this must be json
The response is a JSON object with the query results under the rows key, i.e. {"rows": [...]}
-
Using query-s3-select requires that the format parameter be json.
-
-
-
-
download
-
No
-
The presence of this parameter results in a content-disposition header so that browsers attempt to download the data rather than display it inline.
-
-
-
-
Range requests
-
If a query-s3-select is not specified, the range HTTP header can be passed to select a byte-range of the dataset. See HTTP Range Requests for more details.
Enables a "simple" query mode to specify columns to retrieve, and filter rows using exact matching.
-
In simple mode, the value of each _columns parameter is a single column to include in the output. This parameter can be passed multiple times to include multiple columns.
-
Filtering on rows can then be performed by passing key value pairs column=value. The output includes only those rows where column column equals value.
-
-
-
-
download
-
No
-
The presence of this parameter results in a content-disposition header so that browsers attempt to download the data rather than display it inline.
-
-
-
-
Range requests
-
If query-s3-select and query-simple are not specified, the range HTTP header can be passed to select a byte-range of the table. See HTTP Range Requests for more details.
Enables a "simple" query mode to specify columns to retrieve, and filter rows using exact matching.
-
In simple mode, the value of each _columns parameter is a single column to include in the output. This parameter can be passed multiple times to include multiple columns.
-
Filtering on rows can then be performed by passing key value pairs column=value. The output includes only those rows where column column equals value.
-
-
-
-
download
-
No
-
The presence of this parameter results in a content-disposition header so that browsers attempt to download the data rather than display it inline.
-
-
-
-
Range requests
-
If query-s3-select and query-simple are not specified, the range HTTP header can be passed to select a byte-range of the report. See HTTP Range Requests for more details.
Status: 200 OK
-"quota_definition__sid","quota__order_number","quota__geographical_areas","quota__headings","quota__commodities","quota__measurement_unit","quota__monetary_unit","quota_definition__description","quota_definition__validity_start_date","quota_definition__validity_end_date","quota_definition__suspension_periods","quota_definition__blocking_periods","quota_definition__status","quota_definition__last_allocation_date","quota_definition__initial_volume","quota_definition__balance","quota_definition__fill_rate"
-20815,50006,"ERGA OMNES","0302 – Fish, fresh or chilled, excluding fish fillets and other fish meat of heading|0304|0303 – Fish, frozen, excluding fish fillets and other fish meat of heading 0304|0304 – Fish fillets and other fish meat (whether or not minced), fresh, chilled or frozen","0302410000|0303510000|0304595000|0304599010|0304992300","Kilogram (kg)","#NA","#NA","2021-01-01","2021-02-14","#NA","#NA","Closed","2021-01-28",2022900,2022900.0,0.0
-20814,50006,"ERGA OMNES","0302 – Fish, fresh or chilled, excluding fish fillets and other fish meat of heading|0304|0303 – Fish, frozen, excluding fish fillets and other fish meat of heading 0304|0304 – Fish fillets and other fish meat (whether or not minced), fresh, chilled or frozen","0302410000|0303510000|0304595000|0304599010|0304992300","Kilogram (kg)","#NA","#NA","2021-06-16","2022-02-14","#NA","#NA","Open","#NA",2112000,2112000.0,0.0
-
All requests to this API should be prefixed with the following URL.
+
{{ base_url }}
+
+
Versioning
+
+
Datasets are versioned according to a subset of the Semver 2.0
+ specification. Each version is of the form X.Y.Z, where X is the major version, Y is the minor version, and Z
+ is the patch version. Each release of a dataset increments the version according to the following rules.
+
+
+
Patch: incremented when data is added or changed, but the structure of the data is the same.
+
Minor: incremented when new fields or tables are added to the data, but existing ones are unchanged.
+
Major: incremented when existing fields are removed or change type.
+
+
+
Reports
+
+
Datasets can contain reports. Reports are similar to tables, except that the data in reports is generated
+ from the tables in the dataset. Reports are available to satisfy common use cases for filtered or aggregated
+ views of the data in a dataset.
+
+
If a dataset is available as SQLite, reports are generated using SQL in the _reports table in the SQLite file.
+
+
Common parameters
+
+
Several URL parameters are applicable to multiple API endpoints.
+
+
+
+
+
Name
+
Description
+
+
+
+
+
dataset_id
+
A human-readable identifier of a dataset, e.g. {{ dataset }}
+
+
+
+
version_id
+
+
A version identifier in the format vX.Y.Z, where X.Y.Z is the Semver 2.0 version of the
+ dataset, e.g. {{ version }}
+
or
+
A version in the format vX.Y. In this case, a HTTP 302 redirect is
+ returned to the URL requested, but with version_id equal to the latest
+ version of the dataset with major and minor components matching vX.Y
+
+
or
+
A version in the format vX. In this case, a HTTP 302 redirect is
+ returned to the URL requested, but with version_id equal to the latest
+ version of the dataset with major component matching vX
+
or
+
The literal latest. In this case, a HTTP 302 redirect is returned to
+ the URL requested, but with version_id equal to the latest version of
+ the dataset
+
+
+
+
table_id
+
A human-readable identifier of a table, e.g. {{ table_name }}
+
+
+
+
report_id
+
A human-readable identifier of a report, e.g.
+ {{ sample_dataset_with_report_report_name }}
+
+
+
+
+
API Endpoints
+
+
GET list of datasets
+
The list of all datasets available in the {{ service_name }} can be accessed using this endpoint.
+
GET /v1/datasets
+
Query string parameters
+
+
+
+
Name
+
Required
+
Description
+
+
+
+
+
format
+
Yes
+
The requested output format. In all cases, this must be json
The metadata of a dataset version can be accessed using this endpoint.
+
GET /v1/datasets/{dataset_id}/versions/{version_id}/metadata
+
Query string parameters
+
+
+
+
Name
+
Required
+
Description
+
+
+
+
+
format
+
Yes
+
The requested output format. This must be csvw or html
+
+
+
download
+
No
+
The presence of this parameter results in a content-disposition header so that browsers attempt to download the metadata
+ rather than display it inline
The response is a JSON object with the query results under the rows
+ key, i.e. {"rows": [...]}
+
Using query-s3-select requires that the format parameter be json.
+
+
+
+
download
+
No
+
The presence of this parameter results in a content-disposition header so that browsers attempt to download the data
+ rather than display it inline.
+
+
+
+
Range requests
+
If a query-s3-select is not specified, the range HTTP header can be passed to select a byte-range of the dataset. See HTTP Range Requests for more
+ details.
Enables a "simple" query mode to specify columns to retrieve, and filter rows using exact matching.
+
+
In simple mode, the value of each _columns parameter is a
+ single column to include in the output. This parameter can be passed multiple times to include
+ multiple columns.
+
Filtering on rows can then be performed by passing key value pairs column=value. The output includes only those rows where column column equals value.
+
+
+
+
download
+
No
+
The presence of this parameter results in a content-disposition header so that browsers attempt to download the data
+ rather than display it inline.
+
+
+
+
Range requests
+
If query-s3-select and query-simple are
+ not specified, the range HTTP header can be passed to select a
+ byte-range of the table. See HTTP
+ Range Requests for more details.
Enables a "simple" query mode to specify columns to retrieve, and filter rows using exact matching.
+
+
In simple mode, the value of each _columns parameter is a
+ single column to include in the output. This parameter can be passed multiple times to include
+ multiple columns.
+
Filtering on rows can then be performed by passing key value pairs column=value. The output includes only those rows where column column equals value.
+
+
+
+
download
+
No
+
The presence of this parameter results in a content-disposition header so that browsers attempt to download the data
+ rather than display it inline.
+
+
+
+
Range requests
+
If query-s3-select and query-simple are
+ not specified, the range HTTP header can be passed to select a
+ byte-range of the report. See HTTP
+ Range Requests for more details.
Status: 200 OK
+"quota_definition__sid","quota__order_number","quota__geographical_areas","quota__headings","quota__commodities","quota__measurement_unit","quota__monetary_unit","quota_definition__description","quota_definition__validity_start_date","quota_definition__validity_end_date","quota_definition__suspension_periods","quota_definition__blocking_periods","quota_definition__status","quota_definition__last_allocation_date","quota_definition__initial_volume","quota_definition__balance","quota_definition__fill_rate"
+20815,50006,"ERGA OMNES","0302 – Fish, fresh or chilled, excluding fish fillets and other fish meat of heading|0304|0303 – Fish, frozen, excluding fish fillets and other fish meat of heading 0304|0304 – Fish fillets and other fish meat (whether or not minced), fresh, chilled or frozen","0302410000|0303510000|0304595000|0304599010|0304992300","Kilogram (kg)","#NA","#NA","2021-01-01","2021-02-14","#NA","#NA","Closed","2021-01-28",2022900,2022900.0,0.0
+20814,50006,"ERGA OMNES","0302 – Fish, fresh or chilled, excluding fish fillets and other fish meat of heading|0304|0303 – Fish, frozen, excluding fish fillets and other fish meat of heading 0304|0304 – Fish fillets and other fish meat (whether or not minced), fresh, chilled or frozen","0302410000|0303510000|0304595000|0304599010|0304992300","Kilogram (kg)","#NA","#NA","2021-06-16","2022-02-14","#NA","#NA","Open","#NA",2112000,2112000.0,0.0
+
+ The Department for Business and Trade digital team is committed to making sure our online services are accessible to all users and comply with level AA of the Web Content Accessibility Guidelines – WCAG 2.1, in line with The Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018.
+
+
+ In order to help us achieve and maintain our objective, we have commissioned The Digital Accessibility Centre (DAC) to carry out WCAG 2.1 AA level technical compliance audits that also include extensive manual testing.
+
+
+ We anticipate the outcome of all tests to be complete by 16th December 2023.
+
+
What to do if you cannot access parts of this website
+
+ If you need information on this website in a different format, email Kathy.Gribbin@trade.gov.uk. If you have a problem with accessing any of the pages on this site you can contact us at data-workspace@uktrade.zendesk.com. We’ll get back to you within 5 working days.
+
+
Reporting accessibility problems with this website
+
+ We’re always looking to improve the accessibility of this website.
+ If you find any problems or think we’re not meeting the requirements of the accessibility regulations, please tell us by contacting data-workspace@uktrade.zendesk.com.
+