INRIX IQ logo

Data Download Service

The data download service is used for querying available data and downloading the data as needed. The data should be sharing static data that is either common to all customers or generated for specific customers. Map release data is the first to be supported. And it can be extended to support other product deliverables that are static in nature. Generally, all data are organized in a hierarchy based on their nature. The top level is always the product itself, which is represented by its name, and then followed by necessary sub levels, down to each individual data file. For example, map data are organized in a hierarchy like:

—-Top level Product: Map Release —-Sub level Datasets: XDReplaced, OSMConflation, TMCRemoved, XDRemoved, OpenLRDictionaryFiles, GeoJSON, TMCAdded, Shapefiles, TMCReplaced, XDAdded —-Lowest level: Data files under each dataset.

All APIs requires authentication. You need to get the auth token from INRIX User Account System before you make service API call.

The service production endpoint, which should only be used with real data, is: https://mapdata.inrix.io

For testing purposes the “qa” endpoint is available: https://mapdata.qa.inrix.io

Instead of using service APIs for data downloading, a portal is provided. Below are their URLs:

QA: https://map-data-downloader.qa.inrix.com Prod: https://map-data-downloader.inrix.com

/v1/datasummary/products

GET get the overall supported products' information

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com

Requests

Example
Query
https://mapdata.inrix.io/v1/datasummary/products?accessToken={UAStoken}

Responses

200 Success
{
  "result": [
      {
          "dataProduct": "Traffic",
          "versions": [
              {
                  "version": "20.1",
                  "datasets": [
                  "Speed"
                  ]
              },
              {
                  "version": "19.2",
                  "datasets": [
                  "Routing"
                  ]
              }
          ]
      },
      {
          "dataProduct": "MapRelease",
          "versions": [
              {
                  "version": "20.1",
                  "datasets": [
                  "GeoJSON",
                  "OpenLRDictionaryFiles",
                  "Shapefiles"
                  ]
              }
          ]
      }
  ],
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datasummary/bycountry

GET get the product summary organized by country for a given product version

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com
dataProduct Query String the name of the product from v1/datasummary/products API
version Query String the version of the product from v1/datasummary/products API

Requests

Example
Query
https://mapdata.inrix.io/v1/datasummary/bycountry?accessToken={UAStoken}

Responses

200 Success
{
  "result": [
      {
          "isoCode": "DNK",
          "version": "20.1",
          "dataProduct": "MapRelease",
          "datasets": [
              {
                  "name": "TMCAdded",
                  "fileCount": 1,
                  "files": [
                      "DENMARK.csv"
                  ]
              },
              {
                  "name": "XDRemoved",
                  "fileCount": 1,
                  "files": [
                      "DENMARK.csv"
                  ]
              },
              {
                  "name": "OpenLRDictionaryFiles",
                  "fileCount": 2,
                  "files": [
                      "DNK_GeoId-58_OLRDictionary.gz",
                      "DNK_GeoId-57_OLRDictionary.gz"
                  ]
              }
          ]
      },
      {
          "isoCode": "CHE",
          "version": "20.1",
          "dataProduct": "MapRelease",
          "datasets": [
              {
                  "name": "TMCAdded",
                  "fileCount": 1,
                  "files": [
                      "SWITZERLAND.csv"
                  ]
              }
          ]
      },
  ],
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datasummary/bydataset

GET get the product summary organized by dataset for a given product version

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com
dataProduct Query String the name of the product from v1/datasummary/products API
version Query String the version of the product from v1/datasummary/products API

Requests

Example
Query
https://mapdata.inrix.io/v1/datasummary/bydataset?accessToken={UAStoken}

Responses

200 Success
{
  "result": [
      {
          "dataset": "XDAdded",
          "version": "20.1",
          "dataProduct": "MapRelease",
          "countries": [
              {
                  "isoCode": "DNK",
                  "fileCount": 1,
                  "files": [
                      "DENMARK.csv"
                  ]
              },
              {
                  "isoCode": "CHE",
                  "fileCount": 1,
                  "files": [
                      "SWITZERLAND.csv"
                  ]
              },
              {
                  "name": "OpenLRDictionaryFiles",
                  "fileCount": 2,
                  "files": [
                      "DNK_GeoId-58_OLRDictionary.gz",
                      "DNK_GeoId-57_OLRDictionary.gz"
                  ]
              }
          ]
      },
      {
          "dataset": "Shapefiles",
          "version": "20.1",
          "dataProduct": "MapRelease",
          "countries": [
              {
                  "isoCode": "DNK",
                  "fileCount": 1,
                  "files": [
                      "Denmark_shapefile.zip"
                  ]
              },
              {
                  "isoCode": "GBR",
                  "fileCount": 7,
                  "files": [
                      "UK_All_shapefile.zip",
                      "UK_Scotland_shapefile.zip",
                      "UK_Northern_Ireland_shapefile.zip",
                      "UK_Wales_shapefile.zip",
                      "UK_Jersey_shapefile.zip",
                      "UK_Guernsey_shapefile.zip",
                      "UK_England_shapefile.zip"
                  ]
              }                           
          ]
      }
  ],
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datadownload

POST submit a data download request based on the provided search criteria, such as dataset, version, countrycode, datafile id, geoid and statecode, etc.

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com
dataset Body String the dataset the data files belong to
version Body String the version of the product
geoids Body Array of the list of geoid to which the data file belongs
countrycode Body String the iso-3 code of the country the data files belong to
statecode Body String the 2-letter code of the state or province the data files belong to if it is available
datafileids Body Array of a list of the data file ids

Requests

Example Submit a download request to ask for all files given country AUT, version 20.1 and dataset OpenLRDictionaryFiles
Query
https://mapdata.inrix.io/v1/datadownload?accessToken={UAStoken}
Body
{
  "dataset": "OpenLRDictionaryFiles",
  "version": "20.1",
  "countrycode": "AUT"
}

Responses

200 Success
{
  "result": {
      "taskId": "b17523d5-6349-45cd-b039-d4266735b514",
      "status": "QUEUED"
  },
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datadownload/{taskid}

GET check the status of the submitted download task.

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com

Requests

Example
Query
https://mapdata.inrix.io/v1/datadownload/b17523d5-6349-45cd-b039-d4266735b514?accessToken={UAStoken}

Responses

200 Success
{
  "result": {
      "taskId": "b17523d5-6349-45cd-b039-d4266735b514",
      "downloadUrl":"a pre-signed url"
      "status": "FINISHED"
  },
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datafiles

GET query the detail of the data files based on the provided search criteria, such as dataset, version, countrycode, datafile id, geoid and statecode, etc.

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com
dataset Query String the dataset the data files belong to
version Query String the version of the product
geoid Query Array of the geoid the data file belongs to
countrycode Query String the iso-3 code of the country the data files belong to
statecode Query String the 2-letter code of the state or province the data files belong to if it is available

Requests

Example
Query
https://mapdata.inrix.io/v1/datafiles?dataset=OpenLRDictionaryFiles&version=20.1&countrycode=AUT&accessToken={UAStoken}

Responses

200 Success
{
  "result": [
      {
          "id": "46bccec6-e55d-4289-9d8e-d3f6fdeaa5dd",
          "fileName": "AUT_GeoId-22_OLRDictionary.gz",
          "countryCode": "AUT",
          "geoId": "22",
          "dataset": "OpenLRDictionaryFiles",
          "version": "20.1",
          "generatedTime": "2020-02-28T23:04:17",
          "fileSizeInKB": 4512.415,
          "dataProduct": "MapRelease"
      },
      {
          "id": "638b079e-44eb-4040-a424-569c9537d6ef",
          "fileName": "AUT_GeoId-24_OLRDictionary.gz",
          "countryCode": "AUT",
          "geoId": "24",
          "dataset": "OpenLRDictionaryFiles",
          "version": "20.1",
          "generatedTime": "2020-02-28T23:04:21",
          "fileSizeInKB": 2466.777,
          "dataProduct": "MapRelease"
      }
  ],
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datageographies/countries

GET query the available countries that are covered by any data file for the given product and version.

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com
version Query String the version of the product
dataproduct Query String the iso-3 code of the country the data files belong to

Requests

Example
Query
https://mapdata.inrix.io/v1/datageographies/countries?version=20.1&dataproduct=MapRelease&accessToken={UAStoken}

Responses

200 Success
{
  "result": [
      {
          "isoCode": "DNK",
          "name": "Denmark",
          "dataProduct": "MapRelease"
      },
      {
          "isoCode": "NZL",
          "name": "New Zealand",
          "dataProduct": "MapRelease"
      }
  ],
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}

/v1/datageographies/geoids

GET query the available geoids that are covered by any data file for the given product and version.

Parameters

  = required
Name Located In Type Description
Bearer Token Header String a valid UAS token from https://uas-api.inrix.com
accessToken Query String a valid UAS token from https://uas-api.inrix.com
version Query String the version of the product
dataproduct Query String the iso-3 code of the country the data files belong to

Requests

Example
Query
https://mapdata.inrix.io/v1/datageographies/geoids?version=20.1&dataproduct=MapRelease&accessToken={UAStoken}

Responses

200 Success
{
  "result": [
      {
          "isoCode": "DNK",
          "name": "Denmark",
          "geoIds": [
              {
                  "geoId": "57"
              },
              {
                  "geoId": "58"
              }
          ],
          "dataProduct": "MapRelease"
      },
      {
          "isoCode": "NZL",
          "name": "New Zealand",
          "geoIds": [
              {
                  "geoId": "1985"
              },
              {
                  "geoId": "1986"
              }
          ],
          "dataProduct": "MapRelease"
      }
  ],
  "copyright": "Copyright INRIX Inc.",
  "createdDate": "2020-08-09T07:51:38.62Z",
  "responseId": "42845c9d-5af2-4ae3-a5b8-171a87b50194"
}