API concepts

URL structure

REST stands for "REpresentational State Transfer". All data offered by the API is expressed as a simple URL:

https://api-qa.ihsmarkit.com/${namespace}/${entity}/latest?format=json

  • ${namespace} identifies the dataset (see Model concepts).
  • ${entity} identifies the entity within the dataset.
  • latest identifies the service.
  • The query string contains the request parameters, such as format, limit and after.

All parts of the URL are case sensitive. All requests for data use HTTPS GET.

No side effects

Each call to the REST API has no effect on subsequent calls. This makes the service scalable and keeps the API simple.

Note: An exception to this is obtaining an API key, which must then be used in all subsequent requests. Use your username and password to obtain an API key from https://api-qa.ihsmarkit.com/apikey. See Authentication.

Services

Depending on the dataset, the following services are available:

See service for the URLs supported by a specific dataset.

Data formats

The API returns data in JSON and XML, selected with the format parameter. For flat datasets (data that can be represented as a simple table of rows and columns), CSV is also available.

Pagination

Large results are returned in pages:

  1. Set limit to the maximum number of results per page (10,000 or less). Using limit is strongly recommended for larger requests.
  2. Request the envelope of the response with envelope=true. The envelope contains an after value.
  3. Request the next page by repeating the request with the after parameter set to that value.
  4. Continue requesting pages while the response provides an after continuation value; do not infer completion from the number of records returned. For the stream service, keep polling with the returned after value, including after empty responses.

Alternatively, nextUrl=true adds a next field to the envelope with the full URL of the next page.

REST API Console

You can explore the REST API interactively in the REST API Console by opening one of the following URLs in a browser:

UAT: https://api-uat.ihsmarkit.com

Production: https://api.ihsmarkit.com

Note: The UAT URL is for development and testing purposes, while the production URL is for tested production processes only. Both URLs have the same data.

The REST API Console is the REST API itself with responses in HTML format. Change the format parameter from html to json to get a data response suitable for application integration. The Console also includes a full OpenAPI specification of the REST API.

notificationsFor questions or assistance, please contact: data.delivery@spglobal.com